更新时间:2026-10-08 GMT+08:00
分享

获取文件系统列表 - ListShares

功能介绍

获取文件系统列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/sfs-turbo/shares/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

查询返回的文件系统个数的最大值。

约束限制:

不涉及。

取值范围:

0~2000

默认取值:

1000

offset

否

Integer

参数解释:

设置返回的文件系统的偏移量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于鉴权认证。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

是

String

参数解释:

请求消息体MIME类型,用于标识请求正文的数据格式。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

shares

Array of ShareInfo objects

参数解释:

查询请求返回的SFS Turbo文件系统的列表。

取值范围:

不涉及。

count

Integer

参数解释:

查询请求返回的SFS Turbo文件系统的总数量。

取值范围:

不涉及。

表5 ShareInfo

参数

参数类型

描述

action_progress

ActionProgress object

参数解释:

SFS Turbo文件系统的创建任务进度。文件系统正在创建时,返回该字段,否则不返回。

取值范围:

不涉及。

version

String

参数解释:

SFS Turbo文件系统的版本号。

取值范围:

不涉及。

avail_capacity

String

参数解释:

SFS Turbo文件系统的剩余可用容量,单位为GB。

取值范围:

不涉及。

availability_zone

String

参数解释:

SFS Turbo文件系统所在可用区的编码。

取值范围:

不涉及。

az_name

String

参数解释:

SFS Turbo文件系统所在可用区的名称。

取值范围:

不涉及。

created_at

String

参数解释:

文件系统的创建时间。

取值范围:

UTC时间格式,例如:2018-11-19T04:02:03。

crypt_key_id

String

参数解释:

用户指定的加密密钥ID,非加密盘时不返回。

取值范围:

不涉及。

expand_type

String

参数解释:

扩展类型。当文件系统正在创建时,该字段不返回。

取值范围:

  • bandwidth:增强版文件系统

  • hpc:20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB的文件系统

  • hpc_cache:HPC缓存型文件系统

export_location

String

参数解释:

SFS Turbo文件系统的挂载地址。例如“192.168.0.90:/”。如果文件系统正在创建,该字段不返回。

取值范围:

不涉及。

id

String

参数解释:

SFS Turbo文件系统的唯一标识ID。

取值范围:

不涉及。

name

String

参数解释:

SFS Turbo文件系统的名称。

取值范围:

不涉及。

pay_model

String

参数解释:

SFS Turbo文件系统的计费模式。如果文件系统正在创建,该字段不返回。

取值范围:

  • 0:按需付费

  • 1:包周期计费

region

String

参数解释:

SFS Turbo文件系统所在的区域。

取值范围:

区域编码字符串如cn-north-4。

security_group_id

String

参数解释:

用户指定的安全组ID。

取值范围:

不涉及。

share_proto

String

参数解释:

SFS Turbo文件系统的协议类型。

取值范围:

当前为NFS或CIFS。

share_type

String

参数解释:

SFS Turbo文件系统的性能类型。

取值范围:

  • standard:标准型。

  • standard.enhanced:标准型-增强版。

  • performance:性能型。

  • performance.enhanced:性能型-增强版。

  • hpc.20M:20MB/s/TiB。

  • hpc.40M:40MB/s/TiB。

  • hpc.125M:125MB/s/TiB。

  • hpc.250M:250MB/s/TiB。

  • hpc.500M:500MB/s/TiB。

  • hpc.1000M:1000MB/s/TiB。

  • hpc.cache:HPC缓存型。

  • aits.100M:100MB/s/TiB-智算型。

  • aits.200M:200MB/s/TiB-智算型。

size

String

参数解释:

SFS Turbo文件系统的总容量,单位为GB。

取值范围:

不涉及。

status

String

参数解释:

SFS Turbo文件系统的状态。文件系统处于不同生命周期阶段会返回对应状态。

取值范围:

  • 100:创建中

  • 200:可用

  • 303:创建失败

  • 800:实例被冻结

sub_status

String

参数解释:

SFS Turbo文件系统的子状态。当用户未对文件系统有修改类操作时,该字段不返回。

取值范围:

  • 121:表示扩容中。
  • 132:表示修改安全组中。
  • 150:表示配置联动后端中。
  • 151:表示删除联动后端配置中。
  • 221:表示扩容成功。
  • 232:表示修改安全组成功。
  • 250:表示配置联动后端成功。
  • 251:表示删除联动后端配置成功。
  • 321:表示扩容失败。
  • 332:表示修改安全组失败。
  • 350:表示配置联动后端失败。
  • 351:表示删除联动后端配置失败。

subnet_id

String

参数解释:

文件系统所在子网的网络ID。

取值范围:

不涉及。

vpc_id

String

参数解释:

文件系统所在VPC的ID。

取值范围:

不涉及。

enterprise_project_id

String

参数解释:

创建SFS Turbo文件系统时,给文件系统绑定的企业项目ID。

关于企业项目ID的获取及企业项目特性的详细信息,请参考查询企业项目列表。

取值范围:

不涉及。

tags

Array of ResourceTag objects

参数解释:

tag标签的列表,使用同一标签标识多种云资源,即所有服务均可在标签输入框下拉选择同一标签,单SFS Turbo文件系统最多20个标签。

取值范围:

不涉及。

optional_endpoint

String

参数解释:

可选的挂载IP地址。标准型、标准型-增强版、性能型、性能型-增强版等类型的文件系统不返回该参数。

取值范围:

不涉及。

hpc_bw

String

参数解释:

HPC型文件系统的带宽规格。仅expand_type为hpc时返回该字段。

取值范围:

  • 20M:表示20MB/s/TiB类型文件系统的带宽规格。

  • 40M:表示40MB/s/TiB类型文件系统的带宽规格。

  • 125M:表示125MB/s/TiB类型文件系统的带宽规格。

  • 250M:表示250MB/s/TiB类型文件系统的带宽规格。

  • 500M:表示500MB/s/TiB类型文件系统的带宽规格。

  • 1000M:表示1000MB/s/TiB类型文件系统的带宽规格。

  • 2G、4G、8G、16G、24G、32G或48G:表示HPC缓存型文件系统的带宽规格。

instanceId

String

参数解释:

文件系统规格的节点ID,为预留字段,不具备实际含义。

取值范围:

不涉及。

instanceType

String

参数解释:

文件系统规格的节点类型,为预留字段,不具备实际含义。

取值范围:

不涉及。

statusDetail

String

参数解释:

文件系统的请求ID,为预留字段,不具备实际含义。

取值范围:

不涉及。

features

ShareInfoFeatures object

参数解释:

文件系统的特性支持情况。

取值范围:

不涉及。

表6 ActionProgress

参数

参数类型

描述

CREATING

String

参数解释:

创建文件系统的进度。

取值范围:

不涉及。

表7 ResourceTag

参数

参数类型

描述

key

String

参数解释:

标签的键。

取值范围:

不涉及。

value

String

参数解释:

标签的值。

取值范围:

不涉及。

表8 ShareInfoFeatures

参数

参数类型

描述

backup

ShareInfoFeature object

参数解释:

SFS Turbo文件系统是否支持备份。

取值范围:

不涉及。

表9 ShareInfoFeature

参数

参数类型

描述

is_support

Boolean

参数解释:

文件系统是否支持该特性。

取值范围:

  • true:支持该特性

  • false:不支持该特性

message

String

参数解释:

文件系统是否支持该特性的详细信息,为预留字段,不具备实际含义。

取值范围:

不涉及。

msg_code

String

参数解释:

文件系统是否支持该特性的提示信息码,为预留字段,不具备实际含义。

取值范围:

不涉及。

请求示例

查询项目ID为"e1e45b08f3ea4480ab4655ef9c7160ba"的文件系统列表

GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail

响应示例

状态码:200

  • 查询项目ID为“e1e45b08f3ea4480ab4655ef9c7160ba”的文件系统列表的响应示例。

    {
      "shares" : [ {
        "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
        "name" : "sfs-turbo-8468",
        "status" : "100",
        "version" : "1.0.0",
        "region" : "example",
        "created_at" : "2018-11-19T04:02:03",
        "share_type" : "STANDARD",
        "sub_status" : "",
        "availability_zone" : "az1.dc1",
        "az_name" : "az1",
        "vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3",
        "subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97",
        "security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a",
        "size" : "500.00",
        "pay_model" : "0",
        "avail_capacity" : "500.00",
        "share_proto" : "NFS",
        "export_location" : "192.168.1.102:/",
        "optional_endpoint" : "192.168.1.102 192.168.1.232",
        "instanceId" : "34d65df8-342f-49fb-ac1a-60f686ca437c",
        "statusDetail" : "d120c389861619e7580a12cab74f6a22",
        "instanceType" : "efs-ha",
        "enterprise_project_id" : "0",
        "features" : {
          "backup" : {
            "is_support" : true
          }
        }
      } ],
      "count" : 1
    }
  • 查询项目ID为“5694xxx8f3e0000xxxx655exxxxx60b7”的文件系统列表的响应示例。

    {
      "shares" : [ {
        "id" : "65f2d30b-7b4e-4786-9608-4324faef6646",
        "name" : "sfs-turbo-df12",
        "status" : "200",
        "version" : "1.0.0",
        "region" : "example",
        "created_at" : "2018-11-15T02:32:10",
        "export_location" : "65f2d30b-7b4e-4786-9608-4324faef6646.sfsturbo.internal:/",
        "optional_endpoint" : "192.168.1.195 192.168.1.45 192.168.1.201 192.168.1.119 192.168.1.115 192.168.1.150 192.168.1.107 192.168.1.35 192.168.1.123 192.168.1.153 192.168.1.252 192.168.1.7 192.168.1.40 192.168.1.62 192.168.1.23 192.168.1.76 192.168.1.204 192.168.1.178 192.168.1.28 192.168.1.145",
        "share_type" : "HPC_PERFORMANCE_250M",
        "expand_type" : "hpc",
        "sub_status" : "",
        "availability_zone" : "az1.dc1",
        "az_name" : "az1",
        "vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3",
        "subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97",
        "security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a",
        "size" : "3686.00",
        "pay_model" : "0",
        "avail_capacity" : "3686.00",
        "share_proto" : "NFS",
        "instanceId" : "897e198d-6ba0-44c6-9104-dc5f915c1fbd",
        "statusDetail" : "c4935f83562f49129faf4455b83bfb34",
        "instanceType" : "sfs-turbo-hpc",
        "enterprise_project_id" : "0",
        "hpc_bw" : "125M",
        "features" : {
          "backup" : {
            "is_support" : true
          }
        }
      } ],
      "count" : 1
    }

状态码

状态码

描述

200

查询列表成功,返回body

错误码

请参见错误码。

相关文档