查询专属云中的云主机列表
接口功能介绍
该接口提供用户多台云主机信息查询功能,用户可以根据此接口的返回值得到多台云主机的部分信息。
接口约束
无
URI
POST /v4/dec/instance/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 888888c8888888e8a8888888ac888888 | |
azName | 否 | String | 可用区名称,您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az2 | |
projectID | 否 | String | 企业项目ID | 0 | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值为10,单页最大记录不超过50 | 10 | |
state | 否 | String | 主机状态,大小写不敏感,参数可选 "active" "shutoff" "expired" | active | |
keyword | 否 | String | 关键字,name、displayName、ID、privateIP对这些字段模糊查询 | instance-01 | |
instanceName | 否 | String | 云主机名称,长度为2~63个字符,精准匹配实例名称 | instance-01 | |
instanceIDList | 否 | String | 云主机ID列表,多台使用英文逗号分割 | 88fsssea-xxxx-88ec-a8bc-88xxxx888fe8,88f888ea-88ff-88ec-a8bc-888888888fe8 | |
securityGroupID | 否 | String | 安全组ID | sg-xxxxxxxx7x | |
vpcID | 否 | String | 虚拟网络ID | vpc-xxx | |
resourceID | 否 | String | 资源ID,长度为32字符 | 9178e00c6fd148a88d4307950a9468df |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
projectID | String | 企业项目ID | 0 | |
azName | String | 可用区名称 | az1 | |
attachedVolume | Array of Strings | 云硬盘ID列表 | ["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"] | |
addresses | Array of Objects | 网络地址信息 | addresses | |
resourceID | String | 云主机资源ID | f88bc88a88a888e8a88bf88888888888 | |
instanceID | String | 云主机ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
displayName | String | 云主机显示名称 | xxx-8888 | |
instanceName | String | 云主机名称 | xxx-8888 | |
osType | Integer | 操作系统类型,取值范围:1: linux,2: windows,3: redhat,4: ubuntu,5: centos,6: oracle | 5 | |
instanceStatus | String | 云主机状态,取值范围:backingup: 备份中,creating: 创建中,expired: 已到期,freezing: 冻结中,rebuild: 重装,restarting: 重启中,running: 运行中,starting: 开机中,stopped: 已关机,stopping: 关机中,error: 错误,snapshotting: 快照创建中 | running | |
expiredTime | String | 到期时间 | 2023-04-19T09:37:53Z | |
availableDay | Integer | 可用(天) | 100 | |
updatedTime | String | 更新时间 | 2022-10-19T09:37:53Z | |
createdTime | String | 创建时间 | 2022-10-19T09:37:53Z | |
zabbixName | String | 监控对象名称 | 8a8fdc88-b8a8-88bb-888f-8b88888c88f8 | |
secGroupList | Array of Objects | 安全组信息 | secGroupList | |
privateIP | String | 内网ipv4地址 | 10.0.0.1 | |
privateIPv6 | String | 内网ipv6址 | 888:8:8c8:8888:bee8:88d8:c8a8:888 | |
networkCardList | Array of Objects | 网卡信息 | networkCardList | |
vipInfoList | Array of Objects | 虚拟IP信息列表 | vipInfoList | |
vipCount | Integer | vip数目 | 1 | |
affinityGroup | Object | 云主机组信息 | affinityGroup | |
image | Object | 镜像信息 | image | |
flavor | Object | 云主机规格信息 | flavor | |
onDemand | Boolean | 付费方式,取值范围:true表示按量付费; false表示包周期 | true | |
vpcName | String | vpc名称 | vpc-xxx | |
vpcID | String | vpc ID | vpc-xxx8xxxxxx | |
fixedIPList | Array of Strings | 内网IP | ["10.0.0.1"] | |
floatingIP | String | 公网IP | 172.16.0.243 | |
subnetIDList | Array of Strings | 子网ID列表 | ["subnet-0yy0yy0yyy"] | |
keypairName | String | 密钥对名称 | keypair-xxx |
表 addresses
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vpcName | String | vpc名称 | vpc-xxxx | |
addressList | Array of Objects | 网络地址列表 | addressList |
表 secGroupList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
securityGroupID | String | 安全组ID | sg-xxxxxxxx7x | |
securityGroupName | String | 安全组名称 | Default-Security-Group |
表 networkCardList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
IPv4Address | String | IPv4地址 | 10.0.0.1 | |
IPv6Address | Array of Strings | IPv6地址列表 | ["888:8:8c8:8888:bee8:88d8:c8a8:888"] | |
subnetID | String | 子网ID | subnet-0yy6yy2yyy | |
subnetCidr | String | 子网网段信息 | 10.0.0.1/24 | |
isMaster | Boolean | 是否主网卡,取值范围:true:主网卡,false:扩展网卡 | true | |
gateway | String | 网关地址 | 192.168.0.1 | |
networkCardID | String | 网卡ID | port-5ttttt9tt8 | |
securityGroup | Array of Strings | 安全组ID列表 | ["sg-xxxxxxxx7x"] |
表 vipInfoList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vipID | String | 虚拟IP的ID | havip-fw1kb30m78 | |
vipAddress | String | 虚拟IP地址 | 192.168.0.58 | |
vipBindNicIP | String | 虚拟IP绑定的网卡对应IPv4地址 | 192.168.0.62 | |
vipBindNicIPv6 | String | 虚拟IP绑定的网卡对应IPv6地址 | 100:1:179:b400:d7ea:3e70:7966:2ba5 | |
nicID | String | 网卡ID | port-omdlwvr4sm |
表 affinityGroup
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policy | String | 云主机组策略 | soft-affinity | |
affinityGroupName | String | 云主机组名称 | group-10274 | |
affinityGroupID | String | 云主机组ID | 682c01af-1eaf-400b-570f-05734a00619d |
表 image
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
imageID | String | 镜像ID | b88888b8-ff88-8888-b88f-8c8fbc888b88 | |
imageName | String | 镜像名称 | CentOS7.5.v1-20210303 |
表 flavor
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorID | String | 规格ID | 8f8ba888-88e8-ea88-ea8b-888888dded88 | |
flavorName | String | 规格名称 | s7.medium.2 | |
flavorCPU | Integer | VCPU | 1 | |
flavorRAM | Integer | 内存 | 2048 | |
gpuType | String | GPU类型,取值范围:T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4,支持类型会随着功能升级增加 | T4 | |
gpuCount | Integer | GPU数目 | 1 | |
gpuVendor | String | GPU名称 | gpx-xxx | |
videoMemSize | Integer | GPU显存大小 | 4 |
表 addressList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
addr | String | IP地址 | 192.168.0.62 | |
version | Integer | IP版本 | 4 | |
type | String | 是否主网卡,取值范围:true:主网卡,false:扩展网卡 | fixed |
请求示例
请求头header
无
请求体body
{
"regionID": "888888c8888888e8a8888888ac888888",
"state":"shutoff"
}
响应示例
{
"returnObj": {
"currentCount": 4,
"totalCount": 4,
"totalPage": 1,
"results": [
{
"azName": "az2",
"resourceID": "dad4a88983b741a3bb7a40cc7080204e",
"expiredTime": null,
"createdTime": "2022-11-28T07:35:49Z",
"updatedTime": "2022-12-27T14:12:45Z",
"projectID": "0",
"attachedVolume": [
"52d7a0c9-4015-4ee3-97a3-2ea52de9337b",
"9678565c-b115-4b8e-8ee5-50393b40b816"
],
"instanceID": "73dc7707-a03a-dc96-31c1-5842dbe5f44e",
"displayName": "S1-2-8-0002",
"instanceName": "S1-2-8-0002",
"osType": 5,
"instanceStatus": "stopped",
"availableDay": 0,
"zabbixName": "73dc7707-a03a-dc96-31c1-5842dbe5f44e",
"privateIP": "192.168.0.18",
"privateIPv6": "",
"vipCount": 0,
"onDemand": true,
"vpcID": "vpc-v0uqqxq1kv",
"vpcName": "vpc-zzzz",
"subnetIDList": [
"subnet-bzdqf5ujby"
],
"fixedIPList": [
"192.168.0.18"
],
"floatingIP": null,
"keypairName": "",
"addresses": [
{
"vpcName": "vpc-zzzz",
"addressList": [
{
"addr": "192.168.0.18",
"version": 4,
"type": "fixed"
}
]
}
],
"secGroupList": [
{
"securityGroupName": "Default-Security-Group",
"securityGroupID": "sg-mu39b23x9z"
}
],
"networkCardList": null,
"vipInfoList": null,
"affinityGroup": null,
"image": {
"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
"imageName": "CentOS7.5.v1-20210303"
},
"flavor": {
"flavorID": "affc0d2a-d24b-0f96-1ea4-843c05fa4abe",
"flavorName": "c6.4xlarge.4",
"flavorCPU": 16,
"flavorRAM": 65536,
"gpuType": null,
"gpuCount": null,
"gpuVendor": null,
"videoMemSize": null
}
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Dec.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Dec.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Dec.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Dec.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Dec.Region.NotSupport | 当前资源池不支持专属云,请确认资源池ID是否有效 |
Openapi.DecWorkorder.AccessFailed | 查询云主机失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.DecCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |