創建一個數據流動任務。
接口說明
-
僅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支持數據流動。您可以在控制臺文件系統詳情頁面查看版本信息。
-
僅支持在 Running(正常)狀態的數據流動上創建數據流動任務。
-
數據流動任務是異步執行的,您可通過 DescribeDataFlowTasks 查詢任務執行狀態。任務的耗時取決于需要導入、導出的數據量。如果是大量數據,建議拆分成多個任務執行。
-
手動執行數據流動任務時,該數據流動的自動數據更新任務會被中斷并等待。
-
當創建導出任務時,需要確保 CPFS 和智算 CPFS 待導出的文件絕對路徑總長度不能超過 1023 個字符。
-
CPFS 智算版支持批式任務和流式任務兩種任務類型。更多信息,請參見任務類型介紹。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nas:CreateDataFlowTask | create | *DataFlow acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileSystemId | string | 是 | 文件系統 ID。
說明
國際站不支持 CPFS。
| cpfs-099394bd928c**** |
DataFlowId | string | 是 | 數據流動 ID。 | df-194433a5be31**** |
SrcTaskId | string | 否 | 當指定 SrcTaskId 時,需填寫數據流動任務 ID。系統將從目標數據流動任務中復制 TaskAction、DataType 和 EntryList 參數信息,您無需單獨指定這些內容。 說明
不支持數據流動流式任務。
| task-29ee8e890f45**** |
TaskAction | string | 否 | 數據流動任務類型。 取值:
說明
目前 CPFS 智算版只支持 Import、Export、StreamImport 和 StreamExport。StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支持。
| Import |
DataType | string | 否 | 數據流動任務操作的數據類型。 取值:
| Metadata |
Directory | string | 否 | 數據的源目錄。 限制:
說明
StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支持。
| /path_in_cpfs/ |
EntryList | string | 否 | 數據流動任務執行的文件列表。 限制:
| ["/path_in_cpfs/file1", "/path_in_cpfs/file2"] |
DryRun | boolean | 否 | 是否對此次創建請求執行預檢。 預檢操作會幫助您檢查參數有效性、校驗庫存等,并不會實際創建實例,也不會產生費用。 取值:
| false |
ClientToken | string | 否 | 保證請求冪等性,從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。 ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
ConflictPolicy | string | 否 | 同名文件沖突策略。 取值:
說明
當文件系統類型為 cpfs 智算版時,該參數必填。
| SKIP_THE_FILE |
DstDirectory | string | 否 | 數據流動任務映射目標目錄。 限制:
說明
StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支持。
| /path_in_cpfs/ |
CreateDirIfNotExist | boolean | 否 | 目錄不存在時,自動創建目錄。 取值:
說明
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
"TaskId": "task-38aa8e890f45****"
}
錯誤碼
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 | InvalidFilesystemVersion.NotSupport | This Api does not support this fileSystem version. | 當前接口不支持該版本文件系統。 |
403 | OperationDenied.InvalidState | The operation is not permitted when the status is processing. | 狀態處理中不允許此操作。 |
403 | OperationDenied.DependencyViolation | The operation is denied due to dependancy violation. | 進行該操作的條件不滿足。 |
403 | OperationDenied.DataFlowNotSupported | The operation is not supported. | 該文件系統不支持數據流動。 |
404 | InvalidParameter.InvalidFormat | The EntryList format is invalid. | 指定的EntryList的格式不符合要求。 |
404 | InvalidParameter.SizeTooLarge | The specified EntryList size exceeds 64 KB. | 指定的EntryList的大小超過64 KB。 |
404 | InvalidDataFlow.NotFound | The specified data flow does not exist. | 指定的數據流動不存在。 |
404 | InvalidTaskAction.NotSupported | The task action is not supported. | 指定的任務類型不支持。 |
404 | InvalidTaskAction.PermissionDenied | The task action is not allowed. | 指定的任務類型不允許,例如復制系統。 |
404 | InvalidSrcTaskId.NotFound | The SrcTaskId is not found. | 指定的 SrcTaskId 不存在。 |
404 | InvalidDataType.NotSupported | The data type is not supported. | 指定的數據類型不支持。 |
404 | InvalidSrcTaskId.TaskIdInvalid | Source task ID is invalid. | 指定的需要復制的任務 ID 非法 |
404 | InvalidSrcTaskId.TaskIdNotFound | Source task ID is not found. | 指定的需要復制的任務 ID 不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-09 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-02-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |