DescribeDataFlows - 查詢資料流動列表 - Cloud Parallel File Storage

查詢一個CPFS檔案系統的資料流動資訊。

介面說明

僅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支援資料流動。您可以在控制台檔案系統詳情頁面查看版本資訊。
篩選鍵（Filters）中，FsetIds、DataFlowlds、SourceStorage、ThroughputList、Status 需要做全字匹配，FileSystemPath、Description、SourceStoragePath 支援模糊比對。
支援組合查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:DescribeDataFlows

list

*DataFlow

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

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemId	string	是	檔案系統 ID。 CPFS：必須以`cpfs-`開頭，例如 cpfs-125487**。 CPFS 智算版：必須以`bmcpfs-`開頭，例如 bmcpfs-0015**。	cpfs-099394bd928c****
Filters	array<object>	否	查詢資料流動的篩選鍵。
	object	否
Key	string	否	篩選鍵的名稱。取值： DataFlowIds: 根據資料流動 ID 篩選。 FsetIds：根據 Fileset ID 篩選。 FileSystemPath：根據 Fileset 在 CPFS 檔案系統中的路徑篩選。 SourceStorage：根據源端儲存的訪問路徑篩選。 ThroughputList：根據資料流動的傳輸頻寬篩選。 Description：根據 Fileset 的描述篩選。 Status：根據資料流動狀態篩選。	FsetIds
Value	string	否	篩選鍵的值。該參數不支援萬用字元。 Key 取值為 DataFlowIds 時，Value 取值為資料流動 ID 或資料流動 ID 的一部分。可以是一個或一組 DataFlowId，資料流動 ID 最多可設定 10 個。例如，`df-194433a5be31**`或`df-194433a512a2,df-234533a5be31`。當 Key 取值為 FsetIds 時，Value 取值為 Fileset Id 或 Fileset ID 的部分。可以是一個或一組 Fileset ID，Fileset ID 最多可設定 10 個。例如，`fset-1902718ea0ae`或`fset-235718ea0ae,fset-5122718ea0ae**`。當 Key 取值為 FileSystemPath 時，Value 取值為 CPFS 檔案系統中的路徑或路徑的一部分。長度為 1~1024 個字元。當 Key 取值為 SourceStorage 時，Value 取值為源端儲存的訪問路徑。最長為 1024 個字元。當 Key 取值為 ThroughputList 時，Value 取值為資料流動的傳輸頻寬且支援組合查詢。當 Key 取值為 Description 時，Value 取值為資料流動的描述或描述的一部分。當 Key 取值為 Status 時，Value 取值為資料流動狀態。當 Key 取值為 SourceStoragePath 時，Value 取值為源端儲存訪問路徑或訪問路徑的一部分。最長 1024 個字元。	FsetIds
NextToken	string	否	當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	否	每次查詢結果的個數。取值範圍：10~100。預設值：20。	20

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
DataFlowInfo	object
DataFlow	array<object>	資料流動資訊合集。
	array<object>
FileSystemId	string	檔案系統 ID。	cpfs-099394bd928c****
DataFlowId	string	資料流動 ID。	df-194433a5be31****
FsetId	string	Fileset ID。說明僅支援 CPFS。	fset-1902718ea0ae****
Status	string	資料流動狀態。包括： Starting：資料流動正在建立或啟動中。 Running：資料流動已建立完成，正常運行中。 Updating：資料流動正在發生修改，例如提升傳輸頻寬、修改自動更新間隔時間。 Deleting：資料流動刪除中。 Stopping：資料流動停止中。 Stopped：資料流動已停止。 Misconfigured：資料流動配置異常，例如源端儲存無法訪問，傳輸頻寬過低無法完成自動更新。	Running
ErrorMessage	string	錯誤資訊。包括：無（預設值）：表示該資料流動狀態正常。 SourceStorageUnreachable：未查詢到源端儲存的訪問路徑。 ThroughputTooLow：資料流動頻寬過低。	SourceStorageUnreachable
SourceStorage	string	源端儲存的訪問路徑。格式：`<storage type>://[<account id>:]<path>`。其中： storage type：目前只支援 OSS。 account id：源端儲存所屬帳號的 UID。 path：OSS 的 bucket 名稱。僅支援小寫字母、數字和短劃線（-）且必須以小寫字母或者數字開頭和結尾。長度為 8~128 個英文字元。使用 UTF-8 編碼。不能以 http://和 https://開頭。說明 OSS Bucket 必須為在該地區已存在的 Bucket。僅 CPFS 智算版 2.6.0 及以上版本支援 account id 參數。	oss://178321033379****:bucket-01
SourceSecurityType	string	源端儲存的安全保護類型，如果源端儲存必須通過安全保護訪問，請指定源端儲存的安全保護類型。取值：無（預設值）：表示源端儲存不需要通過安全保護方式訪問。 SSL：通過 SSL 憑證保護訪問。	SSL
Throughput	integer	資料流動的傳輸頻寬上限，單位：MB/s 。取值： 600 1200 1500 說明資料流動的傳輸頻寬必須小於檔案系統的 IO 頻寬。僅支援 CPFS。	600
Description	string	資料流動的描述。限制：長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以`http://`和`https://`開頭。可以包含數字、半形冒號（:）、底線（_）或者短劃線（-）。	Bucket01資料流動
CreateTime	string	Fileset 的建立時間。執行 ISO8601 標準表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。說明僅支援 CPFS。	2021-09-30T10:08:08Z
UpdateTime	string	Fileset 的最近一次更新時間。執行 ISO8601 標準表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。說明僅支援 CPFS。	2021-09-30T10:08:08Z
AutoRefresh	object
AutoRefresh	array<object>	自動更新策略資訊集合。說明僅支援 CPFS。
	object
RefreshPath	string	自動更新目錄，CPFS 僅自動檢查該目錄下的源端資料是否發生更新並自動匯入更新的資料。限制：長度為 2~1024 個字元。使用 UTF-8 編碼。必須以/開頭和結尾。說明該目錄必須是 CPFS 上的已有目錄，且必須位於開啟了資料流動的 Fileset 中。	/prefix1/prefix2/
FileSystemPath	string	Fileset 在 CPFS 檔案系統中的路徑。限制：長度為 2~1024 個英文或中文字元。使用 UTF-8 編碼。必須以/開頭和結尾。該目錄必須是 CPFS 上的 Fileset 目錄。說明僅支援 CPFS。	/a/b/c/
FsetDescription	string	自動更新的描述。說明僅支援 CPFS。	自動更新01
AutoRefreshInterval	integer	自動更新間隔時間。每隔該時間間隔，CPFS 會檢查目錄內是否存在資料更新，如果有資料更新，啟動自動更新任務。單位：分鐘。取值範圍：5~526600。預設值：10。說明僅支援 CPFS。	10
AutoRefreshPolicy	string	自動更新策略，源端資料更新以後，資料更新匯入到 CPFS 的策略。包括： None：源端的資料更新不自動匯入 CPFS，使用者可通過資料流動任務匯入源端的資料更新。 ImportChanged：源端的資料更新自動匯入 CPFS。說明僅支援 CPFS。	None
SourceStoragePath	string	源端儲存 Bucket 內的訪問路徑。說明僅支援 CPFS 智算版。	/prefix/

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "DataFlowInfo": {
    "DataFlow": [
      {
        "FileSystemId": "cpfs-099394bd928c****",
        "DataFlowId": "df-194433a5be31****",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "Running",
        "ErrorMessage": "SourceStorageUnreachable",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "SourceSecurityType": "SSL",
        "Throughput": 600,
        "Description": "Bucket01資料流動",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "AutoRefresh": {
          "AutoRefresh": [
            {
              "RefreshPath": "/prefix1/prefix2/"
            }
          ]
        },
        "FileSystemPath": "/a/b/c/",
        "FsetDescription": "自動更新01",
        "AutoRefreshInterval": 10,
        "AutoRefreshPolicy": "None",
        "SourceStoragePath": "/prefix/\n"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalCharacters	The parameter contains illegal characters.	參數非法。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId參數。
400	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.	當前介面不支援該版本檔案系統。
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	該檔案系統不支援資料流動。
404	InvalidFilterValue	The specified parameter Filter.1.Value is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的檔案系統不存在。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定的Filter.N.Key參數非法。
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定的MaxResults非法。
404	InvalidParameter.InvalidNextToken	The specified NextToken is invalid.	指定的NextToken非法。

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

變更歷史

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