用户已有资源查询
接口功能介绍
根据regionID查询用户已有资源
接口约束
保证输入的资源池id准确无误
请求定义
URI
GET /v4/region/customer-resources
路径参数
无
请求Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求Json Body参数
无
请求header参数
无
响应定义
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码('800为成功,900为失败) ,默认值:800 | 800 |
errorCode | 是 | String | 错误码,为product.module.code三段式码。为空表示成功。 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | |
returnObj | 是 | Object | 返回参数 |
returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
resources | 是 | Object | 资源信息 |
resources
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
VM | 否 | Object | 云主机 | |
Volume | 否 | Object | 磁盘 | |
VOLUME_SNAPSHOT | 否 | Object | 磁盘快照 | |
VPC | 否 | Object | VPC | |
Public_IP | 否 | Object | 公网IP | |
BMS | 否 | Object | 物理机 | |
NAT | 否 | Object | NAT | |
Disk_Backup | 否 | Object | 磁盘备份 | |
Vm_Group | 否 | Object | 云主机组 | |
SNAPSHOT | 否 | Object | 云主机快照 | |
ACLLIST | 否 | Object | ACL | |
IP_POOL | 否 | Object | 共享带宽 | |
IMAGE | 否 | Object | 私有镜像 | |
LB_LISTENER | 否 | Object | 负载均衡监听器 | |
LOADBALANCER | 否 | Object | 负载均衡 | |
OS_Backup | 否 | Object | 操作系统备份 | |
TrafficMirror_Flow | 否 | Object | ||
TrafficMirror_Filter | 否 | Object | ||
CBR | 否 | Object | 云主机备份 | |
CERT | 否 | Object | 负载均衡证书 | |
CBR_VBS | 否 | Object | 磁盘存储备份 |
VM
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
vm_shutd_count | 否 | Integer | 已关机云主机数量 | |
expire_count | 否 | Integer | 过期云主机数量 | |
expire_running_count | 否 | Integer | 已过期的运行中云主机数量 | |
expire_shutd_count | 否 | Integer | 已过期的关机云主机数量 | |
vm_running_count | 否 | Integer | 运行中云主机数量 | |
total_count | 否 | Integer | 云主机总数 | |
cpu_count | 否 | Integer | CPU总数 | |
memory_count | 否 | Integer | 总内存大小 | |
detail_total_count | 否 | Integer | 云主机总数 |
Volume
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
vo_root_count | 否 | Integer | 系统盘数量 | |
vo_disk_count | 否 | Integer | 数据盘数量 | |
total_count | 否 | Integer | 磁盘总数 | |
detail_total_count | 否 | Integer | 磁盘总数 | |
total_size | 否 | Integer | 磁盘总大小 | |
vo_disk_size | 否 | Integer | 数据盘大小 | |
vo_root_size | 否 | Integer | 系统盘大小 |
VOLUME_SNAPSHOT
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 磁盘快照总数 | |
detail_total_count | 否 | Integer | 磁盘快照总数 |
VPC
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | VPC总数 | |
detail_total_count | 否 | Integer | VPC总数 |
Public_IP
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 公网IP总数 | |
detail_total_count | 否 | Integer | 公网IP总数 |
BMS
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 物理机总数 | |
detail_total_count | 否 | Integer | 物理机总数 | |
memory_count | 否 | Integer | 固定为0 | |
cpu_count | 否 | Integer | 固定为0 | |
bm_shutd_count | 否 | Integer | 固定为0 | |
expire_running_count | 否 | Integer | 固定为0 | |
bm_running_count | 否 | Integer | 固定为0 | |
expire_count | 否 | Integer | 固定为0 | |
expire_shutd_count | 否 | Integer | 固定为0 |
NAT
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | nat总数 | |
detail_total_count | 否 | Integer | nat总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
Disk_Backup
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 磁盘备份总数 | |
detail_total_count | 否 | Integer | 磁盘备份总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
CBR_VBS
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 磁盘存储备份总数 | |
detail_total_count | 否 | Integer | 磁盘存储备份总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
CBR
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 云主机备份总数 | |
detail_total_count | 否 | Integer | 云主机备份总数 | |
total_size | 否 | Integer | 云主机备份总大小 | |
detail | 否 | Object | 对应资源池id下的数量 |
OS_Backup
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 固定为0 | |
detail_total_count | 否 | Integer | 固定为0 |
CERT
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 负载均衡证书总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
LOADBALANCER
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 负载均衡总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
LB_LISTENER
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 负载均衡监听器总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
IP_POOL
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 共享带宽总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
IMAGE
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 私有镜像总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
ACLLIST
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | ACL总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
SNAPSHOT
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 云主机快照总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
Vm_Group
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
total_count | 否 | Integer | 云主机组总数 | |
detail | 否 | Object | 对应资源池id下的数量 |
请求示例
请求头header
请求体body
{
"regionID": "a4e1e8ca370a11ec9d650242ac11000a"
}
响应示例
成功响应示例
{
"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
}
失败响应示例
{
"statusCode": 900,
"errorCode": "Region.RegionInfo.AccessFailed",
"message": "query region info failed",
"description": "访问资源池信息失败"
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 含义 |
---|---|
Region.RegionInfo.AccessFailed | 资源池访问失败 |