通過此接口取消指定異步任務。
接口說明
僅狀態為 Pending 或 Running 的 Task 可以被取消。
調用 CancelTask 可以取消 Cloud Control API 執行的任務,但是不會終止已經在下游云產品服務上啟動的任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cloudcontrol:CancelTask | update |
|
| 無 |
請求語法
PUT /api/v1/tasks/{taskId}/operation/cancel HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
taskId | string | 是 | 任務 id。 | task-433aead756057fff2913e7ce5**** |
返回參數
示例
正常返回示例
JSON
格式
{
"requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-04 | API 內部配置變更,不影響調用 | 查看變更詳情 |