接口介绍
查询用户在某可用区全部专属云存储池详情
接口约束
无。
URI
GET /v4/dec/list-pool
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | ||
| message | 是 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 是 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 是 | Object | 参考表returnObj | ||
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码。 参考本文附录中的通用结果码 |
||
| error | 是 | String | 业务细分码，为product.module.code三段式大驼峰码. 参考本文附录中的通用结果码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| poolList | 是 | Object Array | 参考表poolList |
表 poolList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| poolName | 是 | String | 存储池名称 | ||
| resourceUUID | 是 | String | 资源UUID | ||
| status | 是 | String | 存储池状态 | ||
| diskType | 是 | String | 磁盘规格类型 SAS/SSD | ||
| totalCapacity | 是 | Float | 申请容量，单位：GB | ||
| freeCapacity | 是 | Float | 剩余可分配容量，单位：GB | ||
| actualUsedCapacity | 是 | Float | 已使用容量，单位：GB | ||
| volumeNO | 是 | Integer | 卷数量 | ||
| createTime | 是 | Integer | 创建时间，epoch时戳，精度毫秒 | ||
| expireTime | 是 | Integer | 到期时间，epoch时戳，精度毫秒 |
请求示例
请求头header
{
}
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d"
}
响应示例
{
"returnObj": {
"poolList": [
{
"poolName": "DSS-SSD",
"status": "ACTIVE",
"totalCapacity": 61440,
"freeCapacity": 2345,
"actualUsedCapacity": 75,
"volumeNO": 135,
"diskType": "SAS",
"expireTime": 1678501018000,
"createTime": 1676081790000,
"resourceUUID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
},
{
"poolName": "DSS-SSD",
"status": "ACTIVE",
"totalCapacity": 42440,
"freeCapacity": 345,
"actualUsedCapacity": 75,
"diskType": "SSD",
"expireTime": 1678500768000,
"volumeNO": 35,
"createTime": 1676081534000,
"resourceUUID": "db9d4a8d-32ba-40d5-b367-3427e42062dd"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考本文附录中的通用结果码。
附
通用结果码
未细分类通用码：
| errorCode | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| openapi.implementation.error | 服务端实现错误 | 无 | 500 | 实现错误 | implmentation error |
| openapi.requestParse.jsonExpected | 内部错误，内部系统交互问题 | 无 | 500 | 请求来源非法 | injected request not expected |
| openapi.requestParse.accessKeyInvalid | 内部错误，内部系统交互问题。 EOP系统转发问题，需求方无需处理。 |
无 | 500 | 非OpenAPI准入的ess key invalid | |
| openapi.requestParse.eopInvalidRejection | 请求格式非法 | 无 | 400 | 请求格式非法 | request should be http POSTed json |
| openapi.requestParse.emptyRequest | 请求为空 | 无 | 400 | 请求为空 | request should not be empty |
| openapi.parameter.xxxx | 无 | 400 | 请求参数错误: xxx | request param error: xxx | |
| openapi.admin.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.userPermission.accessFailed | 无 | 200 | 系统错误 | access internal service failed | |
| openapi.yacos.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.workorder.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.ctyunPlatform.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.charge.fused | 访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| openapi.innerSys.accessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
内部系统间访问结果码：
| errorCode | http status code | description | message |
|---|---|---|---|
| dec.decResourceInfo.accessFailed | 200 | 查询资源池失败 | querying region failed |
| dec.decResourceInfo.dataDamaged | 200 | 资源池信息不符预期 | region info data damaged |
| dec.parameter.xxxx | 200 | 请求参数错误 | request param error |
通用结果码（大驼峰格式）
未细分类通用码：
| errorCode | 说明 | 订单状态相关性说明 | http status code | description | message |
|---|---|---|---|---|---|
| Openapi.Implementation.Error | 服务端实现错误 | 无 | 500 | 实现错误 | implmentation error |
| Openapi.RequestParse.JsonExpected | 内部错误，内部系统交互问题 | 无 | 500 | 请求来源非法 | injected request not expected |
| Openapi.RequestParse.AccessKeyInvalid | 内部错误，内部系统交互问题。 EOP系统转发问题，需求方无需处理。 |
无 | 500 | 非OpenAPI准入的ess key invalid | |
| Openapi.RequestParse.EopInvalidRejection | 请求格式非法 | 无 | 400 | 请求格式非法 | request should be http POSTed json |
| Openapi.RequestParse.EmptyRequest | 请求为空 | 无 | 400 | 请求为空 | request should not be empty |
| Openapi.Parameter.Xxxx | 无 | 400 | 请求参数错误: xxx | request param error: xxx | |
| Openapi.Admin.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.UserPermission.AccessFailed | 无 | 200 | 系统错误 | access internal service failed | |
| Openapi.Yacos.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.Workorder.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.CtyunPlatform.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.Charge.Fused | 访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
| Openapi.InnerSys.AccessFailed | OpenAPI访问内部系统失败 | 无 | 200 | 系统错误 | access internal service failed |
内部系统间访问结果码：
| errorCode | http status code | description | message |
|---|---|---|---|
| Dec.DecResourceInfo.AccessFailed | 200 | 查询资源池失败 | querying region failed |
| Dec.DecResourceInfo.DataDamaged | 200 | 资源池信息不符预期 | region info data damaged |
| Dec.Parameter.Xxxx | 200 | 请求参数错误 | request param error |
资源状态
| 状态 | 说明 |
|---|---|
| unknown | 未知状态 |
| failed | 资源创建或变更失败 |
| starting | 正在启用 |
| started | 已启用 |
| renewed | 已续期 |
| changed | 已变配 |
| refunded | 已退订 |
| expired | 过期 |
| destroyed | 销毁 |
| onDemandChanged | 转按量计费完成 |
| autoOnDemandChanged | 自动转按量计费 |
| cycleBillChanged | 转包周期计费完成 |
| deleted | 逻辑删除 |
