ApplyDataFlowAutoRefresh - Cloud Parallel File Storage

為指定資料流動配置自動更新。

介面說明

該介面僅適用於 CPFS 檔案系統。
僅 CPFS 2.2.0 及以上版本支援資料流動。您可以在控制台檔案系統詳情頁面查看版本資訊。
僅支援狀態為Running（正常）狀態的資料流動新增自動更新配置。
一個資料流動最多可以新增 5 個自動更新配置。
建立自動更新配置一般耗時 2～5 分鐘，您可以透過 DescribeDataFlows 查詢資料流動狀態。
自動更新依賴 EventBridge 收集來源端 OSS 儲存的物件修改事件。需要先開通 EventBridge 服務。

說明
CPFS 在 EventBridge 建立的事件匯流排、事件規則帶有Create for cpfs auto refresh的描述，事件匯流排、事件規則都不能修改和刪除，否則自動更新無法正常工作。
自動更新的作用對象是 prefix，由參數 RefreshPath 指定。在 CPFS 資料流動對 prefix 配置自動更新時，會在使用者側建立事件匯流排，並建立來源端 OSS Bucket 的 prefix 的事件規則。當來源端 OSS Bucket 的 prefix 內發生物件修改後，會在 EventBridge 中產生 OSS 事件，由 CPFS 資料流動處理。
配置自動更新（AutoRefresh）後，當來源端儲存資料發生變化時，變化的中繼資料會自動同步到 CPFS 檔案系統，變化的資料會在使用者存取檔案時按需載入，或者啟動資料流動任務載入資料。
自動更新間隔（AutoRefreshInterval）指 CPFS 每隔該時間間隔，檢查來源端 OSS Bucket 該 prefix 內是否存在資料更新，如果有資料更新則啟動自動更新任務。當 OSS 來源端的物件修改事件頻率超過 CPFS 資料流動處理能力時，自動更新任務會堆積，中繼資料更新會延遲，資料流動的狀態為 Misconfigured，您可以提升資料流動規格，或者降低 OSS 修改頻率來解決。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:ApplyDataFlowAutoRefresh

update

*DataFlow

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

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemId	string	是	檔案系統 ID。	cpfs-099394bd928c****
DataFlowId	string	是	資料流動 ID。	df-194433a5be31****
AutoRefreshs	array<object>	是	自動更新配置資訊集合。
	object	否
RefreshPath	string	是	自動更新目錄，CPFS 僅自動檢查該目錄下的來源端資料是否發生更新並自動匯入更新的資料。限制：長度為 2~1024 個字元。使用 UTF-8 編碼。必須以正斜線（/）開頭和結尾。說明該目錄必須是 CPFS 上的已有目錄，且必須位於開啟了資料流動的 Fileset 中。	/prefix1/prefix2/
AutoRefreshPolicy	string	否	自動更新策略，來源端資料更新以後，資料更新匯入到 CPFS 的策略。包括： None：來源端的資料更新不自動匯入 CPFS，使用者可透過資料流動任務匯入來源端的資料更新。 ImportChanged：來源端的資料更新自動匯入 CPFS。枚舉值： ImportChanged : 來源端的資料更新自動匯入 CPFS。 None : 來源端的資料更新不自動匯入 CPFS。	None
AutoRefreshInterval	integer	否	自動更新的間隔時間。每隔該時間間隔，CPFS 會檢查目錄內是否存在資料更新，如果有資料更新，啟動自動更新任務。單位為分鐘。取值範圍：10~525600。預設值：10。	10
DryRun	boolean	否	是否對此次建立請求執行預檢。預檢操作會幫助您檢查參數有效性、校驗庫存等，並不會實際建立執行個體，也不會產生費用。取值： true：傳送檢查請求，不會建立執行個體。檢查項包括是否填寫了必需參數、請求格式、業務限制和 NAS 庫存。如果檢查不通過，則傳回對應錯誤。如果檢查通過，則傳回 200 HttpCode，但 FileSystemId 為空。 false（預設）：傳送正常請求，通過檢查後直接建立執行個體。	false
ClientToken	string	否	保證請求冪等性，從您的用戶端產生一個參數值，確保不同的請求間該參數值唯一。 ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。說明若使用者未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-42665544****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	98696EF0-1607-4E9D-B01D-F20930B6****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingDataFlowId	DataFlowId is mandatory for this action.
403	OperationDenied.InvalidState	The operation is not permitted when the status is processing.
403	InvalidFileSystem.AlreadyExisted	The specified file system already exists.
403	OperationDenied.DependencyViolation	The operation is denied due to dependancy violation.
403	OperationDenied.NestedDir	The operation is denied due to nested directory.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.
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	InvalidRefreshPath.InvalidParameter	Refresh path is invalid.
404	InvalidRefreshPath.NotFound	Refresh path does not exist.
404	InvalidRefreshPolicy.InvalidParameter	Refresh policy is invalid.
404	InvalidRefreshInterval.OutOfBounds	Refresh interval is out of bounds.
404	InvalidRefreshPath.AlreadyExist	The refresh path already exists.
404	InvalidRefreshPath.TooManyPaths	The number of refresh paths exceeds the limit.

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

變更歷史

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