接口功能介绍
资源池 ID 下，所有的文件系统详情查询
接口约束
无
URI
GET /v4/sfs/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 参考请求示例 | |
| projectID | 否 | String | 资源所属企业项目 ID，默认为"0" | 0 | |
| pageSize | 否 | Integer | 每页包含的元素个数 | 10 | |
| pageNo | 否 | Integer | 列表的分页页码 | 1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| stateCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | returnObj | returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| list | Array of Objects | 返回的文件列表 | 参考响应示例 | list |
| totalCount | Integer | 资源池下用户弹性文件总数 | 1 | |
| currentCount | Integer | 当前页码下查询回来的用户弹性文件数 | 10 |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 弹性文件命名 | test-used-size | |
| UID | String | 弹性文件功能系统唯一 ID | 06669b67-b52f-5c7b-b984-c8e866fb94f9 | |
| resourceID | String | 资源 ID（计费资源 ID） | 参考响应示例 | |
| sfsSize | Integer | 大小（GB） | ||
| sfsType | String | 类型，capacity/performance/hdd_e/hpfs_perf/massive | performance | |
| sfsProtocol | String | 挂载协议。2 种，nfs/cifs | nfs | |
| sfsStatus | String | 弹性文件状态 | available | |
| usedSize | Integer | 已用大小（MB） | 31744 | |
| createTime | Long | 创建时刻，epoch 时戳，精度毫秒 | 1669016364000 | |
| updateTime | Long | 更新时刻，epoch 时戳，精度毫秒 | 1669341071000 | |
| expireTime | Long | 过期时刻，epoch 时戳，精度毫秒 | 32503737600000 | |
| projectID | String | 资源所属企业项目 ID | 0 | |
| isEncrypt | Boolean | 是否加密盘 | false | |
| kmsUUID | String | 加密盘密钥 UUID | ||
| onDemand | Boolean | 是否按需订购 | true | |
| regionID | String | 资源池 ID | b73e3ad4-417f-11ed-bad1-525400cc3b79 | |
| azName | String | 多可用区下的可用区名字 | az1 | |
| sharePath | String | linux 主机共享路径 | 100.127.155.200:/mnt/sfs_perf/a7135589f022439c1edefc74b9336f7a_k57xyye40k6v7f88 | |
| sharePathV6 | String | linux 主机 IPv6 共享路径 | ||
| windowsSharePath | String | win 主机共享路径 | ||
| windowsSharePathV6 | String | win 主机 IPv6 共享路径 | ||
| mountCount | Integer | 挂载点数量 | 0 | |
| cephID | String | ceph底层的id | k57xyye40k6v7f88 |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/list?regionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj": {
"total": 1,
"list": [
{
"sharePathV6": "",
"projectID": "0",
"sfsStatus": "creating",
"onDemand": true,
"windowsSharePathV6": null,
"sfsType": "performance",
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"usedSize": 0,
"sharePath": "100.127.155.200:/mnt/sfs_perf/afb8195dd8e52cf873734dfb679de001_rxjaxjrox1hvcyru",
"windowsSharePath": "",
"name": "sfs-cstor-test0-sfs",
"expireTime": "3000-01-01T16:00:00Z",
"kmsUUID": "",
"sfsSize": 512,
"cephID": "rxjaxjrox1hvcyru",
"sfsProtocol": "nfs",
"azName": "az1",
"resourceID": "133418979b074a37a66fc2353e17f844",
"createTime": 1664193665000,
"mountCount": 0,
"UID": "5aee9ac7-2571-5f8c-b27d-a5b1cf46d405"
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
