接口功能介绍
展示某个网关下已创建的缓存盘资源列表
接口约束
1、用户需要已创建至少一个网关资源，该网关下至少开通一个缓存盘资源
URI
GET /v4/nfs/get-cache-disk-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| gatewayID | 是 | String | 网关的ID | 参考请求示例 | |
| cacheDiskStatus | 否 | String | 筛选缓存盘状态，①used：已使用；②not_used：未使用；③frozen：已过期；④deploying：部署中；⑤deleting：删除中（包周期计费的缓存盘为已过期，按需计费的缓存盘为已冻结，目前仅支持包周期计费的缓存盘） | 参考请求示例 | |
| expiredTimeSort | 否 | String | 到期时间排序，①asce：升序,默认升序排列；②desc：降序 | 参考请求示例 | |
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| cacheDevice | String | 单个缓存盘的盘符 | 参考响应示例 | |
| cacheName | String | 单个缓存盘的名称 | 参考响应示例 | |
| cacheDiskID | String | 单个缓存盘的ID | 参考响应示例 | |
| cacheType | String | 单个缓存盘的类型，①com：通用IO；②high：超高IO | 参考响应示例 | |
| gatewayID | String | 单个缓存盘对应的网关ID | 参考响应示例 | |
| cacheDiskStatus | String | 单个缓存盘的状态，①used：已使用；②not_used：未使用；③frozen：已过期；④deploying：部署中；⑤deleting：删除中（包周期计费的缓存盘为已过期，按需计费的缓存盘为已冻结，目前仅支持包周期计费的缓存盘） | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| expiredTime | String | 单个缓存盘的到期时间（包周期计费下展示该缓存盘到期时间，按需计费不展示，目前仅支持包周期计费的缓存盘） | 参考响应示例 | |
| cacheSpec | String | 单个缓存盘的容量 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayID":"a6c48f28-111c-11ef-b7e0-18022d1723b2",
"pageNo":1,
"pageSize":5,
"cacheDiskStatus":"used",
"expirationTimeSort":"desc"
}
响应示例
{
"returnObj":{
"currentCount":1,
"totalCount":1,
"pageSize":5,
"results":[
{
"cacheName":"HSG_NFS_GW_EDS_11c60cac-111d-11ef-b7e0-18022d1723b2",
"expiredTime":"2024-06-13T11:37:20Z",
"cacheSpec":"41",
"cacheType":"high",
"gatewayID":"a6c48f28-111c-11ef-b7e0-18022d1723b2",
"regionID":"81f7728662dd11ec810800155d307d5b",
"cacheDiskStatus":"used",
"cacheDiskID":"11c61080-111d-11ef-b7e0-18022d1723b2",
"cacheDevice":"/dev/vdb"
}
],
"pageNo":1
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
