DescribeFilesets - 查询文件集列表_文件存储 CPFS(CPFS)-阿里云帮助中心

查询已创建的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**。说明国际站不支持 CPFS。	bmcpfs-290w65p03ok64ya****
Filters	array<object>	否	待查询 Fileset 的筛选键信息。
	object	否
Key	string	否	筛选键的名称。取值： FsetIds：根据 Fileset ID 筛选。 FileSystemPath：根据 Fileset 在 CPFS 文件系统中的路径筛选。 Description：根据 Fileset 的描述筛选。 QuotaExists: 根据 Quota 是否存在进行筛选。说明仅 CPFS 智算版 2.7.0 及以上版本支持 QuotaExists 参数进行筛选。	FsetIds
Value	string	否	筛选键的值。该参数不支持通配符。当 Key 取值为 FsetIds 时，Value 取值为 Fileset ID 或 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	long	否	每次查询结果的个数。取值范围：10~100。默认值：20。	20

返回参数

名称	类型	描述	示例值
	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**。说明国际站不支持 CPFS。	bmcpfs-290w65p03ok64ya****
Entries	array<object>	Fileset 信息集合。
Entrie	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	long	文件数量使用量。说明仅 CPFS 智算版 2.7.0 及以上版本支持此参数。	1024
SpaceUsage	long	容量使用量。单位：Byte。说明仅 CPFS 智算版 2.7.0 及以上版本支持此参数。	1024
Quota	object	配额信息。说明仅 CPFS 智算版 2.7.0 及以上版本支持此参数。
SizeLimit	long	配额容量限制。单位：Byte。最小值：10,737,418,240（10 GiB）。最大值：1,073,741,824,000（1024000 GiB）。步长：1,073,741,824（1 GiB）。	10737418240
FileCountLimit	long	配额文件数量限制。取值范围：最小值：10,000。最大值：10,000,000,000。	10000
FileSystemId	string	文件系统 ID。 CPFS：必须以`cpfs-`开头，例如 cpfs-099394bd928c**。 CPFS 智算版：必须以`bmcpfs-`开头，例如 bmcpfs-290w65p03ok64ya**。说明国际站不支持 CPFS。	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.	未指定FileSystemId参数。
403	OperationDenied.FilesetNotSupported	The operation is not supported.	该文件系统不支持Fileset。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的文件系统不存在。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定的Filter.N.Key参数非法。
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	指定的Filter.N.Value参数非法。
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.	-
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定的MaxResults非法。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-31	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情