接口功能介绍
可以根据虚机查询绑定的文件系统列表
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
无
URI
GET /v4/ecs/sfs/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
5a6e9ec1-9742-2dea-7750-52dc05ed794d |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
totalCount | Integer | 总记录数 | ||
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
fileSysID | String | 文件系统ID | 56644622-41d1-5c35-8794-df55bffaff88 | |
fileSysName | String | 文件系统名称 | sfs-1012 | |
fileSysStatus | String | 文件系统状态 | available | |
storageType | String | 存储类型 | capacity | |
shareProtocol | String | 存储协议 | nfs | |
expireTime | String | 到期时间 | 2024-01-06T07:49:10Z | |
sharePath | String | 共享路径(文件提供的共享目录) | 100.127.155.200:/mnt/sfs_perf/08c34e521333ea76a5d28c7275a0d536_au5n2d6s3y0a3gpj | |
cephID | String | 文件系统ID(底层) | au5n2d6s3y0a3gpj | |
resourceID | String | 文件系统资源ID(IT) | d9a9947d001544d5b94efb4ec1ed874c |
枚举参数
无
请求示例
请求url
GET .../v4/ecs/sfs/list?regionID=81f7728662dd11ec810800155d307d5b&instanceID=5a6e9ec1-9742-2dea-7750-52dc05ed794d
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 1,
"results": [
{
"fileSysID": "d2fc6971-5460-5ed4-92fa-0309680f32ae",
"fileSysName": "sfs-ysr-ipv4",
"fileSysStatus": "available",
"storageType": "performance",
"shareProtocol": "nfs",
"expireTime": "2024-01-06T07:49:10Z",
"sharePath": "100.127.155.200:/mnt/sfs_perf/08c34e521333ea76a5d28c7275a0d536_au5n2d6s3y0a3gpj",
"cephID": "au5n2d6s3y0a3gpj",
"resourceID": "d9a9947d001544d5b94efb4ec1ed874c"
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码