接口功能介绍
根据资源池 ID 和 文件系统resourceID，查询文件系统详情
接口约束
1.自2024年5月16日后，本接口会受到IAM权限管控，当子账号或委托调用该接口时，需具备“sfs:shares:get”权限。
URI
GET /v4/sfs/info
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceID | 是 | String | 资源 ID | 参考[请求示例] | |
| regionID | 是 | String | 资源池 ID | 参考[请求示例] |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | String | 响应描述，一般为英文描述 | SUCCESS | |
| description | String | 响应描述，一般为中文描述 | 成功 | |
| returnObj | Object | 参考[returnObj] | returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码。 | 参考[结果码] | |
| error | String | 业务细分码，为product.module.code三段式码大驼峰形式. | 参考[结果码] |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 弹性文件命名 | 参考[响应示例] | |
| UID | String | 弹性文件功能系统唯一 ID | 参考[响应示例] | |
| resourceID | String | 资源 ID（计费资源 ID） | 参考[响应示例] | |
| sfsSize | Integer | 大小（GB） | 500 | |
| sfsType | String | 类型，capacity/performance/hdd_e/hpfs_perf/massive | 参考[响应示例] | |
| sfsProtocol | String | 挂载协议。2 种，nfs/cifs | 参考[响应示例] | |
| sfsStatus | String | 弹性文件状态。creating/available/unusable/delete_error/deleting | 参考[响应示例] | |
| usedSize | Integer | 已用大小（MB） | 1024 | |
| createTime | Long | 创建时刻，epoch 时戳，精度毫秒 | 1691051091000 | |
| updateTime | Long | 更新时刻，epoch 时戳，精度毫秒 | 1691051091000 | |
| expireTime | Long | 过期时刻，epoch 时戳，精度毫秒 | 1691051091000 | |
| projectID | String | 资源所属企业项目 ID | 参考[响应示例] | |
| isEncrypt | Boolean | 是否加密盘 | true | |
| kmsUUID | String | 加密盘密钥 UUID | 参考[响应示例] | |
| onDemand | Boolean | 是否按需订购 | true | |
| regionID | String | 资源池 ID | 参考[响应示例] | |
| azName | String | 多可用区下的可用区名字 | 参考[响应示例] | |
| sharePath | String | linux 主机共享路径 | 参考[响应示例] | |
| sharePathV6 | String | linux 主机 IPv6 共享路径 | 参考[响应示例] | |
| windowsSharePath | String | win 主机共享路径 | 参考[响应示例] | |
| windowsSharePathV6 | String | win 主机 IPv6 共享路径 | 参考[响应示例] | |
| mountCount | Integer | 挂载点数量 | 2 | |
| cephID | String | ceph底层的id | 参考[响应示例] |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/info?regionID=b73e3ad4-417f-11ed-bad1-525400cc3b79&resourceID=bd7f0ff27cef40c9909b59f58408c6ac
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"name":"old-yyx-fs-01",
"UID":"a0831405-29e1-524f-ae30-8abc9a62bf5d",
"resourceID":"bd7f0ff27cef40c9909b59f58408c6ac",
"sfsSize":500,
"sfsType":"performance",
"sfsProtocol":"nfs",
"updateTime":1692865770000,
"projectID":"0",
"usedSize":33,
"kmsUUID":"",
"isEncrypt":false,
"onDemand":false,
"regionID":"b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime":1691051091000,
"sharePath":"100.127.155.200:/mnt/sfs_perf/24fcf5e9934f83db1220ee1043c936f6_lfebavkcpllvk9oi",
"mountCount":0,
"windowsSharePath":"",
"expireTime":1693729511000,
"azName":"az1",
"cephID":"lfebavkcpllvk9oi",
"sharePathV6":"",
"sfsStatus":"available",
"windowsSharePathV6":""
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
