接口功能介绍

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

准备工作：

构造请求：在调用前需要了解如何构造请求，详情查看构造请求

认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权

接口约束

1.使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测

2.云主机必须存在

URI

GET /v4/ecs/backup/instance-details

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：`查`资源池列表查询	bb9fdb42056f11eda1610242ac110002
instanceID	是	String	云主机ID，您可以查看弹性云主机了解云主机的相关信息获取：`查`查询云主机列表	69aac66c-78e8-e704-e6e1-311b3f40a278

请求参数

请求头header参数

无

请求体body参数

无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	返回参数		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
projectID	String	企业项目id	0
azName	String	可用区名称	cn-huadong1-jsnj1A-public-ctcloud
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	可用(天)	10
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	付费方式。取值范围：false：包周期。true：按量付费。	true
vpcName	String	vpc名称	vpc-xxx
vpcID	String	vpc ID	vpc-xxx8xxxxxx
fixedIP	Array of Strings	内网IP	["10.0.0.1"]
floatingIP	String	公网IP
subnetIDList	Array of Strings	子网ID列表	["subnet-0yy0yy0yyy"]
keypairName	String	密钥对名称	keypair-name1
volumes	Array of Objects	云硬盘信息		volumes

表 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	子网CIDR信息	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名称	gpu-x
videoMemSize	Integer	GPU显存大小	2

表 addressList

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

表 volumes

参数	参数类型	说明	示例
isBootable	Boolean	是否启动盘	true
diskSize	Integer	云硬盘大小，单位为GB	40
diskType	String	云硬盘类型，取值范围：SATA：普通IO，SAS：高IO，SSD：超高IO，SSD-genric：通用型SSD，FAST-SSD：极速型SSD	SATA
diskID	String	云硬盘ID	a691c8f9-6010-47d8-9534-d30c19b1a82c
diskName	String	云硬盘名称	vol-test01

请求示例

请求url

查询云主机详细信息，主要是云主机挂载的磁盘信息
GET '.../v4/ecs/backup/instance-details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=69aac66c-78e8-e704-e6e1-311b3f40a278'

请求头header

无

请求体body

无

响应示例

{
	"returnObj": {
		"affinityGroup": null,
		"availableDay": 294,
		"addresses": [{
			"vpcName": "vpc-6cd0",
			"addressList": [{
				"addr": "192.168.0.48",
				"version": 4,
				"type": "fixed"
			}]
		}],
		"instanceStatus": "running",
		"projectID": "0",
		"image": {
			"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
			"imageName": "CentOS7.5.v1-20210303"
		},
		"secGroupList": [{
		  "securityGroupName": "Default-Security-Group", 
		  "securityGroupID": "sg-767voa4wxg"
		}],
		"vpcName": "vpc-6cd0",
		"azName": "cn-huadong1-jsnj1A-public-ctcloud",
		"zabbixName": "69aac66c-78e8-e704-e6e1-311b3f40a278",
		"osType": 5,
		"displayName": "ghy-e338",
		"fixedIPList": ["192.168.0.48"],
		"networkCardList": [{
			"IPv4Address": "192.168.0.48",
			"IPv6Address": null,
			"isMaster": true,
			"subnetCidr": "192.168.0.0/24",
			"networkCardID": "port-ky542t5wv5",
			"gateway": "192.168.0.1",
			"securityGroup": ["sg-767voa4wxg"],
			"subnetID": "subnet-ty87lkna06"
		}],
		"flavor": {
			"flavorID": "c5f17f9c-5cfd-9c87-72dd-152171c9002a",
			"flavorName": "s7.medium.2",
			"flavorCPU": 1,
			"flavorRAM": 2048,
			"gpuType": null,
			"gpuCount": null,
			"gpuVendor": null,
			"videoMemSize": null
		},
		"vipCount": 0,
		"keypairName": "keypair-name1",
		"updatedTime": "2023-03-10T07:48:30Z",
		"vpcID": "vpc-ttxdh00rjf",
		"attachedVolume": ["a691c8f9-6010-47d8-9534-d30c19b1a82c", "9a37b2d0-7bbf-4047-be1b-f6cf85187105"],
		"onDemand": false,
		"floatingIP": null,
		"instanceID": "69aac66c-78e8-e704-e6e1-311b3f40a278",
		"resourceID": "1c3c5bfac41f45678712e212d84bba06",
		"vipInfoList": null,
		"privateIP": "192.168.0.48",
		"privateIPv6": "",
		"expiredTime": null,
		"subnetIDList": ["subnet-ty87lkna06"],
		"volumes": [{
			"diskName": "ecm-e338-volume_000",
			"diskSize": 40,
			"diskType": "SATA-public",
			"diskID": "a691c8f9-6010-47d8-9534-d30c19b1a82c",
			"isBootable": true
		}, {
			"diskName": "ecm-e338-volume-001",
			"diskSize": 20,
			"diskType": "SATA-public",
			"diskID": "9a37b2d0-7bbf-4047-be1b-f6cf85187105",
			"isBootable": false
		}],
		"createdTime": "2023-03-07T06:55:24Z",
		"instanceName": "ecm-e338"
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

状态码	描述
200	表示请求成功

错误码

errorCode	描述
Openapi.PatternCheck.NotValid	请求参数无效
EcsBackup.WorkOrder.QueryFail	主机备份查询云主机失败
Ecs.Instance.NotFound	未找到对应云主机，请确认云主机ID是否正确
EcsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效

云主机备份

查询云主机信息