QueryMigrationCheckProcess

Last updated: 2025-10-28 22:49:28

QueryMigrationCheckProcess

Last updated: 2025-10-28 22:49:28

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the progress of the migration verification task, inquiry of migration check task progress, applicable to the migration method where the migration source type is TencentDB for SQL Server.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: QueryMigrationCheckProcess.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
MigrateId	Yes	Integer	Migration task ID.

3. Output Parameters

Parameter Name	Type	Description
TotalStep	Integer	Total number of steps.
CurrentStep	Integer	Current step number, starting from 1.
StepDetails	Array of StepDetail	Details of all steps.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Migration Verification Task Progress

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=QueryMigrationCheckProcess
&MigrateId=1066
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "TotalStep": 8,
        "CurrentStep": 8,
        "StepDetails": [
            {
                "Name": "Source database connectivity check",
                "Status": 0,
                "Msg": "Check whether the data transfer server can be connected to the source database."
            },
            {
                "Name": "Target database connectivity check",
                "Status": 0,
                "Msg": "Check whether the data transfer server can be connected to the target database."
            },
            {
                "Name": "Hard disk space check",
                "Status": 0,
                "Msg": "Check whether the hard disk space of the target server is sufficient."
            },
            {
                "Name": "Character set check",
                "Status": 0,
                "Msg": "Check whether the character sets are consistent."
            },
            {
                "Name": "Database version check",
                "Status": 0,
                "Msg": "Check whether the database version numbers are consistent."
            },
            {
                "Name": "User permissions check",
                "Status": 0,
                "Msg": "Check whether the permissions for the target instance exist."
            },
            {
                "Name": "Source database existence check",
                "Status": 0,
                "Msg": "Check whether the source database exists."
            },
            {
                "Name": "Target database existence check",
                "Status": 0,
                "Msg": "Check whether the target database exists."
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DBError	Database error.
InternalError	Internal error.
InternalError.DBConnectError	Database connection error.
InternalError.DBError	Database error
InternalError.GcsError	GCS API error.
InternalError.SystemError	System error.
InternalError.UnknownError	Unknown error.
InvalidParameter	Invalid parameter.
InvalidParameter.InputIllegal	Input error.
ResourceNotFound.DBNotFound	The database does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud