DescribeFilesets - Cloud Parallel File Storage

查詢已建立的 Fileset 列表資訊。

介面說明

僅 CPFS 2.2.0 和 CPFS 智算版 2.7.0 及以上版本支援 Fileset。您可以在控制台檔案系統詳情頁面查看版本資訊。
篩選鍵（Filters）中，FsetIds 需要做全字匹配，FileSystemPath、Description 支援模糊匹配。
支援組合查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:DescribeFilesets

list

*FileSystem

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

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemId	string	是	檔案系統 ID。 CPFS：必須以`cpfs-`開頭，例如 cpfs-099394bd928c**。 CPFS 智算版：必須以`bmcpfs-`開頭，例如 bmcpfs-290w65p03ok64ya**。	bmcpfs-290w65p03ok64ya****
Filters	array<object>	否	待查詢 Fileset 的篩選鍵資訊。
	object	否
Key	string	否	篩選鍵的名稱。取值： FsetIds：根據 Fileset ID 篩選。 FileSystemPath：根據 Fileset 在 CPFS 檔案系統中的路徑篩選。 Description：根據 Fileset 的描述篩選。 QuotaExists：根據 Quota 是否存在進行篩選。說明僅 CPFS 智算版 2.7.0 及以上版本支援 QuotaExists 參數進行篩選。枚舉值： FileSystemPath : 根据 Fileset 在 CPFS 文件系统中的路径筛选 Description : 根据 Fileset 的描述筛选 FsetIds : 根据 Fileset ID 筛选 QuotaExists : 根据 Quota 是否存在进行筛选	FsetIds
Value	string	否	篩選鍵的值。該參數不支援萬用字元。當 Key 取值為 FsetIds 時，Value 取值為 Fileset ID。可以是一個或一組 Fileset ID，Fileset ID 最多可設定 10 個，多個值使用英文逗號分隔。例如，`fset-1902718ea0ae**`或`fset-1902718ea0ae,fset-3212718ea0ae**`。當 Key 取值為 FileSystemPath 時，Value 取值為 Fileset 在 CPFS 檔案系統中的路徑或路徑的一部分。長度為 2~1024 個英文或中文字元。請您使用 UTF-8 編碼。當 Key 取值為 Description 時，Value 取值為 Fileset 的描述或描述的一部分。當 Key 取值為 QuotaExists 時，Value 取值為 true 或 false，不填寫則傳回所有的 Fileset。	fset-1902718ea0ae****
NextToken	string	否	當請求的傳回結果被截斷時，您可以使用 NextToken 再次發起請求，取得從目前截斷位置之後的內容。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	否	每次查詢結果的個數。取值範圍：10~100。預設值：20。	20
OrderByField	string	否	排序欄位。 FileCountLimit：配額檔案數量限制。 SizeLimit：配額容量限制。 FileCountUsage：檔案數量使用量。 SpaceUsage：容量使用量。枚舉值： SpaceUsage : 容量使用量。 FileCountLimit : 配額檔案數量限制。 SizeLimit : 配額容量限制。 FileCountUsage : 檔案數量使用量。	FileCountLimit
SortOrder	string	否	排序方式。 asc（預設值）：升序，指定排序按照從小到大的順序進行。 desc：降序，指定排序按照從大到小的順序進行。說明當填寫 OrderByField 參數後，此欄位生效。枚舉值： asc : 升序。 desc : 降序。	asc

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	當請求的傳回結果被截斷時，您可以使用 NextToken 再次發起請求，取得從目前截斷位置之後的內容。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
FileSystemId `deprecated`	string	檔案系統 ID。 CPFS：必須以`cpfs-`開頭，例如 cpfs-099394bd928c**。 CPFS 智算版：必須以`bmcpfs-`開頭，例如 bmcpfs-290w65p03ok64ya**。	bmcpfs-290w65p03ok64ya****
Entries	object
Entrie	array<object>	Fileset 資訊集合。
	array<object>	檔案資訊集合。
Description	string	Fileset 的描述。	test
FileSystemPath	string	Fileset 的路徑。	pathtoroot/fset
FsetId	string	Fileset ID。	fset-1902718ea0ae****
Status	string	Fileset 的狀態。包括： CREATING：正在建立 Fileset。 CREATED：Fileset 已建立完成，正常運行中。 RELEASING：Fileset 正在釋放中。 RELEASED：Fileset 已刪除。	CREATED
CreateTime	string	Fileset 的建立時間。執行 ISO8601 標準表示，返回格式：`yyyy-MM-ddTHH:mm:ssZ`。	2021-09-30T10:08:08Z
UpdateTime	string	Fileset 的最近一次更新時間。執行 ISO8601 標準表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。	2021-09-30T10:08:08Z
DeletionProtection	boolean	執行個體釋放保護屬性，指定是否支援通過控制台或 API（ DeleteFileset ）釋放執行個體。 true：開啟執行個體釋放保護。 false：關閉執行個體釋放保護。說明該屬性只能限制手動釋放操作，對系統釋放操作不生效。	true
FileCountUsage	integer	檔案數量使用量。說明僅 CPFS 智算版 2.7.0 及以上版本支援此參數。	1024
SpaceUsage	integer	容量使用量。單位：Byte。說明僅 CPFS 智算版 2.7.0 及以上版本支援此參數。	1024
Quota	object	配額資訊。說明僅 CPFS 智算版 2.7.0 及以上版本支援此參數。
SizeLimit	integer	配額容量限制。單位：Byte。最小值：10,737,418,240（10 GiB）。步長：1,073,741,824（1 GiB）。	10737418240
FileCountLimit	integer	配額檔案數量限制。取值範圍：最小值：10,000。最大值：10,000,000,000。	10000
FileSystemId	string	檔案系統 ID。 CPFS：必須以`cpfs-`開頭，例如 cpfs-099394bd928c**。 CPFS 智算版：必須以`bmcpfs-`開頭，例如 bmcpfs-290w65p03ok64ya**。	bmcpfs-290w65p03ok64ya****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "FileSystemId": "bmcpfs-290w65p03ok64ya****",
  "Entries": {
    "Entrie": [
      {
        "Description": "test",
        "FileSystemPath": "pathtoroot/fset",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "CREATED",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "DeletionProtection": true,
        "FileCountUsage": 1024,
        "SpaceUsage": 1024,
        "Quota": {
          "SizeLimit": 10737418240,
          "FileCountLimit": 10000
        },
        "FileSystemId": "bmcpfs-290w65p03ok64ya****"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidParameter.SortOrder	Invalid sort order.
400	InvalidParameter.SortOrderField	Invalid sort order field.
403	OperationDenied.FilesetNotSupported	The operation is not supported.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.
404	InvalidFilterValue	The specified Filter.N.Value is invalid.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.

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

變更歷史

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