接口介绍
查询指定协议类型的⽂件系统列表,协议类型有NFS、CIFS两种
接口约束
无
URI
GET /v4/sfs/list-sfs-by-sfsprotocol
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
sfsProtocol | 是 | String | 协议类型,nfs或cifs | 参考请求示例 | |
pageSize | 否 | Integer | 每页包含的元素个数,默认10 | 10 | |
pageNo | 否 | Integer | 列表的分页页码,默认1 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Integer | 文件系统读写权限信息总数 | 参考响应示例 | |
list | Array of Objects | 查询的详情列表 | 参考list | 表list |
pageSize | Integer | 每页个数 | 参考响应示例 | |
pageNo | Integer | 当前页数 | 参考响应示例 |
表list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
sfsName | String | 弹性文件命名 | 参考响应示例 | |
sfsUID | String | 弹性文件功能系统唯一 ID | 参考响应示例 | |
sfsSize | Integer | 容量大小(GB) | 参考响应示例 | |
sfsType | String | 存储类型,3 种,capacity/performance/hdd_e | 参考响应示例 | |
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 | windows 主机挂载地址 | 参考响应示例 | |
windowsSharePathV6 | String | windows 主机 IPv6挂载地址 | 参考响应示例 | |
mountCount | Integer | 挂载点数量 | 参考响应示例 | |
cephID | String | ceph底层的id | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsProtocol": "nfs"
}
响应示例
{
"returnObj": {
"total": 2,
"list": [
{
"updateTime": 1697529714000,
"projectID": "0",
"usedSize": 33,
"kmsUUID": "",
"isEncrypt": false,
"sfsSize": 500,
"onDemand": false,
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime": 1697523506000,
"sharePath": "",
"mountCount": 0,
"sfsType": "performance",
"windowsSharePath": "\\\\100.127.155.200\\4c7e60035aafeb9f66f9ea9f8b98e5fb_q186t5tyb57zs1vk",
"expireTime": 1700201977000,
"sfsProtocol": "cifs",
"azName": "az1",
"cephID": "q186t5tyb57zs1vk",
"sfsUID": "4fa3e668-eb7a-5631-9936-886302aba61b",
"sharePathV6": "",
"sfsStatus": "available",
"windowsSharePathV6": "",
"sfsName": "sfs-wzw-a2da"
},
{
"updateTime": 1697529714000,
"projectID": "0",
"usedSize": 35,
"kmsUUID": "",
"isEncrypt": false,
"sfsSize": 2001,
"onDemand": true,
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime": 1695376689000,
"sharePath": "",
"mountCount": 0,
"sfsType": "performance",
"windowsSharePath": "\\\\100.127.155.200\\4c7e60035aafeb9f66f9ea9f8b98e5fb_crkdsnbo5g1ps9ub",
"expireTime": 32517952829000,
"sfsProtocol": "cifs",
"azName": "az1",
"cephID": "crkdsnbo5g1ps9ub",
"sfsUID": "630973ed-08e1-521d-9792-91f20f141e08",
"sharePathV6": "",
"sfsStatus": "available",
"windowsSharePathV6": "",
"sfsName": "sfs-4b3c"
}
],
"pageSize": 10,
"pageNo": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 说明 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | http status code | description | message |
---|---|---|---|
sfs.parameter.sfsProtocol | 200 | 请求参数错误:sfsProtocol参数错误 | request param error |
更多请参考错误码