Domain name for API request: cfs.tencentcloudapi.com.
This API is used to stop a migration task.
To use this API, submit a ticket for us to add you to the allowlist.
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: StopMigrationTask. |
Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
Region | No | String | Common Params. This parameter is not required for this API. |
TaskId | Yes | String | Migration task name |
Parameter Name | Type | Description |
---|---|---|
TaskId | String | Migration task ID |
Status | Integer | Migration status. Valid values: 0 (completed), 1 (in progress), and 2 (stopped). |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to stop a migration task.
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopMigrationTask
<Common request parameters>
{
"TaskId": "cfsmigrate-29de0e87"
}
{
"Response": {
"TaskId": "cfsmigrate-29de0e87",
"Status": 2,
"RequestId": "eff7c5d9-c8c4-401a-deda-2108d3cc8b76"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?