接口功能介绍

该接口提供用户一台或多台云主机信息查询功能，用户可以根据此接口的返回值了解自己云主机的详细信息。

接口约束

1. 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。

URI

POST /v4/ecs/details

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表	bb9fdb42056f11eda1610242ac110002
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	云主机状态,虚机状态，大小写不敏感，参数可选 'active' 'shutoff' 'expired'
keyword	否	String	关键字, name、displayName、ID、privateIP 对这些字段模糊查询
name	否	String	云主机名称，精准匹配实例名称	ecs-666
ID	否	String	云主机ID,建议使用instanceIDList,该参数后续将会下线	88f888ea-88ff-88ec-a8bc-888888888fe8
instanceIDList	否	String	云主机ID列表，多体则使用英文逗号分割（如果填写该参数同时填写ID参数，则以该参数为准）	73f321ea-62ff-11ec-a8bc-005056898fe0,88f888ea-88ff-88ec-a8bc-888888888fe8
sgUUID	否	String	安全组ID，模糊匹配	sg-tolywxbe1f
vpcID	否	String	虚拟网络ID	vpc-euu7edo58k

响应参数

参数	参数类型	说明	示例	下级对象
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
availabilityZone	String	可用区名称	az1
attachedVolume	Array of Strings	云硬盘ID列表	['8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88']
addresses	Array of Objects	网络地址信息		addresses
resourceID	String	云主机资源ID	f88bc88a88a888e8a88bf88888888888
ID	String	云主机ID	88f888ea-88ff-88ec-a8bc-888888888fe8
displayName	String	云主机显示名称	ecs-8888
name	String	云主机名称	ecs-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: 关机中， master_order_creating: 主订单未完成	running
expiredTime	String	到期时间	2023-04-19T09:37:53Z
availableDay	Integer	可用(天)	120
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	95af68f5-4d37-e2e5-1cd7-7f58e3f22e47
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-test3
vpcID	String	vpc ID	vpc-euu7edo58k
fixedIP	Array of Strings	内网IP	['10.0.0.1']
floatingIP	String	弹性公网IP	['172.16.0.243']
subnetIDList	Array of Strings	子网ID列表	['subnet-0yy0yy0yyy']
keypairName	String	密钥对名称	kp-test2
deletionProtection	Boolean	实例删除保护参数	true

表 addresses

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

表 securityGroup

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

表 nicList

参数	参数类型	说明	示例	下级对象
IPv4Address	String	IPv4地址	10.0.0.1
IPv6Address	Array of Strings	IPv6地址列表，String列表	['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	网关地址	172.16.0.1
nicID	String	网卡ID	port-6ol6xuzvs8
securityGroup	Array of Strings	安全组ID列表	['sg-tolywxbe1f']

表 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，支持类型会随着功能升级增加	T4
gpuCount	Integer	GPU数目	1
gpuName	String	GPU名称	gpu-x
memory	Integer	GPU显存大小	2

表 addressList

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

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
	"regionID": "bb9fdb42056f11eda1610242ac110002",
	"pageNo": 1,
	"pageSize": 1
}

响应示例

{
	"returnObj": {
		"currentCount": 1,
		"totalCount": 1,
		"totalPage": 1,
		"results": [{
			"projectID": "0",
			"availabilityZone": "cn-huadong1-jsnj1A-public-ctcloud",
			"attachedVolume": ["db09ec12-8e80-4514-8dbd-d1be5a6b5a80", "70a3768d-386e-416c-8abc-fc467e67432c"],
			"addresses": [{
				"vpcName": "openapi-test3",
				"addressList": [{
					"addr": "172.16.0.243",
					"version": 4,
					"type": "fixed"
				}, {
					"addr": "117.89.29.153",
					"version": 4,
					"type": "floating"
				}]
			}],
			"resourceID": "2319ef7d194248a0b02dfed7bcc34fcf",
			"ID": "36fb1e67-c3dc-4297-0fc4-da8bd607b9d1",
			"displayName": "modify-name-2",
			"name": "ctapi-batch-0001",
			"osType": 5,
			"vmState": "stopped",
			"expiredTime": "2023-11-19T08:39:49Z",
			"availableDay": 121,
			"updatedAt": "2023-07-20T02:57:11Z",
			"createdAt": "2023-07-19T08:39:49Z",
			"zabbixName": "36fb1e67-c3dc-4297-0fc4-da8bd607b9d1",
			"securityGroup": [{
				"securityGroupName": "Default-Security-Group",
				"securityGroupID": "sg-tolywxbe1f"
			}],
			"floatingV6UUID": null,
			"privateIP": "172.16.0.243",
			"privateIPv6": "",
			"nicList": [{
				"IPv4Address": "172.16.0.243",
				"IPv6Address": null,
				"isMaster": true,
				"subnetCidr": "172.16.0.0/16",
				"nicID": "port-6ol6xuzvs8",
				"gateway": "172.16.0.1",
				"securityGroup": ["sg-tolywxbe1f"],
				"subnetID": "subnet-y8cofge5uj"
			}],
			"vipInfoList": [],
			"vipCount": 0,
			"affinityGroup": {
				"affinityGroupName": "test-robin",
				"affinityGroupID": "904c9ee7-b0c6-26d9-963a-d15dd0eab35a",
				"policy": "affinity"
			},
			"image": {
				"imageID": "6e95ed90-b8b6-40ee-ae38-d851b6dc35e4",
				"imageName": "CentOS7.8 64位"
			},
			"flavor": {
				"flavorID": "cc5fa4f7-faaf-7f39-a3c3-b763f81ef2b6",
				"specName": "s6.small.1",
				"vcpu": 1,
				"ram": 1024,
				"gpuType": null,
				"gpuCount": null,
				"gpuName": null,
				"memory": null
			},
			"onDemand": false,
			"vpcName": "openapi-test3",
			"vpcID": "vpc-euu7edo58k",
			"subnetIDList": ["subnet-y8cofge5uj"],
			"fixedIP": ["172.16.0.243"],
			"floatingIP": "117.89.29.153",
			"keypairName": "kp-test2"
		}]
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考 状态码

错误码

请参考 错误码