接口功能介绍

查询云主机组内的云主机
可以根据用户给定的云主机组，查询云主机组内云主机的详细信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据

接口约束

确保当前请求资源池下，该云主机组存在（即affinityGroupID真实存在且与regionID相对应）

URI

POST /v4/ecs/affinity-group/list-instance

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：查资源池列表查询	81f7728662dd11ec810800155d307d5b
affinityGroupID	是	String	云主机组ID，获取：查查询云主机组列表或者详情查查询云主机组列表或详情（旧版）创创建云主机组创创建云主机组（旧版）	8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa
pageNo	否	Integer	页码，取值范围：正整数（≥1），注：默认值为1	1
pageSize	否	Integer	每页记录数目，取值范围：[1, 50]，注：默认值为10	10

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）	800
errorCode	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
error	String	错误码，为product.module.code三段式码	Openapi.PatternCheck.NotValid
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
azName	String	可用区名称，您可以查看地域和可用区来了解可用区获取：查资源池可用区查询注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default）	SERIES-7-ZONE
attachedVolume	Array of Strings	云主机挂载的云硬盘列表	["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"]
addresses	Array of Objects	网络地址信息		addresses
resourceID	String	资源ID，非资源的UUID，该ID为订单的资源ID（创建云主机接口为异步接口，订单先返回一个该资源ID方便后续查找）获取：创创建一台按量付费或包年包月的云主机创批量创建按量付费或包年包月云主机	f88bc88a88a888e8a88bf88888888888
instanceID	String	云主机ID，您可以查看弹性云主机了解云主机的相关信息获取：查查询云主机列表创创建一台按量付费或包年包月的云主机创批量创建按量付费或包年包月云主机	88f888ea-88ff-88ec-a8bc-888888888fe8
displayName	String	云主机显示名称，长度为2-63字符	xxx-8888
instanceName	String	云主机名称，不同操作系统下，云主机名称规则有差异。 Windows：长度为2~15个字符，允许使用大小写字母、数字或连字符（-）。不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能仅使用数字；其他操作系统：长度为2-64字符，允许使用点（.）分隔字符成多段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾	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: 快照创建中， unsubscribed: 包周期已退订， unsubscribing: 包周期退订中。更多云主机状态请通过状态枚举值查看云主机使用状态	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	安全组ID列表，您可以查看安全组概述了解安全组相关信息获取：查查询用户安全组列表创创建安全组注：在多可用区类型资源池下，安全组ID通常以“sg-”开头，非多可用区类型资源池安全组ID为uuid格式		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	云主机组ID，获取：查查询云主机组列表或者详情查查询云主机组列表或详情（旧版）创创建云主机组创创建云主机组（旧版）		affinityGroup
image	Object	镜像信息		image
flavor	Object	规格信息		flavor
onDemand	Boolean	购买方式，取值范围： false（按周期）， true（按需）您可以查看计费模式了解云主机的计费模式注：按周期（false）创建云主机需要同时指定cycleCount和cycleType参数	true
vpcName	String	vpc名称	vpc-xxx
vpcID	String	虚拟私有云ID，您可以查看产品定义-虚拟私有云来了解虚拟私有云获取：查查询VPC列表创创建VPC 注：在多可用区类型资源池下，vpcID通常以“vpc-”开头，非多可用区类型资源池vpcID为uuid格式	vpc-xxx8xxxxxx
fixedIPList	Array of Strings	内网IP	["10.0.0.1"]
floatingIP	String	公网IP
subnetIDList	Array of Strings	子网ID列表	["subnet-0yy0yy0yyy"]
keypairName	String	密钥对名称。满足以下规则：只能由数字、字母、-组成，不能以数字和-开头、以-结尾，且长度为2-63字符

表 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	子网网段信息	10.0.0.1/24
isMaster	Boolean	是否主网卡，取值范围： true（表示主网卡）， false（表示扩展网卡）注：只能含有一个主网卡	true
gateway	String	网关地址
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

参数	参数类型	说明	示例
affinityGroupPolicy	String	云主机组策略	soft-affinity
affinityGroupName	String	云主机组名称，满足以下规则：长度在2～63个字符，只能由数字、英文字母、中划线-、下划线_、点.组成	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	内存大小，单位为GB	2048
gpuType	String	GPU类型，取值范围：T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4，支持类型会随着功能升级增加
gpuCount	Integer	GPU数目	1
gpuVendor	String	GPU名称
videoMemSize	Integer	显存大小	2048

表 addressList

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

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
    "regionID": "81f7728662dd11ec810800155d307d5b",
    "affinityGroupID": "d0bfd23a-xxxxx-34570f30072e"
}

响应示例

{
	"returnObj": {
		"currentCount": 1,
		"totalCount": 1,
		"totalPage": 1,
		"results": [{
			"azName": "az3",
			"resourceID": "1c3c5bfac41f45678712e212d84bba06",
			"expiredTime": "2023-04-07T06:55:24Z",
			"createdTime": "2023-03-07T06:55:24Z",
			"updatedTime": "2023-03-10T05:11:52Z",
			"projectID": "0",
			"attachedVolume": ["a691c8f9-6010-47d8-9534-d30c19b1a82c", "9a37b2d0-7bbf-4047-be1b-f6cf85187105"],
			"instanceID": "69aac66c-78e8-e704-e6e1-311b3f40a278",
			"displayName": "ecm-e338",
			"instanceName": "ecm-e338",
			"osType": 5,
			"instanceStatus": "running",
			"availableDay": 10,
			"zabbixName": "69aac66c-78e8-e704-e6e1-311b3f40a278",
			"privateIP": "192.168.0.48",
			"privateIPv6": "",
			"vipCount": 0,
			"onDemand": false,
			"vpcID": "vpc-ttxdh00rjf",
			"vpcName": "vpc-6cd0",
			"subnetIDList": ["subnet-ty87lkna06"],
			"fixedIPList": ["192.168.0.48"],
			"floatingIP": null,
			"keypairName": "",
			"addresses": [{
				"vpcName": "vpc-6cd0",
				"addressList": [{
					"addr": "192.168.0.48",
					"version": 4,
					"type": "fixed"
				}]
			}],
			"secGroupList": [{
				"securityGroupName": "default",
                "securityGroupID": "8a3a3d53-6b7d-4211-b8dc-e841e48c5566"
			}],
			"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"
			}],
			"vipInfoList": [],
			"affinityGroup": {
				"affinityGroupName": "ag-02", 
				"affinityGroupID": "a27e8e84-bb16-4239-9898-78093735648d", 
				"affinityGroupPolicy": "anti-affinity"
            },
			"image": {
				"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
				"imageName": "CentOS7.5.v1-20210303"
			},
			"flavor": {
				"flavorID": "22c0e50e-7df9-7be9-6d7c-7d75ee1189c7",
				"flavorName": "s2.small.1",
				"flavorCPU": 1,
				"flavorRAM": 1024,
				"gpuType": null,
				"gpuCount": null,
				"gpuVendor": null,
				"videoMemSize": null
			}
		}]
	},
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码