接口功能介绍

该接口提供用户多台云主机信息查询功能，用户可以根据此接口的返回值得到多台云主机的部分信息。

接口约束

无

URI

POST /v4/dec/instance-list

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以调用资源池列表查询查看最新a的天翼云资源池列表	bb9fdb42056f11eda161024aac110002
azName	否	String	可用区名称。您可以调用资源池可用区查询获取可用区信息，查询结果中zoneList内返回存在可用区名称（即多可用区，本字段填写实际可用区名称），若查询结果中zoneList为空（即为单可用区，本字段填写default）。	cn-huadong1-jsnj1A-public-ctcloud
projectID	否	String	企业项目ID	0
pageNo	否	Integer	页码，取值范围：大于等于1，默认值为1	1
pageSize	否	Integer	每页记录数目，取值范围:[1~50]，默认值为10，单页最大记录不超过50	10
status	否	String	云主机状态	虚机状态，大小写不敏感，参数可选
keyword	否	String	关键字	name、displayName、ID、privateIP对这些字段模糊查询
instanceIDList	否	String	云主机ID列表，多台则用英文逗号分割	88fsssea-xxxx-88ec-a8bc-88xxxx888fe8,88f888ea-88ff-88ec-a8bc-888888888fe8

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明
message	String	失败时的错误描述，一般为英文描述
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
availabilityZone	String	可用区名称	az1
attachedVolume	Array of Strings	挂载云硬盘列表
addresses	Array of Objects	网络地址信息列表		addresses
resourceID	String	云主机资源ID	f88bc88a88a888e8a88bf88888888888
ID	String	云主机ID	88f888ea-88ff-88ec-a8bc-888888888fe8
displayName	String	云主机显示名称	xxx-8888
name	String	云主机名称	xxx-8888
osType	Integer	操作系统类型，取值范围： 1: linux， 2: windows， 3: redhat， 4: ubuntu， 5: centos， 6: oracle	5
vmState	String	云主机状态，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 冻结中， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中	running
expiredTime	String	到期时间	2023-04-19T09:37:53Z
availableDay	Integer	可用(天)	180
updatedAt	String	更新时间	2022-10-19T09:37:53Z
createdAt	String	创建时间	2022-10-19T09:37:53Z
zabbixName	String	监控对象名称	8a8fdc88-b8a8-88bb-888f-8b88888c88f8
securityGroup	Array of Objects	安全组信息列表		securityGroup
floatingV6UUID	String	弹性IPv6的uuid
privateIP	String	内网IPv4地址	10.0.0.1
privateIPv6	String	内网IPv6址	888:8:8c8:8888:bee8:88d8:c8a8:888
nicList	Array of Objects	网卡信息列表		nicList
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
fixedIP	Array of Strings	内网IP列表
floatingIP	String	公网IP
subnetIDList	Array of Strings	子网ID列表
keypairName	String	密钥对名称

表 addresses

参数	参数类型	说明	示例	下级对象
vpcName	String	vpc名称	vpc-xxxx
addressList	Array of Objects	网络地址列表		addressList

表 securityGroup

参数	参数类型	说明	示例	下级对象
securityGroupID	String	安全组ID	sg-xxxxxxxx7x
securityGroupName	String	安全组名称	Default-Security-Group

表 nicList

参数	参数类型	说明	示例	下级对象
IPv4Address	String	IPv4地址	10.0.0.1
IPv6Address	Array of Strings	IPv6地址列表
subnetID	String	子网ID	subnet-0yy6yy2yyy
subnetCidr	String	子网网段信息	10.0.0.1/24
isMaster	Boolean	是否主网卡	true
gateway	String	网关地址
nicID	String	网卡ID	port-5ttttt9tt8
securityGroup	Array of Strings	安全组ID列表

表 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
specName	String	规格名称	s7.medium.2
vcpu	Integer	VCPU	1
ram	Integer	内存	2048
gpuType	String	GPU类型，取值范围：T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4，支持类型会随着功能升级增加
gpuCount	Integer	GPU数目	1
gpuName	String	GPU名称
momery	Integer	显存大小	4

表 addressList

参数	参数类型	说明	示例	下级对象
addr	String	IP地址	192.168.0.62
version	Integer	IP版本	4
type	String	网络类型，取值范围： fixed表示内网， floating表示公网	fixed

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
	"regionID": "bb9fdb42056f11eda1610242ac110002",
	"azName": "cn-huadong1-jsnj1A-public-ctcloud",
	"projectID": "0",
	"pageNo": 1,
	"pageSize": 10,
	"status": "",
	"keyword": "xxx",
	"name": "xxx-8888",
	"instanceIDList": "8a8fdc88-b8a8-88bb-888f-8b88888c88f8"
}

响应示例

{
	"returnObj": {
		"currentCount": 1,
		"totalCount": 1,
		"totalPage": 1,
		"results": [{
			"affinityGroup": {
				"policy": "soft-affinity",
				"affinityGroupName": "group-10274",
				"affinityGroupID": "682c01af-1eaf-400b-570f-05734a00619d"
			},
			"availableDay": 180,
			"availabilityZone": "SERIES-7-ZONE",
			"addresses": [{
				"vpcName": "vpc-c710",
				"addressList": [{
					"version": 4,
					"type": "fixed",
					"addr": "192.168.0.5"
				}, {
					"version": 6,
					"type": "fixed",
					"addr": "100:1:179:b400:1281:d922:16da:51a9"
				}, {
					"version": 4,
					"type": "floating",
					"addr": "100.124.3.50"
				}]
			}],
			"projectID": "0",
			"image": {
				"imageName": "CentOS7.5.v1-20210303",
				"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08"
			},
			"updatedAt": "2022-10-31T04:42:48Z",
			"fixedIP": ["192.168.0.5"],
			"vpcName": "vpc-c710",
			"vipInfoList": [{
				"vipAddress": "192.168.0.8",
				"vipBindNicIPv6": "100:1:179:b400:1281:d922:16da:51a9",
				"nicID": "port-8aujqrn2yv",
				"vipBindNicIP": "192.168.0.5",
				"vipID": "havip-tb5a8zacx6"
			}],
			"zabbixName": "5ae83d07-0389-22fd-def8-995090ee3d5a",
			"osType": 5,
			"displayName": "ecm-details",
			"flavor": {
				"memory": null,
				"vcpu": 1,
				"ram": 1024,
				"gpuCount": null,
				"specName": "s7.small.1",
				"gpuName": null,
				"flavorID": "5622ce59-da34-cb43-ca0d-eef2a51475b3",
				"gpuType": null
			},
			"ID": "8a8fdc88-b8a8-88bb-888f-8b88888c88f8",
			"createdAt": "2022-10-31T04:38:17Z",
			"vmState": "Stopped",
			"floatingV6UUID": null,
			"vpcID": "vpc-ollez140q8",
			"attachedVolume": ["7337e167-1f9a-4319-9c0f-3b598b85f494", "2012fece-4fd9-4195-a748-fcefc838967a"],
			"name": "xxx-8888",
			"onDemand": false,
			"floatingIP": "100.124.3.50",
			"resourceID": "30e2c994bf454d2e953eed48e637df6b",
			"securityGroup": [{
				"securityGroupID": "sg-h2tk9njxyv",
				"securityGroupName": "Default-Security-Group"
			}],
			"privateIP": "192.168.0.5",
			"privateIPv6": "100:1:179:b400:1281:d922:16da:51a9",
			"expiredTime": "2023-04-30T04:38:17Z",
			"subnetIDList": ["subnet-a9f581ioqd", "subnet-a9f581ioqd"],
			"vipCount": 1,
			"nicList": [{
				"IPv4Address": "192.168.0.5",
				"isMaster": true,
				"nicID": "port-8aujqrn2yv",
				"IPv6Address": ["100:1:179:b400:1281:d922:16da:51a9"],
				"subnetCidr": "192.168.0.0/24",
				"subnetID": "subnet-a9f581ioqd",
				"gateway": "192.168.0.1",
				"securityGroup": ["sg-h2tk9njxyv"]
			}, {
				"IPv4Address": "192.168.0.6",
				"isMaster": false,
				"nicID": "port-sstlnw0s7i",
				"IPv6Address": ["100:1:179:b400:45a6:63a6:d121:9767"],
				"subnetCidr": "192.168.0.0/24",
				"subnetID": "subnet-a9f581ioqd",
				"gateway": "192.168.0.1",
				"securityGroup": ["sg-h2tk9njxyv"]
			}],
			"keypairName": ""
		}]
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考 状态码

错误码

请参考 错误码