CreateDataFlowTask - 建立資料流動任務 - Cloud Parallel File Storage

建立一個資料流動任務。

介面說明

CPFS 使用說明
- 僅 CPFS 2.2.0 及以上版本支援資料流動。您可以在控制台檔案系統詳情頁面查看版本資訊。
- 資料流動任務是非同步執行的，您可通過 DescribeDataFlowTasks 查詢任務執行狀態。任務的耗時取決於需要匯入、匯出的資料量。如果是大量資料，建議拆分成多個任務執行。
- 僅支援在 Running（正常）狀態的資料流動上建立資料流動任務。
- 手動執行資料流動任務時，該資料流動的自動資料更新任務會被中斷並等待。
- 當建立匯出任務時，需要確保 CPFS 待匯出的檔案絕對路徑總長度不能超過 1023 個字元。
CPFS 智算版使用說明
- 僅 CPFS 智算版 2.4.0 及以上版本支援資料流動。您可以在控制台檔案系統詳情頁面查看版本資訊。
- 資料流動任務是非同步執行的，您可通過 DescribeDataFlowTasks 查詢任務執行狀態。任務的耗時取決於需要匯入、匯出的資料量。如果是大量資料，建議拆分成多個任務執行。
- 僅支援在 Running（正常）狀態的資料流動上建立資料流動任務。
- 當建立匯出任務時，需要確保智算 CPFS 待匯出的檔案絕對路徑總長度不能超過 1023 個字元。
- CPFS 智算版支援批式任務和流式任務兩種任務類型。更多資訊，請參見任務類型介紹。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:CreateDataFlowTask

create

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemId	string	是	檔案系統 ID。 CPFS 通用版：必須以`cpfs-`開頭，例如 cpfs-125487**。 CPFS 智算版：必須以`bmcpfs-`開頭，例如 bmcpfs-0015**。	cpfs-099394bd928c****
DataFlowId	string	是	資料流動 ID。	df-194433a5be31****
SrcTaskId	string	否	當指定 SrcTaskId 時，需填寫資料流動任務 ID。系統將從目標資料流動任務中複製 TaskAction、DataType 和 EntryList 參數資訊，您無需單獨指定這些內容。說明不支援資料流動流式任務。	task-29ee8e890f45****
TaskAction	string	否	資料流動任務類型。取值： Import：從源端儲存將指定的資料匯入至 CPFS。 Export：將 CPFS 上指定的資料匯出至源端儲存。 StreamImport：從源端儲存將指定的資料大量匯入至 CPFS。 StreamExport：將 CPFS 上指定的資料大量匯出至源端儲存。 Evict：釋放 CPFS 上檔案的資料區塊，釋放後檔案在 CPFS 上只保留中繼資料，您仍能查詢該檔案，但檔案資料區塊已清除，不佔用 CPFS 上的儲存容量。當訪問該檔案資料時，將再從源端儲存按需載入。 Inventory：擷取 CPFS 上資料流動管理的檔案清單，可提供檔案在資料流動中的緩衝狀態。說明 CPFS 智算版僅支援 Import、Export、StreamImport 和 StreamExport。StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支援。	Import
DataType	string	否	資料流動任務操作的資料類型。取值： Metadata：檔案的中繼資料，包括檔案的 timestamp、 ownership、permission 等屬性資訊。選擇 Metadata，只會匯入檔案的中繼資料，使用者只能看到該檔案，但訪問該檔案資料時，資料從源端儲存按需載入。 Data：檔案的資料區塊。 MetaAndData：檔案的中繼資料和資料區塊。	Metadata
Directory	string	否	資料的來源目錄。限制：長度為 1~1023 個字元。使用 UTF-8 編碼。必須以正斜線（/）開頭和結尾。一次只能列舉一個目錄。當 TaskAction 為 Export 時，該目錄必須是 FileSystemPath 內的相對路徑。當 TaskAction 為 Import 時，該目錄必須是 SourceStoragePath 內的相對路徑。當 TaskAction 為 StreamExport 時，該目錄必須是 FileSystemPath 內的相對路徑。當 TaskAction 為 StreamImport 時，該目錄必須是 SourceStoragePath 內的相對路徑。說明 StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支援。	/path_in_cpfs/
EntryList	string	否	資料流動任務執行的檔案清單。限制：使用 UTF-8 編碼。檔案清單總長度小於 64KB。檔案清單採用 JSON 格式。單個檔案路徑長度為 1~1023 個字元，且必須以正斜線（/）開頭。當 TaskAction 為 Import 時，列表中每個元素代表一個 OSS Object 名稱。當 TaskAction 為 Export 時，列表中每個元素代表一個 CPFS 檔案路徑。	["/path_in_cpfs/file1", "/path_in_cpfs/file2"]
DryRun	boolean	否	是否對此次建立請求執行預檢。預檢操作會協助您檢查參數有效性、校正庫存等，並不會實際建立執行個體，也不會產生費用。取值： true：發送檢查請求，不會建立執行個體。檢查項包括是否填寫了必需參數、請求格式、業務限制和 NAS 庫存。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回 200 HttpCode，但 TaskId 為空白。 false（預設值）：發送正常請求，通過檢查後直接建立執行個體。	false
ClientToken	string	否	保證請求等冪性，從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。 ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-42665544****
ConflictPolicy	string	否	同名檔案衝突策略。取值： SKIP_THE_FILE：跳過同名檔案。 KEEP_LATEST：比較更新時間，保留最新版本。 OVERWRITE_EXISTING：強制覆蓋同名檔案。說明當檔案系統類型為 cpfs 智算版時，該參數必填。	SKIP_THE_FILE
DstDirectory	string	否	資料流動任務映射目標目錄。限制：必須以正斜線（/）開頭和結尾，不支援/../。長度為 1~1023 個字元。使用 UTF-8 編碼。一次只能列舉一個目錄。當 TaskAction 為 Export 時，該目錄必須是 SourceStoragePath 內的相對路徑。當 TaskAction 為 Import 時，該目錄必須是 FileSystemPath 內的相對路徑。當 TaskAction 為 StreamExport 時，該目錄必須是 SourceStoragePath 內的相對路徑。當 TaskAction 為 StreamImport 時，該目錄必須是 FileSystemPath 內的相對路徑。說明 StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支援。	/path_in_cpfs/
CreateDirIfNotExist	boolean	否	目錄不存在時，自動建立目錄。取值： true：自動建立目錄。 false（預設值）：不自動建立目錄。說明 TaskAction = Import 時，該參數生效。僅 CPFS 智算版 2.6.0 版本及以上版本支援。	false
Includes	string	否	過濾 directory 下目錄，傳輸過濾目錄內包含的檔案夾內容。說明僅在指定了 Directory 參數時，該參數生效。單個檔案夾路徑長度為 1~1023 個字元，且必須以正斜線（/）開頭與結尾，總長度限制不超過 3000 字元。僅 CPFS 智算版支援該功能。	["/test/","/test1/"]
TransferFileListPath	string	否	指定 oss 目錄，根據 oss 目錄中的 csv 檔案的內容同步資料。限制如下。必須以/開頭和結尾。區分大小寫。長度為 1~1023 個字元之間。使用 UTF-8 編碼。說明 TransferFileListPath，Directory 和 EntryList 為互斥參數，只能三者選一。該參數為 oss 下真實存在路徑。路徑下*.csv 檔案儲存體在 oss 中。 TransferFileListPath 僅支援 Import、Export 功能。 Import 的情境，會將 csv 檔案中指定的檔案或者目錄，從 oss 匯入到 cpfs。 Export 的情境，會將 csv 檔案中指定的檔案或者目錄，從 cpfs 匯出到 oss csv 檔案格式中應該包含 Name、Type 列，Name 為相對路徑，Type 支援 dir 和 file 兩種值；如果 type 為 dir，name 尾碼必須以/結尾。僅 CPFS 智算版支援該功能。	/test_oss_path/

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	2D69A58F-345C-4FDE-88E4-BF518948****
TaskId	string	資料流動任務 ID。	task-38aa8e890f45****

樣本

正常返回樣本

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 不存在。

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

變更歷史

更多資訊，參考變更詳情。