全部产品
Search

搜索本产品

    文件存储 CPFS：GetFileset - 查询文件集信息

    文档中心

    文件存储 CPFS：GetFileset - 查询文件集信息

    更新时间：Aug 28, 2026

    查询创建的Fileset信息。

    接口说明

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    nas:GetFileset

    get

    *全部资源

    *

    		 无 无

    请求语法

    GET  HTTP/1.1

    请求参数

    名称

    类型

    必填

    描述

    示例值
    FileSystemId

    string

    是

    文件系统 ID。

    • CPFS：必须以cpfs-开头，例如 cpfs-125487****。

    • CPFS 智算版：必须以bmcpfs-开头，例如 bmcpfs-0015****。

    cpfs-099394bd928c****
    FsetId

    string

    是

    Fileset ID。

    说明

    当文件系统类型为 CPFS 时，该参数必填。

    fset-1902718ea0ae****

    返回参数

    名称

    类型

    描述

    示例值

    object

    响应信息

    RequestId

    string

    请求 ID

    BC7C825C-5F65-4B56-BEF6-98C56C7C****
    Data

    object

    数据详情。

    Description

    string

    Fileset 的描述信息。

    Description
    FileSystemPath

    string

    Fileset 在 CPFS 文件系统中的路径。

    pathtoroot/fset/
    FsetId

    string

    Fileset ID。

    说明

    当文件系统类型为 CPFS 时，该参数必填。

    fset-03250e8fe78d****
    Status

    string

    Fileset 的状态。包括：

    • CREATING：正在创建 Fileset。

    • CREATED：Fileset 已创建完成，正常运行中。

    • RELEASING：Fileset 正在释放中。

    • RELEASED：Fileset 已删除。

    CREATED
    CreateTime

    string

    Fileset 的创建时间。

    返回格式：yyyy-MM-dd HH:mm:ss

    2025-11-21 12:49:25
    UpdateTime

    string

    Fileset 的最近一次更新时间。

    返回格式：yyyy-MM-dd HH:mm:ss

    2025-11-22 12:49:25
    DeletionProtection

    boolean

    实例释放保护属性，指定是否支持通过控制台或 API（ DeleteFileset ）释放实例。

    • true：开启实例释放保护。

    • false（默认）：关闭实例释放保护。

    说明

    该属性只能限制手动释放操作，对系统释放操作不生效。

    false
    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）。

    10,737,418,240
    FileCountLimit

    integer

    配额文件数量限制。取值范围：

    • 最小值：10,000。

    • 最大值：10,000,000,000。

    10001
    FileSystemId

    string

    文件系统 ID。

    • CPFS：必须以cpfs-开头，例如 cpfs-125487****。

    • CPFS 智算版：必须以bmcpfs-开头，例如 bmcpfs-0015****。

    cpfs-0244729a8ef8****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "Data": {
    "Description": "Description",
    "FileSystemPath": "pathtoroot/fset/",
    "FsetId": "fset-03250e8fe78d****",
    "Status": "CREATED",
    "CreateTime": "2025-11-21 12:49:25",
    "UpdateTime": "2025-11-22 12:49:25",
    "DeletionProtection": false,
    "FileCountUsage": 1024,
    "SpaceUsage": 1024,
    "Quota": {
      "SizeLimit": 0,
      "FileCountLimit": 10001
    },
    "FileSystemId": "cpfs-0244729a8ef8****"
  }
}

    错误码

    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 filesystem does not exist. 指定的文件系统不存在。

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

    变更历史

    更多信息，参考变更详情。