接口介绍
根据弹性文件名称和资源池ID，查询文件系统详情
接口约束
无
URI
GET /v4/oceanfs/info-by-name-sfs
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sfsName | 是 | String | 弹性文件名称 | 参考请求示例 | |
| regionID | 是 | String | 资源池 ID | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | 是 | String | 响应描述，一般为英文描述 | SUCCESS | |
| description | 是 | String | 响应描述，一般为中文描述 | 成功 | |
| returnObj | 否 | Object | 参考returnObj | 参考returnObj | 表returnObj |
| errorCode | 否 | String | 业务细分码，为 product.module.code 三段式码 | 参考结果码 | |
| error | 否 | String | 业务细分码，为product.module.code三段式码大驼峰形式 | 参考结果码 |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sfsName | 是 | String | 弹性文件命名 | 参考响应示例 | |
| sfsUID | 是 | String | 弹性文件功能系统唯一 ID | 参考响应示例 | |
| sfsSize | 是 | Integer | 大小（GB），1024进制 | 参考响应示例 | |
| sfsType | 是 | String | 类型，massive | 参考响应示例 | |
| sfsProtocol | 是 | String | 挂载协议。2 种，nfs/cifs | 参考响应示例 | |
| sfsStatus | 是 | String | 海量文件状态。creating/available/unusable/delete_error/deleting | 参考响应示例 | |
| usedSize | 是 | Integer | 已用大小（MB） | 参考响应示例 | |
| createTime | 是 | Integer | 创建时刻，epoch 时戳，精度毫秒 | 参考响应示例 | |
| updateTime | 是 | Integer | 更新时刻，epoch 时戳，精度毫秒 | 参考响应示例 | |
| expireTime | 是 | Integer | 过期时刻，epoch 时戳，精度毫秒 | 参考响应示例 | |
| projectID | 是 | String | 资源所属企业项目 ID | 参考响应示例 | |
| isEncrypt | 是 | Boolean | 是否加密盘 | 参考响应示例 | |
| kmsUUID | 否 | String | 加密盘密钥 UUID | 参考响应示例 | |
| onDemand | 是 | Boolean | 是否按需订购 | 参考响应示例 | |
| regionID | 是 | String | 资源池 ID | 参考响应示例 | |
| azName | 否 | String | 多可用区下的可用区名字 | 参考响应示例 | |
| sharePath | 是 | String | linux 主机共享路径 | 参考响应示例 | |
| sharePathV6 | 否 | String | linux 主机 IPv6 共享路径 | 参考响应示例 | |
| windowsSharePath | 否 | String | win 主机共享路径 | 参考响应示例 | |
| windowsSharePathV6 | 否 | String | win 主机 IPv6 共享路径 | 参考响应示例 | |
| mountCount | 是 | Integer | 挂载点数量 | 参考响应示例 | |
| cephID | 是 | String | ceph底层的id | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
"sfsUID": "73725123-0de1-5424-8115-7da2a24f3dfb",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj": {
"updateTime": 1678342191000,
"projectID": "0",
"usedSize": 34,
"kmsUUID": "",
"isEncrypt": false,
"sfsSize": 1024,
"onDemand": false,
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime": 1678239529000,
"sharePath": "100.127.155.200:/mnt/sfs_mass/a7135589f022439c1edefc74b9336f7a_5czqobzhm0d4rjbx",
"mountCount": 0,
"sfsType": "massive",
"windowsSharePath": "",
"expireTime": 1709861929000,
"sfsProtocol": "nfs",
"azName": "az1",
"cephID": "5czqobzhm0d4rjbx",
"sfsUID": "73725123-0de1-5424-8115-7da2a24f3dfb",
"sharePathV6": "",
"sfsStatus": "available",
"windowsSharePathV6": null,
"sfsName": "yyx-sfs-test-003"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 说明 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考错误码说明
