接口功能介绍
查询指定付费类型的⽂件系统列表，付费类型有包年包月、按量付费两种。
接口约束
在2024年10月之后，弹性文件将支持VPCE终端节点服务接入，按资源池维度陆续上线，新建的文件系统默认支持VPCE。在弹性文件服务有关挂载地址的查询接口中将增加"vpceSharePath"字段，用于展示文件系统下每个VPC的挂载地址。
· 原挂载地址相关字段无改动，云主机、容器用户无须适配新字段。
· 若为物理机（标准裸金属）用户，须使用vpceSharePath字段中的挂载地址。
· 该字段仅适用于可用区资源池，即使用资源池概况信息查询接口查询带对接的资源池信息，如资源池信息"regionVersion": "v4.0"，即可使用。
URI
GET /v4/sfs/list-sfs-by-ondemand
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| onDemand | 是 | Boolean | 是否按需订购 | false | |
| pageSize | 否 | Integer | 每页包含的元素个数，默认10 | 10 | |
| pageNo | 否 | Integer | 列表的分页页码，默认1 | 1 |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 文件系统读写权限信息总数 | 1 | |
| list | Array of Objects | 查询的详情列表 | list1 | |
| pageSize | Integer | 每页个数 | 10 | |
| pageNo | Integer | 当前页数 | 1 |
表 list1
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sfsName | String | 弹性文件命名 | 参考响应示例 | |
| sfsUID | String | 弹性文件功能系统唯一 ID | 参考响应示例 | |
| sfsSize | Integer | 容量大小（GB） | 1000 | |
| sfsType | String | 类型，2 种，capacity/performance | 参考响应示例 | |
| sfsProtocol | String | 挂载协议。2 种，nfs/cifs | 参考响应示例 | |
| sfsStatus | String | 弹性文件状态。creating/available/unusable/delete_error/deleting | 参考响应示例 | |
| usedSize | Integer | 已用大小（MB） | 34 | |
| createTime | Long | 创建时刻，epoch 时戳，精度毫秒 | 1695731732000 | |
| updateTime | Long | 更新时刻，epoch 时戳，精度毫秒 | 1697591690000 | |
| expireTime | Long | 过期时刻，epoch 时戳，精度毫秒 | 1793018192000 | |
| projectID | String | 资源所属企业项目 ID | 参考响应示例 | |
| isEncrypt | Boolean | 是否加密盘 | false | |
| kmsUUID | String | 加密盘密钥 UUID | 参考响应示例 | |
| vpceSharePath | Array of Objects | 仅可用区资源池涉及该字段，即通过资源池概况信息查询接口中"regionVersion": "v4.0"的资源池适用本字段。当该资源池支持VPCE接入弹性文件服务后，新建的文件系统在使用查询接口时会返回该字段，该字段中包含每个VPC对应的挂载地址，与原挂载地址相比，不仅可以挂载云主机、容器，还可用于挂载标准裸金属。同时原挂载地址仍可用，云主机、容器用户可无须再适配本字段。 | list2 | |
| onDemand | Boolean | 是否按需订购 | false | |
| regionID | String | 资源池 ID | 参考响应示例 | |
| azName | String | 多可用区下的可用区名字 | 参考响应示例 | |
| sharePath | String | linux 主机挂载地址 | 参考响应示例 | |
| sharePathV6 | String | linux 主机 IPv6挂载地址 | 参考响应示例 | |
| windowsSharePath | String | windows 主机挂载地址 | 参考响应示例 | |
| windowsSharePathV6 | String | windows 主机 IPv6挂载地址 | 参考响应示例 | |
| mountCount | Integer | 挂载点数量 | 0 | |
| cephID | String | ceph底层的id | 参考响应示例 | |
| phySharePath | String | linux物理机共享路径，若支持物理机挂载，则显示该字段，否则该字段不存在。通过资源池概况信息查询接口中"regionVersion": "v3.0"的资源池适用本字段 | 参考响应示例 |
表 list2
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpcID | String | vpc的ID | vpc-66jrjem533 | |
| vpcName | String | vpc名称 | vpc-tzbtest | |
| sharePath | String | linux 主机共享路径 | 参考响应示例 | |
| sharePathV6 | String | linux 主机 IPv6 共享路径 | 参考响应示例 | |
| windowsSharePath | String | win 主机共享路径 | 参考响应示例 | |
| windowsSharePathV6 | String | win 主机 IPv6 共享路径 | 参考响应示例 |
枚举参数
无
请求示例
请求url
GET https://sfs-global.ctapi.ctyun.cn/v4/sfs/list-sfs-by-ondemand?regionID=81f7728662dd11ec810800155d307d5b&onDemand=false
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"total": 2,
"list": [
{
"updateTime": 1697591690000,
"projectID": "0",
"usedSize": 34,
"phySharePath": "100.120.0.100:/mnt/sfs_perf/4c7e60035aafeb9f66f9ea9f8b98e5fb_vo12l2ks9zhr4g5f",
"kmsUUID": "",
"isEncrypt": false,
"sfsSize": 1000,
"vpceSharePath": [{"vpcID": "vpc-66jrjem533", "windowsSharePathV6": "", "windowsSharePath": "", "vpcName": "vpc-tzbtest", "sharePath": "192.168.0.7:/mnt/sfs_perf/4c7e60035aafeb9f66f9ea9f8b98e5fb_vo12l2ks9zhr4g5f", "sharePathV6": ""}],
"onDemand": false,
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime": 1695731732000,
"sharePath": "100.127.155.200:/mnt/sfs_perf/4c7e60035aafeb9f66f9ea9f8b98e5fb_vo12l2ks9zhr4g5f",
"mountCount": 0,
"sfsType": "performance",
"windowsSharePath": "",
"expireTime": 1793018192000,
"sfsProtocol": "nfs",
"azName": "az1",
"cephID": "vo12l2ks9zhr4g5f",
"sfsUID": "29c2697c-56bc-54a5-bb14-89eba07fcc30",
"sharePathV6": "",
"sfsStatus": "available",
"windowsSharePathV6": null,
"sfsName": "tzb-test-006"
},
{
"updateTime": 1697591690000,
"projectID": "0",
"usedSize": 34,
"kmsUUID": "",
"isEncrypt": false,
"sfsSize": 1000,
"vpceSharePath": [{"vpcID": "vpc-66jrjem533", "windowsSharePathV6": "", "windowsSharePath": "", "vpcName": "vpc-tzbtest", "sharePath": "192.168.0.7:/mnt/sfs_perf/4c7e60035aafeb9f66f9ea9f8b98e5fb_vo12l2ks9zhr4g5f", "sharePathV6": ""}],
"onDemand": false,
"regionID": "b73e3ad4-417f-11ed-bad1-525400cc3b79",
"createTime": 1695730438000,
"sharePath": "100.127.155.200:/mnt/sfs_perf/4c7e60035aafeb9f66f9ea9f8b98e5fb_52tuhm39knw7kmwv",
"mountCount": 0,
"sfsType": "performance",
"windowsSharePath": "",
"expireTime": 1821960899000,
"sfsProtocol": "nfs",
"azName": "az1",
"cephID": "52tuhm39knw7kmwv",
"sfsUID": "0bc93f6e-e768-59b1-b607-b2915eeaa0fb",
"sharePathV6": "",
"sfsStatus": "available",
"windowsSharePathV6": null,
"sfsName": "tzb-test-005"
}
],
"pageSize": 10,
"pageNo": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
