文档首页/ 弹性文件服务 SFS/ API参考/ SFS Turbo API说明/ 生命周期管理/ 获取文件系统列表
更新时间：2024-12-31 GMT+08:00
查看PDF
分享

获取文件系统列表

功能介绍

获取文件系统列表

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

操作用户的项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Long

设置返回的文件系统个数的最大值，不填默认为1000个

offset

否

Long

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

账号的token

Content-Type

是

String

MIME类型

响应参数

状态码： 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；如果是20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB，该字段返回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文件系统所在区域。

security_group_id

String

用户指定的安全组ID。

share_proto

String

SFS Turbo文件系统的协议类型，当前为NFS

share_type

String

SFS Turbo文件系统性能类型，包括“STANDARD”标准型和“PERFORMANCE”性能型。

size

String

SFS Turbo文件系统总容量，单位GB。

status

String

SFS Turbo文件系统的状态。'100'表示创建中，'200'表示可用，'303'表示创建失败，'800'表示实例被冻结。

sub_status

String

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

'121'表示扩容中；'132'表示修改安全组中；'137'表示添加VPC中；'138'表示删除VPC中；'150'表示配置联动后端中；'151'表示删除联动后端配置中。

'221'表示扩容成功；'232'表示修改安全组成功；'237'表示添加VPC成功；'238'表示删除VPC成功；'250'表示配置联动后端成功；'251'表示删除联动后端配置成功。

'321'表示扩容失败；'332'表示修改安全组失败；'337'表示添加VPC失败；'338'表示删除VPC失败；'350'表示配置联动后端失败；'351'表示删除联动后端配置失败。

subnet_id

String

用户指定的子网的网络ID。

vpc_id

String

用户指定的VPC ID。

enterprise_project_id

String

SFS Turbo文件系统绑定的企业项目ID。

tags

Array of ResourceTag objects

tag标签的列表。

optional_endpoint

String

可选的挂载IP地址。上一代文件系统规格类型不返回该字段。

hpc_bw

String

文件系统的带宽规格。

  • "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

标签的键。

最大长度128个字符。

key不能为空，不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。

value

String

标签的值。

每个值最大长度255个字符，可以为空字符串。

不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。
表8 ShareInfoFeatures

参数

参数类型

描述

backup

ShareInfoFeature object

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

参数

参数类型

描述

is_support

Boolean

文件系统是否支持该特性

message

String

文件系统是否支持该特性的详细信息

msg_code

String

文件系统是否支持该特性的详细信息

请求示例

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

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

响应示例

状态码： 200

查询列表成功，返回body

  • 查询项目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",
    "action_progress" : {
      "CREATING" : "22%"
    },
    "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"
  } ]
}

  • 查询项目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",
    "action_progress" : {
      "CREATING" : "22%"
    },
    "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"
  }, {
    "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" : "192.168.xx.xx:/",
    "optional_endpoint" : "192.168.xx.xx 192.168.xx.xx",
    "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"
  } ]
}

状态码

状态码

描述

200

查询列表成功，返回body

错误码

请参见错误码。

父主题： 生命周期管理

相关文档