接口功能介绍
展示某个网关下已创建的共享列表
接口约束
1、用户需要已创建至少一个网关资源，该网关下至少开通一个缓存盘资源，已创建至少一个共享
URI
GET /v4/nfs/get-share-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| gatewayID | 是 | String | 网关的fuid | 参考请求示例 | |
| pageNo | 否 | Integer | 页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 页大小，默认值 10，取值范围 1~50 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| returnObj | Object | 响应对象 | 参考表 returnObj | |
| message | String | 状态描述 | SUCCESS | |
| description | String | 状态描述，一般为中文 | 成功 | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 响应对象 | 参考表results | |
| totalCount | Integer | 总数量 | 2 | |
| pageNo | Integer | 当前页 | 1 | |
| pageSize | Integer | 当前页展示数量 | 10 | |
| currentCount | Integer | 当前页记录数 | 10 |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| shareStatus | String | 共享的状态，①used：已使用；②frozen：已冻结 | 参考响应示例 | |
| shareID | String | 共享的ID | 参考响应示例 | |
| bucketName | String | 挂载的对象存储桶 | 参考响应示例 | |
| userMapping | String | 映射类型，①none；②root_squash；③root_squash | 参考响应示例 | |
| mountPoint | String | 共享的挂载点 | 参考响应示例 | |
| cacheDevice | String | 共享挂载缓存盘的盘符 | 参考响应示例 | |
| shareName | String | 共享的名称 | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| cacheDiskID | String | 共享挂载盘的id | 参考响应示例 | |
| roClients | Array of Strings | 只读客户端列表 | 参考响应示例 | |
| wrClients | Array of Strings | 读写客户端列表 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayID":"8a26498c-c0c8-11ee-ae9f-18022d1723b2",
"pageNo":1,
"pageSize":10
}
响应示例
{
"returnObj":{
"currentCount":1,
"totalCount":1,
"pageSize":5,
"results":[
{
"roClients":[
"192.168.0.2"
],
"shareName":"xiaoyixiasuanle",
"cacheDevice":"/dev/vdb",
"shareStatus":"used",
"bucketName":"bucket-1a6c",
"cacheDiskID":"50d29094-0f62-11ef-91d0-18022d1723b2",
"regionID":"81f7728662dd11ec810800155d307d5b",
"wrClients":[
"192.168.0.3"
],
"shareID":"aeac624a-1191-11ef-b522-18022d1723b2",
"userMapping":[
],
"mountPoint":"/exports/xiaoyixiasuanle"
}
],
"pageNo":1
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
