DescribeFilesets_文件存储(NAS/CPFS)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 仅 CPFS 2.2.0 和 CPFS 智算版 2.7.0 及以上版本支持 Fileset。您可以在控制台文件系统详情页面查看版本信息。

  • 筛选键(Filters)中,FsetIds 需要做全字匹配,FileSystemPath、Description 支持模糊匹配。

  • 支持组合查询。

流控信息

请求速率为120/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
nas:DescribeFilesets
List
FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

请求参数

字段名称字段详情
FileSystemIdstring

文件系统 ID。展开详情

示例值:bmcpfs-290w65p03ok64ya****参考取值来源:
    CreateFileSystem
    DescribeFileSystems
    SetFilesetQuota
Filtersarray<object>

待查询 Fileset 的筛选键信息。

子级条数 <= 5
NextTokenstring

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

示例值:TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResultsinteger<int64>

每次查询结果的个数。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20取值 <= 100
OrderByFieldstring

排序字段。展开详情

示例值:FileCountLimit枚举值:SpaceUsageFileCountUsageSizeLimitFileCountLimit
SortOrderstring

排序方式。展开详情

示例值:asc枚举值:ascdesc

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:2D69A58F-345C-4FDE-88E4-BF518948****
NextTokenstring

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

示例值:TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
deprecatedFileSystemIdstring

文件系统 ID。展开详情

示例值:bmcpfs-290w65p03ok64ya****
Entriesobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断

变更历史

变更时间变更内容概要操作
2025-01-20
变更错误码400
新增请求参数OrderByField
新增请求参数SortOrder
2024-10-24
变更请求参数Filters
变更返回参数
2024-05-31
删除返回参数
2021-10-28
变更返回参数
2021-10-28
新增OpenAPI,查询文件集列表

相关示例