接口功能介绍
根据regionID查询用户已有资源
接口约束
保证输入的资源池id准确无误
URI
GET /v4/region/customerResources
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码。为空表示成功。 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 错误码，为product.module.code三段式码。请求成功时不返回该字段 | Unknown.Parameter.InvalidRegionID |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resources | Object | 资源信息 | resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| VM | Object | 云主机 | VM | |
| Volume | Object | 磁盘 | Volume | |
| VOLUME_SNAPSHOT | Object | 磁盘快照 | VOLUME_SNAPSHOT | |
| VPC | Object | VPC | VPC | |
| Public_IP | Object | 公网IP | Public_IP | |
| BMS | Object | 物理机 | BMS | |
| NAT | Object | NAT | NAT | |
| Disk_Backup | Object | 磁盘备份 | Disk_Backup | |
| Vm_Group | Object | 云主机组 | Vm_Group | |
| SNAPSHOT | Object | 云主机快照 | SNAPSHOT | |
| ACLLIST | Object | ACL | ACLLIST | |
| IP_POOL | Object | 共享带宽 | IP_POOL | |
| IMAGE | Object | 私有镜像 | IMAGE | |
| LB_LISTENER | Object | 负载均衡监听器 | LB_LISTENER | |
| LOADBALANCER | Object | 负载均衡 | LOADBALANCER | |
| OS_Backup | Object | 操作系统备份 | OS_Backup | |
| TrafficMirror_Flow | Object | 镜像流量 | TrafficMirror_Flow | |
| TrafficMirror_Filter | Object | 镜像流量 | TrafficMirror_Filter | |
| CBR | Object | 云主机备份 | CBR | |
| CERT | Object | 负载均衡证书 | CERT | |
| CBR_VBS | Object | 磁盘存储备份 | CBR_VBS |
表 VM
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vm_shutd_count | Integer | 已关机云主机数量 | 0 | |
| expire_count | Integer | 过期云主机数量 | 0 | |
| expire_running_count | Integer | 已过期的运行中云主机数量 | 0 | |
| expire_shutd_count | Integer | 已过期的关机云主机数量 | 0 | |
| vm_running_count | Integer | 运行中云主机数量 | 0 | |
| total_count | Integer | 云主机总数 | 0 | |
| cpu_count | Integer | CPU总数 | 0 | |
| memory_count | Integer | 总内存大小 | 0 | |
| detail_total_count | Integer | 云主机总数 | 0 |
表 Volume
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vo_root_count | Integer | 系统盘数量 | 0 | |
| vo_disk_count | Integer | 数据盘数量 | 0 | |
| total_count | Integer | 磁盘总数 | 0 | |
| detail_total_count | Integer | 磁盘总数 | 0 | |
| total_size | Integer | 磁盘总大小 | 0 | |
| vo_disk_size | Integer | 数据盘大小 | 0 | |
| vo_root_size | Integer | 系统盘大小 | 0 |
表 VOLUME_SNAPSHOT
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 磁盘快照总数 | 0 | |
| detail_total_count | Integer | 磁盘快照总数 | 0 |
表 VPC
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | VPC总数 | 0 | |
| detail_total_count | Integer | VPC总数 | 0 |
表 Public_IP
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 公网IP总数 | 0 | |
| detail_total_count | Integer | 公网IP总数 | 0 |
表 BMS
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 物理机总数 | 0 | |
| detail_total_count | Integer | 物理机总数 | 0 | |
| memory_count | Integer | 固定为0 | 0 | |
| cpu_count | Integer | 固定为0 | 0 | |
| bm_shutd_count | Integer | 固定为0 | 0 | |
| expire_running_count | Integer | 固定为0 | 0 | |
| bm_running_count | Integer | 固定为0 | 0 | |
| expire_count | Integer | 固定为0 | 0 | |
| expire_shutd_count | Integer | 固定为0 | 0 |
表 NAT
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | nat总数 | 0 | |
| detail_total_count | Integer | nat总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 Disk_Backup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 磁盘备份总数 | 0 | |
| detail_total_count | Integer | 磁盘备份总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 CBR_VBS
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 磁盘存储备份总数 | 0 | |
| detail_total_count | Integer | 磁盘存储备份总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 CBR
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 云主机备份总数 | 0 | |
| detail_total_count | Integer | 云主机备份总数 | 0 | |
| total_size | Integer | 云主机备份总大小 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 OS_Backup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 固定为0 | 0 | |
| detail_total_count | Integer | 固定为0 | 0 |
表 CERT
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 负载均衡证书总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 LOADBALANCER
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 负载均衡总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 LB_LISTENER
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 负载均衡监听器总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 IP_POOL
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 共享带宽总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 IMAGE
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 私有镜像总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 ACLLIST
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | ACL总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 SNAPSHOT
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 云主机快照总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
表 Vm_Group
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total_count | Integer | 云主机组总数 | 0 | |
| detail | Object | 对应资源池id下的数量 |
枚举参数
无
请求示例
请求url
/v4/region/customerResources?regionID=a4e1e8ca370a11ec9d650242ac11000a
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"resources": {
"VOLUME_SNAPSHOT": {
"total_count": 14,
"detail_total_count": 14
},
"Vm_Group": {
"total_count": 256,
"detail": {
"81f7728662dd11ec810800155d307d5b": 256
}
},
"ACLLIST": {
"total_count": 5,
"detail": {
"81f7728662dd11ec810800155d307d5b": 5
}
},
"NAT": {
"total_count": 0,
"detail_total_count": 0,
"detail": {
"81f7728662dd11ec810800155d307d5b": 0
}
},
"IP_POOL": {
"total_count": 9,
"detail": {
"81f7728662dd11ec810800155d307d5b": 9
}
},
"Public_IP": {
"total_count": 197,
"detail_total_count": 197
},
"IMAGE": {
"total_count": 3,
"detail": {
"81f7728662dd11ec810800155d307d5b": 3
}
},
"Volume": {
"vo_root_size": 8097,
"vo_disk_count": 179,
"total_size": 21887,
"vo_disk_size": 13790,
"detail_total_count": 516,
"total_count": 516,
"vo_root_count": 337
},
"BMS": {
"memory_count": 0,
"total_count": 12,
"detail_total_count": 12,
"cpu_count": 0,
"bm_shutd_count": 0,
"expire_running_count": 0,
"bm_running_count": 0,
"expire_count": 0,
"expire_shutd_count": 0
},
"SNAPSHOT": {
"total_count": 4,
"detail": {
"81f7728662dd11ec810800155d307d5b": 4
}
},
"LB_LISTENER": {
"total_count": 5,
"detail": {
"81f7728662dd11ec810800155d307d5b": 5
}
},
"Disk_Backup": {
"total_count": 8,
"detail_total_count": 8,
"detail": {
"81f7728662dd11ec810800155d307d5b": 8
}
},
"LOADBALANCER": {
"total_count": 13,
"detail": {
"81f7728662dd11ec810800155d307d5b": 13
}
},
"VPC": {
"total_count": 75,
"detail_total_count": 75
},
"VM": {
"vm_shutd_count": 25,
"memory_count": 731,
"expire_count": 7,
"detail_total_count": 377,
"cpu_count": 477,
"expire_running_count": 6,
"total_count": 377,
"expire_shutd_count": 1,
"vm_running_count": 298
},
"OS_Backup": {
"total_size": 0,
"detail_total_count": 0
},
"TrafficMirror_Flow": {
"total_count": 0,
"detail": {
"81f7728662dd11ec810800155d307d5b": 0
}
},
"TrafficMirror_Filter": {
"total_count": 0,
"detail": {
"81f7728662dd11ec810800155d307d5b": 0
}
},
"CBR": {
"total_size": 100,
"total_count": 1,
"detail_total_count": 1,
"detail": {
"81f7728662dd11ec810800155d307d5b": 1
}
},
"CERT": {
"total_count": 2,
"detail": {
"81f7728662dd11ec810800155d307d5b": 2
}
},
"az_display_name": "",
"CBR_VBS": {
"total_count": 2,
"detail_total_count": 2,
"detail": {
"81f7728662dd11ec810800155d307d5b": 2
}
}
}
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
