接口功能介绍

通过虚机ID获取虚拟机最新状态，主要获取虚拟机磁盘挂载信息

接口约束

使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2. 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。

URI

POST /v4/ecs/backup-instance-query

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以调用regionID查看最新的天翼云资源池列表	888888c8888888e8a8888888ac888888
projectID	否	String	企业项目ID	0
ID	是	String	云主机ID	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	可用区名称	SERIES-7-ZONE
attachedVolume	Array of Strings	云主机关联的云硬盘列表	["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"]
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: 关机中， master_order_creating: 主订单未完成	running
expiredTime	String	到期时间	2023-04-19T09:37:53Z
availableDay	Integer	可用(天)	176
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	付费方式。取值范围： false：包周期， true：按量付费。	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	密钥对名称
volumes	Object	磁盘信息		volume

表 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表示主网卡， false表示扩展网卡	true
gateway	String	网关地址
nicID	String	网卡ID	port-5ttttt9tt8
securityGroup	Array of Strings	安全组ID列表

表 secGroupList

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

表 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	GPU显存大小	2

表 addressList

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

表 volume

参数	参数类型	说明	示例
is_bootable	Boolean	是否启动盘，取值范围： true：启动盘， false：非启动盘	true
is_encrypted	Boolean	是否加密盘，取值范围： true：已加密， false：未加密	false
is_expired	Boolean	是否过期，取值范围： true：已过期， false：未过期	false
size	Integer	云硬盘大小，单位为GB	40
type	String	云硬盘类型，取值范围： SATA：普通IO SAS：高IO SSD：超高IO SSD-genric：通用型SSD FAST-SSD：极速型SSD
id	String	云硬盘ID	0de747ae-ee9b-4966-bba2-4023803ac62e
name	String	云硬盘名称	vol-test01
status	String	云硬盘状态	in-use

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
	"regionID": "888888c8888888e8a8888888ac888888",
	"projectID": "0",
	"ID": "8a8fdc88-b8a8-88bb-888f-8b88888c88f8"
}

响应示例

{
	"returnObj": {
		"currentCount": 1,
		"totalCount": 1,
		"totalPage": 1,
		"results": [{
			"affinityGroup": null,
			"availableDay": 176,
			"availabilityZone": "az1",
			"addresses": [{
				"vpcName": "vpc-6cd0",
				"addressList": [{
					"version": 4,
					"type": "fixed",
					"addr": "192.168.0.94"
				}]
			}],
			"projectID": "0",
			"image": {
				"imageName": "CentOS7.5.v1-20210303",
				"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08"
			},
			"updatedAt": "2023-01-12T07:  50:  54Z",
			"fixedIP": [
				"192.168.0.94"
			],
			"vpcName": "vpc-6cd0",
			"vipInfoList": null,
			"zabbixName": "41400ab5-562f-5db5-6b7c-8671a3b37786",
			"osType": 5,
			"displayName": "ghy",
			"flavor": {
				"memory": null,
				"vcpu": 1,
				"ram": 1024,
				"gpuCount": null,
				"specName": "s7.small.1",
				"gpuName": null,
				"flavorID": "5622ce59-da34-cb43-ca0d-eef2a51475b3",
				"gpuType": null
			},
			"ID": "41400ab5-562f-5db5-6b7c-8671a3b37786",
			"createdAt": "2023-01-09T03:  23:  57Z",
			"keypairName": "",
			"vmState": "stopped",
			"floatingV6UUID": null,
			"vpcID": "vpc-ttxdh00rjf",
			"attachedVolume": [
				"0de747ae-ee9b-4966-bba2-4023803ac62e",
				"41703f2d-4672-4445-93e1-e4f158c787e1"
			],
			"name": "ghy-3",
			"onDemand": false,
			"floatingIP": "",
			"resourceID": "b4c575fcd760499f8896619630151700",
			"securityGroup": [{
				"securityGroupName": "Default-Security-Group",
				"securityGroupID": "sg-767voa4wxg"
			}],
			"privateIP": "192.168.0.94",
			"privateIPv6": "",
			"expiredTime": "2023-07-09T03:  25:  34Z",
			"subnetIDList": [
				"subnet-ty87lkna06"
			],
			"vipCount": 0,
			"volumes": [{
					"status": "in-use",
					"is_bootable": true,
					"name": "ghy-3-volume_000",
					"id": "0de747ae-ee9b-4966-bba2-4023803ac62e",
					"type": "SATA-public",
					"is_expired": false,
					"is_encrypted": false,
					"size": 40
				},
				{
					"status": "in-use",
					"is_bootable": false,
					"name": "ghy-3-volume-001",
					"id": "41703f2d-4672-4445-93e1-e4f158c787e1",
					"type": "SATA-public",
					"is_expired": false,
					"is_encrypted": false,
					"size": 5
				}
			],
			"nicList": [{
				"IPv4Address": "192.168.0.94",
				"isMaster": true,
				"nicID": "port-durisxbn78",
				"IPv6Address": null,
				"subnetCidr": "192.168.0.0/24",
				"subnetID": "subnet-ty87lkna06",
				"gateway": "192.168.0.1",
				"securityGroup": [
					"sg-767voa4wxg"
				]
			}]
		}]
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码