调用CancelTask,取消数据迁移任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /openapi/instances/[InstanceId]/actions/cancel-task HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-nif1q9o8r0008**** |
实例ID。 |
taskType | String | Query | 是 | MigrateData |
任务类型,固定为MigrateData,表示数据迁移任务。 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC**** |
请求ID。 |
Result | Boolean | true |
返回结果:
|
示例
请求示例
POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/cancel-task?taskType=MigrateData HTTP/1.1
正常返回示例
JSON
格式
{
"Result": true,
"RequestId": "C82758DD-282F-4D48-934F-92170A33****"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InstanceNotFound | The instanceId provided does not exist. | 实例找不到,请核对实例状态。 |
访问错误中心查看更多错误码。