調(diào)用CancelTask，取消數(shù)據(jù)遷移任務(wù)。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

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

請求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 es-cn-nif1q9o8r0008****

實(shí)例ID。
taskType String Query 是 MigrateData

任務(wù)類型，固定為MigrateData，表示數(shù)據(jù)遷移任務(wù)。
clientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保證請求的冪等性。由客戶端生成該參數(shù)值，要保證在不同請求間唯一，最大不超過64個(gè)ASCII字符。

返回?cái)?shù)據(jù)

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

請求ID。
Result Boolean true

返回結(jié)果：

  • true：取消任務(wù)成功
  • false：取消任務(wù)失敗

示例

請求示例

POST /openapi/instances/es-cn-nif1q9o8r0008****/actions/cancel-task?taskType=MigrateData HTTP/1.1

正常返回示例

JSON格式 

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

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 InstanceNotFound The instanceId provided does not exist. 實(shí)例找不到，請核對實(shí)例狀態(tài)。

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。