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

接口说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFilesets

接口名称。固定取值:DescribeFilesets。

FileSystemId String cpfs-099394bd928c****

文件系统ID。

Filters.N.Key String FsetIds

筛选键的名称。取值:

  • FsetIds:根据Fileset ID筛选。
  • FileSystemPath:根据Fileset在CPFS文件系统中的路径筛选。
  • Description:根据Fileset的描述筛选。
Filters.N.Value String fset-12345678,fset-12345679

筛选键的值。该参数不支持通配符。

  • 当Key取值为FsetIds时,Value取值为Fileset ID或Fileset ID的部分。可以是一个或一组Fileset ID,Fileset ID最多可设置10个。例如,fset-12345678fset-12345678,fset-12345679
  • 当Key取值为FileSystemPath时,Value取值为Fileset在CPFS文件系统中的路径或路径的一部分。长度为2~1024个英文或中文字符。请您使用UTF-8编码。
  • 当Key取值为Description时,Value取值为Fileset的描述或描述的一部分。
NextToken String TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

MaxResults Long 20

每次查询结果的个数。

取值范围:10~100。默认值:20。

返回数据

名称 类型 示例值 描述
RequestId String 2D69A58F-345C-4FDE-88E4-BF518948****

请求ID。

NextToken String TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

FileSystemId String cpfs-099394bd928c****

文件系统ID。

Entries Array of Entrie

Fileset信息集合。

Entrie
Description String 公共事务目录。

Fileset的描述。

FileSystemPath String pathtoroot/fset

Fileset的路径。

FsetId String fset-1902718ea0ae****

Fileset ID。

Status String CREATED

Fileset状态。包括:

  • CREATING:正在创建Fileset。
  • CREATED:Fileset已创建完成,正常运行中。
  • RELEASING:Fileset正在释放中。
  • RELEASED:Fileset已删除。
CreateTime String 2021-09-30T10:08:08Z

Fileset的创建时间。

执行ISO8601标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

UpdateTime String 2021-09-30T10:08:08Z

Fileset的最近一次更新时间。

执行ISO8601标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFilesets
&FileSystemId=cpfs-099394bd928c****
&Filters=[{"Key":"FsetIds","Value":"fset-12345678,fset-12345679"}]
&NextToken=TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
&MaxResults=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFilesetsResponse>
    <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>
    <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>
    <FileSystemId>cpfs-099394bd928c****</FileSystemId>
    <Entries>
        <Description>公共事务目录。</Description>
        <FileSystemPath>pathtoroot/fset</FileSystemPath>
        <FsetId>fset-1902718ea0ae****</FsetId>
        <Status>CREATED</Status>
        <CreateTime>2021-09-30T10:08:08Z</CreateTime>
        <UpdateTime>2021-09-30T10:08:08Z</UpdateTime>
    </Entries>
</DescribeFilesetsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 指定的NextToken非法。
404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. 指定的MaxResults非法。

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