Release Notes
Announcements
Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used for the backend to skip a failed check item. Theoretically, to execute a migration task normally, any check step cannot be skipped, and the check must be passed. For products or links that support check item skipping, see Check Item Overview.
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: SkipCheckItem. |
| 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 | Yes | String | Data migration task ID |
| StepIds.N | Yes | Array of String | ID of the check step to be skipped, which is obtained in the StepInfo[i].StepId field returned by the DescribeMigrationCheckJob API, such as "OptimizeCheck". |
| ForeignKeyFlag | No | String | When the check fails due to foreign key dependency, you can use this field to specify whether to migrate the foreign key dependency. The foreign key dependency won’t be migrated when StepIds contains ConstraintCheck and the value of this field is shield, and will be migrated when StepIds contains ConstraintCheck and the value of this field is migrate. |
| Parameter Name | Type | Description |
|---|---|---|
| Message | String | Message prompted for skipping the check item 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 call this API to skip a failed check item when the check fails or to specify whether to migrate the foreign key dependency.
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SkipCheckItem
<Common request parameters>
{
"JobId": "dts-1ewjspuw",
"StepIds": [
"OptimizeCheck"
]
}{
"Response": {
"RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385",
"Message": "skip item successfully"
}
}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. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
フィードバック