调用CancelTask,取消数据迁移任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/instances/[InstanceId]/actions/cancel-task HTTP/1.1

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String es-cn-xxx

实例ID。

taskType String MigrateData

任务类型。

clientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符。

返回数据

名称 类型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

当前请求的Request ID。

Result Boolean true

正常返回只有true,其他情况则为异常。

示例

请求示例

POST /openapi/instances/[InstanceId]/actions/cancel-task HTTP/1.1
公共请求头
{
  "InstanceId": "es-cn-xxx"
  "taskType": "MigrateData"
}

正常返回示例

XML 格式

<Result>true</Result>
<RequestId>C82758DD-282F-4D48-934F-92170A33****</RequestId>

JSON 格式

{
	"Result":true,
	"RequestId":"C82758DD-282F-4D48-934F-92170A33****"
}

返回示例补充说明

以上返回的参数信息中,本文只保证包含返回参数列表中提到的参数信息,而未提到的参数信息仅供参考,程序中不能强制依赖获取这些参数。

错误码

访问错误中心查看更多错误码。