Release Notes
Announcements
Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used to query the result of the sync check task and check the required parameters and peripheral configurations.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeCheckSyncJobResult. |
| Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| JobId | No | String | Sync task instance ID in the format of sync-werwfs23, which is used to identify a sync task. This parameter is required. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Execution status of the check task. Valid values: notStarted, running, failed, success.Note: This field may return null, indicating that no valid values can be obtained. |
| StepCount | Integer | Total number of steps Note: This field may return null, indicating that no valid values can be obtained. |
| StepCur | Integer | The current step Note: This field may return null, indicating that no valid values can be obtained. |
| Progress | Integer | Overall progress. Value range: 0-100. Note: This field may return null, indicating that no valid values can be obtained. |
| StepInfos | Array of StepInfo | Step information Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
This example shows you how to query the sync task check result since the sync check is initiated asynchronously.
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCheckSyncJobResult
<Common request parameters>
{
"JobId": "sync-bllmn8x9"
}{
"Response": {
"Progress": 100,
"RequestId": "948377d0-b8a2-11ed-b8ff-e9277ed2f336",
"Status": "success",
"StepCount": 14,
"StepCur": 14,
"StepInfos": [
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "ConnectDBCheck",
"StepName": "Database connection check",
"StepNo": 1,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "OptimizeCheck",
"StepName": "Peripheral check",
"StepNo": 2,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "VersionCheck",
"StepName": "Version check",
"StepNo": 3,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "SrcPrivilegeCheck",
"StepName": "Source instance permission check",
"StepNo": 4,
"Warnings": [
{
"Code": "Warning: SrcPrivilegeCheck",
"HelpDoc": "",
"Message": "The permissions you grant are as follows: GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE ON *.* TO 'root'@'%' WITH GRANT OPTION. The permission scope of the source instance account is larger than required. DTS won’t use permissions that are not required. You need to grant as few permissions as possible. For more information, visit https://www.tencentcloud.com/zh/document/product/571/42555",
"SkipInfo": "",
"Solution": ""
}
]
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "SimpleParamCheck",
"StepName": "Partial instance parameter check",
"StepNo": 5,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "DstPrivilegeCheck",
"StepName": "Target instance permission check",
"StepNo": 6,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "DstEmptyCheck",
"StepName": "Target instance content conflict check",
"StepNo": 7,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "DstSpaceCheck",
"StepName": "Target instance space check",
"StepNo": 8,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "BinlogParamCheck",
"StepName": "Binlog parameter check",
"StepNo": 9,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "ConstraintCheck",
"StepName": "Foreign key dependency check",
"StepNo": 10,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "ConstraintRefCheck",
"StepName": "Partial database/table foreign key dependency check",
"StepNo": 11,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "ViewCheck",
"StepName": "View check",
"StepNo": 12,
"Warnings": []
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "WarningParamCheck",
"StepName": "Warning item check",
"StepNo": 13,
"Warnings": [
{
"Code": "Warn: WarningParamCheck",
"HelpDoc": "",
"Message": "For tables without a primary key or non-null unique key, there may be a risk of duplicate data. For more information, visit https://www.tencentcloud.com/document/product/571/42562",
"SkipInfo": "",
"Solution": ""
},
{
"Code": "Warn: WarningParamCheck",
"HelpDoc": "",
"Message": "On the source instance, the value of `sql_mode` is 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION'; on the target instance, the value of `sql_mode` is 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION'。It is recommended that the values are set to the same.",
"SkipInfo": "",
"Solution": ""
}
]
},
{
"Errors": [],
"Progress": 100,
"StartTime": "",
"Status": "finished",
"StepId": "AdvancedStoreObjectCheck",
"StepName": "Advanced object check",
"StepNo": 14,
"Warnings": []
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| ResourceNotFound.BizResourceNotFoundError | The resource was not found. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
フィードバック