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

查询已创建的Fileset列表信息。

接口说明

该接口仅适用于中国站 CPFS 文件系统。
仅 CPFS 2.2.0 及以上版本支持 Fileset。您可以在控制台文件系统详情页面查看版本信息。
筛选键（Filters）中，FsetIds 需要做全字匹配，FileSystemPath、Description 支持模糊匹配。
支持组合查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
FileSystemId	string	是	文件系统 ID。	cpfs-099394bd928c****
Filters	array<object>	否	待查询 Fileset 的筛选键信息。
	object	否
Key	string	否	筛选键的名称。取值： FsetIds：根据 Fileset ID 筛选。 FileSystemPath：根据 Fileset 在 CPFS 文件系统中的路径筛选。 Description：根据 Fileset 的描述筛选。	FsetIds
Value	string	否	筛选键的值。该参数不支持通配符。当 Key 取值为 FsetIds 时，Value 取值为 Fileset ID 或 Fileset ID 的部分。可以是一个或一组 Fileset ID，Fileset ID 最多可设置 10 个。例如，`fset-12345678`或`fset-12345678,fset-12345679`。当 Key 取值为 FileSystemPath 时，Value 取值为 Fileset 在 CPFS 文件系统中的路径或路径的一部分。长度为 2~1024 个英文或中文字符。请您使用 UTF-8 编码。当 Key 取值为 Description 时，Value 取值为 Fileset 的描述或描述的一部分。	fset-12345678,fset-12345679
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	string	文件系统 ID。	cpfs-099394bd928c****
Entries	array<object>	Fileset 信息集合。
	object
Description	string	Fileset 的描述。	公共事务目录。
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

示例

正常返回示例

JSON格式

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "FileSystemId": "cpfs-099394bd928c****",
  "Entries": {
    "Entrie": [
      {
        "Description": "公共事务目录。",
        "FileSystemPath": "pathtoroot/fset",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "CREATED",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "DeletionProtection": true
      }
    ]
  }
}

错误码

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-05-31	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情