取消一個Pending(等待)或Executing(運行中)狀態的數據流動批式任務或流式任務。
接口說明
- 僅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支持數據流動任務。您可以在控制臺文件系統詳情頁面查看版本信息。
- 僅支持取消
Pending(等待)
和Executing(運行中)
狀態的數據流動任務。 - 取消數據流動任務一般耗時 5~10 分鐘,您可通過 DescribeDataFlowTasks 查詢任務執行狀態。
- 如果數據流動流式任務中有正在運行的流式子任務,則不支持取消流式任務。否則會返回 InvalidStatus.ResourceMismatch 報錯信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nas:CancelDataFlowTask | delete | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileSystemId | string | 是 | 文件系統 ID。
說明
國際站不支持 CPFS。
| cpfs-099394bd928c**** |
DataFlowId | string | 是 | 數據流動 ID。 | df-194433a5be31**** |
TaskId | string | 是 | 數據流動任務 ID。 | task-38aa8e890f45**** |
DryRun | boolean | 否 | 是否對此次創建請求執行預檢。 預檢操作會幫助您檢查參數有效性、校驗庫存等,并不會實際創建實例,也不會產生費用。 取值:
| false |
ClientToken | string | 否 | 保證請求冪等性,從您的客戶端生成一個參數值,確保不同的請求間該參數值唯一。 ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 說明
若用戶未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalCharacters | The parameter contains illegal characters. | 參數非法。 |
400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定FileSystemId參數。 |
400 | MissingDataFlowId | DataFlowId is mandatory for this action. | 未指定DataFlowId參數。 |
400 | MissingTaskId | TaskId is mandatory for this action. | 未指定TaskId參數。 |
403 | OperationDenied.ConflictOperation | The operation is denied due to a conflict with an ongoing operation. | 與當前的文件系統操作沖突導致無法創建數據流動。 |
403 | OperationDenied.DependencyViolation | The operation is denied due to dependancy violation. | 進行該操作的條件不滿足。 |
403 | OperationDenied.DataFlowNotSupported | The operation is not supported. | 該文件系統不支持數據流動。 |
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系統不存在。 |
404 | InvalidDataFlow.NotFound | The specified data flow does not exist. | 指定的數據流動不存在。 |
404 | InvalidTaskId.NotFound | The specified task ID does not exist. | 指定的數據流動TaskId不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |