接口功能介绍

该接口提供用户一台云主机信息查询功能，用户可以根据此接口的返回值了解自己云主机的详细信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
单台查询：当前接口只能查询单台云主机信息，查询多台云主机信息请使用接口查询云主机列表进行查询

接口约束

确保当前请求资源池下，该云主机存在

URI

GET /v4/ecs/instance-details

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	bb9fdb42056f11eda1610242ac110002
instanceID	是	String	云主机ID，您可以查看弹性云主机了解云主机的相关信息获取：查查询云主机列表创创建一台按量付费或包年包月的云主机创批量创建按量付费或包年包月云主机	adc614e0-e838-d73f-0618-a6d51d09070a

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	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列表	["d36d4736-0724-429e-b7b6-dca67a2a0ef5", "b484565c-b5a0-4b30-85cd-3b674991aff0"]
addresses	Array of Objects	网络地址信息		addresses
resourceID	String	云主机资源ID	cde530453f204f47bf32d12e62ef3b23
instanceID	String	云主机ID	c5a7966a-88e7-362b-6e11-c2d8fbfc07ca
displayName	String	云主机显示名称	api-test01
instanceName	String	云主机名称	api-test01
osType	Integer	操作系统类型，取值范围： 1（linux）， 2（windows）， 3（redhat）， 4（ubuntu）， 5（centos）， 6（oracle）	5
instanceStatus	String	云主机状态，取值范围： backuping: 备份中， creating: 创建中， expired: 已到期， freezing: 已冻结， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中， error: 错误， snapshotting: 快照创建中， unsubscribed: 包周期已退订， unsubscribing: 包周期退订中。更多云主机状态请通过状态枚举值查看云主机使用状态	running
expiredTime	String	到期时间	2023-04-19T09:37:53Z
availableDay	Integer	可用天数	120
updatedTime	String	更新时间	2022-10-19T09:37:53Z
createdTime	String	创建时间	2022-10-19T09:37:53Z
zabbixName	String	监控对象名称	c5a7966a-88e7-362b-6e11-c2d8fbfc07ca
secGroupList	Array of Objects	安全组信息		secGroupList
privateIP	String	内网IPv4地址	192.168.1.104
privateIPv6	String	内网IPv6址	100:1:1ec:6600:fb6f:5428:c7e3:fa60
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-test3
vpcID	String	虚拟私有云ID	vpc-jomc98yuqu
fixedIPList	Array of Strings	内网IP列表	["192.168.1.104"]
floatingIP	String	公网IP	117.89.29.150
subnetIDList	Array of Strings	子网ID列表	["subnet-7tk4rmsj4c"]
keypairName	String	密钥对名称	kp-test2
deletionProtection	Boolean	是否开启实例删除保护	true
delegateName	String	委托名称，注：委托绑定目前仅支持多可用区类型资源池，非可用区资源池为空字符串	apiTest01
remainingDay	Integer	距离释放剩余天数	14
releaseTime	String	释放时间	2024-08-22T07:25:34Z
metadata	Map of String	用户自定义元数据，注：仅多可用区类型资源池支持返回，非可用区资源池请调用查询元数据接口获取：查云主机元数据查询	{"ctyun":"good"}

表 addresses

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

表 secGroupList

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

表 networkCardList

参数	参数类型	说明	示例
IPv4Address	String	IPv4地址	192.168.1.104
IPv6Address	Array of Strings	IPv6地址列表	["100:1:1ec:6600:fb6f:5428:c7e3:fa60"]
subnetID	String	子网ID	subnet-0yy6yy2yyy
subnetCidr	String	子网网段信息	10.0.0.1/24
isMaster	Boolean	是否主网卡，取值范围： true（主网卡）， false（扩展网卡）	true
gateway	String	网关地址	192.168.1.1
networkCardID	String	网卡ID	port-10s1q9v9xf
securityGroup	Array of Strings	安全组ID列表	["sg-w3cn7d00a4"]

表 vipInfoList

参数	参数类型	说明	示例
vipID	String	虚拟IP的ID	havip-82g6jjhebo
vipAddress	String	虚拟IP地址	192.168.1.52
vipBindNicIP	String	虚拟IP绑定的网卡对应IPv4地址	192.168.1.104
vipBindNicIPv6	String	虚拟IP绑定的网卡对应IPv6地址	100:1:1ec:6600:fb6f:5428:c7e3:fa60
nicID	String	网卡ID	port-10s1q9v9xf

表 affinityGroup

参数	参数类型	说明	示例
policy	String	云主机组策略	soft-affinity
affinityGroupName	String	云主机组名称	api-test01
affinityGroupID	String	云主机组ID	d1559aad-3932-7ded-cfa6-2871258b1bb5

表 image

参数	参数类型	说明	示例	下级对象
imageID	String	镜像ID	4e5f72c9-fa16-4ae6-b60e-11287edc934c
imageName	String	镜像名称	CentOS7.9 64位

表 flavor

参数	参数类型	说明	示例
flavorID	String	规格ID	c5f17f9c-5cfd-9c87-72dd-152171c9002a
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.1.104
version	Integer	IP版本	4
type	String	网络类型，取值范围： fixed（内网）， floating（弹性公网）	fixed
isMaster	Boolean	网络地址对应网卡是否为主网卡
macAddress	String	网络地址对应网卡的mac地址	macAddress

枚举参数

无

请求示例

请求url

示例：查询一台云主机
在华东1查询一台云主机
GET .../v4/ecs/instance-details?regionID=bb9fdb42056f11eda1610242ac110002&instanceID=c5a7966a-88e7-362b-6e11-c2d8fbfc07ca

请求头header

无

请求体body

无

响应示例

{
	"returnObj": {
		"affinityGroup": {
			"affinityGroupName": "api-test01",
			"affinityGroupID": "d1559aad-3932-7ded-cfa6-2871258b1bb5",
			"policy": "soft-affinity"
		},
		"availableDay": 0,
		"deletionProtection": true,
		"addresses": [{
			"vpcName": "vpc-lhy-02",
			"addressList": [{
				"addr": "192.168.1.104",
				"version": 4,
				"type": "fixed",
				"isMaster": true,
				"macAddress": "fa:16:3e:ef:0e:88"
			}]
		}],
		"updatedTime": "2023-06-26T08:08:56Z",
		"projectID": "0",
		"image": {
			"imageID": "4e5f72c9-fa16-4ae6-b60e-11287edc934c",
			"imageName": "CentOS7.9 64位"
		},
		"secGroupList": [{
			"securityGroupName": "Default-Security-Gr",
			"securityGroupID": "sg-w3cn7d00a4"
		}],
		"vpcName": "vpc-test3",
		"azName": "cn-huadong1-jsnj1A-public-ctcloud",
		"zabbixName": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca",
		"osType": 5,
		"displayName": "api-test01",
		"flavor": {
			"flavorID": "c5f17f9c-5cfd-9c87-72dd-152171c9002a",
			"flavorName": "s7.medium.2",
			"flavorCPU": 1,
			"flavorRAM": 2048,
			"gpuType": null,
			"gpuCount": null,
			"gpuVendor": null,
			"videoMemSize": null
		},
		"networkCardList": [{
			"IPv4Address": "192.168.1.104",
			"IPv6Address": ["100:1:1ec:6600:fb6f:5428:c7e3:fa60"],
			"isMaster": true,
			"subnetCidr": "192.168.1.0/24",
			"networkCardID": "port-10s1q9v9xf",
			"gateway": "192.168.1.1",
			"securityGroup": ["sg-w3cn7d00a4"],
			"subnetID": "subnet-7tk4rmsj4c"
		}],
		"fixedIPList": ["192.168.1.104"],
		"vipCount": 1,
		"keypairName": "kp-test2",
		"instanceStatus": "running",
		"vpcID": "vpc-jomc98yuqu",
		"attachedVolume": ["d36d4736-0724-429e-b7b6-dca67a2a0ef5", "b484565c-b5a0-4b30-85cd-3b674991aff0"],
		"onDemand": true,
		"floatingIP": "221.229.4.4",
		"instanceID": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca",
		"resourceID": "cde530453f204f47bf32d12e62ef3b23",
		"vipInfoList": [{
			"vipID": "havip-82g6jjhebo",
			"vipAddress": "192.168.1.52",
			"vipBindNicIP": "192.168.1.104",
			"vipBindNicIPv6": "100:1:1ec:6600:fb6f:5428:c7e3:fa60",
			"nicID": "port-10s1q9v9xf"
		}],
		"privateIP": "192.168.1.104",
		"privateIPv6": "100:1:1ec:6600:fb6f:5428:c7e3:fa60",
		"expiredTime": null,
		"subnetIDList": ["subnet-7tk4rmsj4c"],
		"createdTime": "2023-06-25T10:01:41Z",
		"instanceName": "api-test01",
        "delegateName": "apiTest01",
        "releaseTime": "2024-08-22T07:25:34Z",
        "remainingDay": 14
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码