链接复制成功!
查询文件系统详细信息 - ShowShare
功能介绍
查询SFS Turbo文件系统详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。获取方法请参见1.4 获取文件系统列表 - ListShares。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 扩展类型。当文件系统正在创建时,该字段不返回。 取值范围: |
| export_location | String | 参数解释: SFS Turbo文件系统的挂载地址。例如“192.168.0.90:/”。如果文件系统正在创建,该字段不返回。 取值范围: 不涉及。 |
| id | String | 参数解释: SFS Turbo文件系统的唯一标识ID。 取值范围: 不涉及。 |
| name | String | 参数解释: SFS Turbo文件系统的名称。 取值范围: 不涉及。 |
| pay_model | String | 参数解释: SFS Turbo文件系统的计费模式。如果文件系统正在创建,该字段不返回。 取值范围: |
| region | String | 参数解释: SFS Turbo文件系统所在的区域。 取值范围: 区域编码字符串如cn-north-4。 |
| 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文件系统的状态。文件系统处于不同生命周期阶段会返回对应状态。 取值范围: |
| sub_status | String | 参数解释: SFS Turbo文件系统的子状态。当用户未对文件系统有修改类操作时,该字段不返回。 取值范围:
|
| 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时返回该字段。 取值范围: |
| instanceId | String | 参数解释: 文件系统规格的节点ID,为预留字段,不具备实际含义。 取值范围: 不涉及。 |
| instanceType | String | 参数解释: 文件系统规格的节点类型,为预留字段,不具备实际含义。 取值范围: 不涉及。 |
| statusDetail | String | 参数解释: 文件系统的请求ID,为预留字段,不具备实际含义。 取值范围: 不涉及。 |
| features | ShareInfoFeatures object | 参数解释: 文件系统的特性支持情况。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| backup | ShareInfoFeature object | 参数解释: SFS Turbo文件系统是否支持备份。 取值范围: 不涉及。 |
请求示例
查询ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde"的文件系统详细信息
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde 响应示例
状态码:200
-
查询项目ID为“e1e45b08f3ea4480ab4655ef9c7160ba”的文件系统列表的响应示例。
{ "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 } } }
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功,返回文件系统详细信息。 |
错误码
请参见错误码。