Help & DocumentationAPIsTencentDB for SQL ServerBackup and Restoration APIsDescribeMigrationDetail

DescribeMigrationDetail

Last updated: 2020-03-16 11:21:23

Contents：

1. API Description

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

This API is used to query migration task details.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: sqlserver.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeMigrationDetail.
Version Yes String Common parameter. The value used for this API: 2018-03-28.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
MigrateId Yes Integer Migration task ID

3. Output Parameters

Parameter Name Type Description
MigrateId Integer Migration task ID
MigrateName String Migration task name
AppId Integer User ID of migration task
Region String Migration task region
SourceType Integer Migration source type. 1: TencentDB for SQL Server, 2: CVM-based self-created SQL Server database; 3: SQL Server backup restoration, 4: SQL Server backup restoration (in COS mode)
CreateTime Timestamp Migration task creation time
StartTime Timestamp Migration task start time
EndTime Timestamp Migration task end time
Status Integer Migration task status (1: initializing, 4: migrating, 5: migration failed, 6: migration succeeded)
Progress Integer Migration task progress
MigrateType Integer Migration type (1: structure migration, 2: data migration, 3: incremental sync)
Source MigrateSource Migration source
Target MigrateTarget Migration target
MigrateDBSet Array of MigrateDB Database objects to be migrated. This parameter is not used for offline migration (SourceType=4 or SourceType=5)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Query the details of migration tasks

Input Example

https://sqlserver.tencentcloudapi.com/?Action=DescribeMigrationDetail
&MigrateId=2728
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
    "MigrateId": 2728,
    "MigrateName": "testing interface",
    "AppId": 1254065710,
    "Region": "ap-guangzhou",
    "SourceType": 5,
    "CreateTime": "2018-08-06 17:44:58",
    "StartTime": "0000-00- 00 00:00:00",
    "EndTime": "0000-00-00 00:00:00",
    "Status": 1,
    "Progress": 0,
    "MigrateType": 2,
    "Source": {
      "InstanceId": "",
      "CvmId": "",
      "VpcId": "",
      "SubnetId": "",
      "UserName": "",
      "Password": "",
      "Ip": "",
      "Port": 0,
      "url": [
        "http://gz-oncvm-1254065710.cosgz.myqcloud.com/test4_20180724021516.bak",
        "http://gz-oncvm-1254065710.cosgz.myqcloud.com/testdb.bak"
      ],
      "urlPassword": ""
    },
    "Target": {
      "InstanceId ": "mssql-dr5843bdy",
      "UserName": "",
      "Password": ""
    },
    "MigrateDBSet": []
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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
InternalError Internal error.
InternalError.DBError Database error
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InvalidParameter Invalid parameter.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
UnauthorizedOperation.PermissionDenied CAM authentication error.