调用DescribeDedicatedHosts接口查询RDS主机组内的主机信息。

主机组功能以集群形式批量管理实例,一个地域创建多个主机组,一个主机组包含多个主机,一个主机包含多个实例。详情请参见主机组简介

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedHosts

系统规定参数。取值:DescribeDedicatedHosts

DedicatedHostGroupId String dhg-7a9xxxxxxxx

主机组ID。

RegionId String cn-hangzhou

地域ID。可以通过接口DescribeRegions查看地域ID。

OrderId Long 102565235

订单ID。

AccessKeyId String LTAIfCxxxxxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
DedicatedHostGroupId String dhg-7a9xxxxxxxx

主机组ID。

DedicatedHosts

主机信息列表。

DedicatedHosts

主机信息列表。

AllocationStatus String 1

主机当前是否允许分配实例。取值:

  • 0:不允许分配
  • 1:允许分配
CPUAllocationRatio String 200

主机组的CPU超配比。

CreatedTime String 2019-10-15 15:44:30.0

主机创建时间。

DedicatedHostId String i-bpxxxxxxx

主机ID。

DiskAllocationRatio String 200

主机组的空间超配比。

HostClass String ecs.i2.16xlarge

主机规格。

HostName String testHost1

主机名称。

HostStatus String 1

主机状态。取值:

  • 0:创建中
  • 1:使用中
  • 2:宕机
  • 3:宕机下线(替换主机中)
  • 4:下线
  • 5:删除
  • 6:重启中
IPAddress String 192.xx.xx.xx

主机内网IP地址。

InstanceNumber String 4

主机上的实例总数。

MemAllocationRatio String 90

主机组中每台主机的内存最大使用率。

VPCId String vpc-bpxxxxxxx

主机所属专有网络VPC ID。

VSwitchId String vsw-bpxxxxxxx

主机所属虚拟交换机ID。

ZoneId String cn-hangzhou-i

主机所在可用区ID。

RequestId String C860658E-68A6-46C1-AF6E-3AE7C4D3CACF

请求ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=DescribeDedicatedHosts
&DedicatedHostGroupId=dhg-7a9xxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDedicatedHostsResponse>
  <DedicatedHosts>
        <DedicatedHosts>
              <DedicatedHostId>i-bpxxxxxxx</DedicatedHostId>
              <HostStatus>1</HostStatus>
              <CreatedTime>2019-10-15 15:44:30.0</CreatedTime>
              <VPCId>vpc-bpxxxxxxx</VPCId>
              <HostClass>ecs.i2.16xlarge</HostClass>
              <IPAddress>192.xx.xx.xx</IPAddress>
              <InstanceNumber>4</InstanceNumber>
              <ZoneId>cn-hangzhou-i</ZoneId>
              <AllocationStatus>1</AllocationStatus>
              <VSwitchId>vsw-bpxxxxxxx</VSwitchId>
              <HostName>testHost1</HostName>
        </DedicatedHosts>
  </DedicatedHosts>
  <RequestId>C860658E-68A6-46C1-AF6E-3AE7C4D3CACF</RequestId>
  <DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
</DescribeDedicatedHostsResponse>

JSON 格式

{
	"DedicatedHosts":{
		"DedicatedHosts":[
			{
				"DedicatedHostId":"i-bpxxxxxxx",
				"HostStatus":"1",
				"CreatedTime":"2019-10-15 15:44:30.0",
				"VPCId":"vpc-bpxxxxxxx",
				"IPAddress":"192.xx.xx.xx",
				"HostClass":"ecs.i2.16xlarge",
				"InstanceNumber":"4",
				"ZoneId":"cn-hangzhou-i",
				"VSwitchId":"vsw-bpxxxxxxx",
				"AllocationStatus":"1",
				"HostName":"testHost1"
			}
		]
	},
	"RequestId":"C860658E-68A6-46C1-AF6E-3AE7C4D3CACF",
	"DedicatedHostGroupId":"dhg-7a9xxxxxxxx"
}

错误码

访问错误中心查看更多错误码。