# 获取文件系统列表 - ListShares #### 功能介绍 获取文件系统列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SFSTurbo/doc?api=ListShares)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sfsturbo/sfsturbo_02_0079.html)。 #### URI GET /v1/{project_id}/sfs-turbo/shares/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 操作用户的项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 设置返回的文件系统个数的最大值，不填默认为1000个 | | offset | 否 | Integer | 设置返回的文件系统的偏移量。 | #### 请求参数 表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文件系统的数量。 | 表5ShareInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 如果是HPC缓存型，该字段返回hpc_cache。 枚举值： - bandwidth - hpc - hpc_cache | | 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'代表包周期计费。如果文件系统正在创建，该字段不返回。 枚举值： - **0** - **1** | | region | String | SFS Turbo文件系统所在区域。 | | security_group_id | String | 用户指定的安全组ID。 | | share_proto | String | SFS Turbo文件系统的协议类型，当前为NFS或CIFS。 | | share_type | String | SFS Turbo文件系统类型。 | | 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。 | | 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 | 文件系统的特性支持情况。 | 表6ActionProgress | 参数 | 参数类型 | 描述 | |:---|:---|:---| | CREATING | String | 创建文件系统的进度。 | 表7ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 标签的键。 最大长度128个字符。 key不能为空，不能包含非打印字符ASCII(0-31)，"=","\*","\<","\>","\\",",","\|","/"。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 | | value | String | 标签的值。 每个值最大长度255个字符，可以为空字符串。 不能包含非打印字符ASCII(0-31)，"=","\*","\<","\>","\\",",","\|","/"。只能包含大写字母、小写字母、数字，特殊字符"-"和"_"。 | 表8ShareInfoFeatures | 参数 | 参数类型 | 描述 | |:---|:---|:---| | backup | [ShareInfoFeature] object | SFS Turbo文件系统是否支持备份。 | 表9ShareInfoFeature | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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", "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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sfsturbo/ErrorCode.html)。