Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used to stop a data migration task.
After calling this API, you can call the DescribeMigrationJobs API to query the latest task status.
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: StopMigrateJob. |
| 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 |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopMigrateJob
<Common request parameters>
{
"JobId": "dts-j7bt5sid"
}{
"Response": {
"RequestId": "22f6b9ca-e94d-4a4d-b48f-a5133e791374"
}
}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 |
|---|---|
| AuthFailure.AuthFailureError | Authentication failed. |
| DryRunOperation.DryRunOperationError | DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful. |
| FailedOperation.FailedOperationError | The operation failed. |
| FailedOperation.NotAllowOperation | This operation is prohibited. |
| FailedOperation.StatusInConflict | This operation cannot be performed due to a status conflict. |
| InternalError.DatabaseError | Failed to access the database on the DTS platform. |
| InternalError.DuplicateJob | Migration tasks are in conflict. |
| InternalError.InternalErrorError | An internal error occurred. |
| InternalError.ProtocolError | A communication protocol error occurred. |
| InternalError.UnknownError | An unknown internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidParameterError | The parameter is invalid. |
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| LimitExceeded.LimitExceededError | The quantity exceeds the limit. |
| OperationDenied.JobOperationDeniedError | The task operation failed. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| RequestLimitExceeded.RequestLimitExceededError | The number of requests exceeds the limit. |
| ResourceInUse.ResourceInUseError | The resource is being used. |
| ResourceInsufficient.ResourceInsufficientError | The resources are insufficient. |
| ResourceNotFound.JobNotExist | The migration task does not exist. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
| ResourceUnavailable.ResourceUnavailableError | The resource is unavailable. |
| ResourcesSoldOut.ResourcesSoldOutError | The resources have been sold out. |
| UnauthorizedOperation.NotEnoughPrivileges | Authentication failed as there were no required permissions. |
| UnauthorizedOperation.UnauthorizedOperationError | The operation is unauthorized. |
| UnknownParameter.UnknownParameterError | The parameter is unknown. |
| UnsupportedOperation.UnsupportedOperationError | The operation is not supported. |
피드백