全部產品
Search
文件中心

Elasticsearch:CancelTask

更新時間:Jan 15, 2025

調用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

返回結果:

  • true:取消任務成功
  • false:取消任務失敗

樣本

請求樣本

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. 執行個體找不到,請核對執行個體狀態。

訪問錯誤中心查看更多錯誤碼。