Queries details about the hosts in a dedicated cluster.

Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see What is ApsaraDB for MyBase?

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDedicatedHosts

The operation that you want to perform. Set the value to DescribeDedicatedHosts.

DedicatedHostGroupId String Yes dhg-7a9xxxxxxxx

The ID of the dedicated cluster.

RegionId String No cn-hangzhou

The region ID of the dedicated cluster. You can call the DescribeRegions operation to query the most recent region list.

OrderId Long No 102565235

The ID of the order.

AccessKeyId String No LTAIfCxxxxxxxxxx

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
DedicatedHostGroupId String dhg-7a9xxxxxxxx

The ID of the dedicated cluster.

DedicatedHosts

An array that consists of the hosts in the dedicated cluster.

DedicatedHosts

An array that consists of the hosts in the dedicated cluster.

AllocationStatus String 1

Indicates whether the system allows you to create instances on the host. Valid values:

  • 0: The system does not allow you to create instances on the host.
  • 1: The system allows you to create instances on the host.
CPUAllocationRatio String 200

The CPU overcommitment ratio of the dedicated cluster.

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

The time when the host was created.

DedicatedHostId String i-bpxxxxxxx

The ID of the host.

DiskAllocationRatio String 200

The storage overcommitment ratio of the dedicated cluster.

HostClass String ecs.i2.16xlarge

The specifications of the host.

HostName String testHost1

The name of the host.

HostStatus String 1

The status of the host. Valid values:

  • 0: The host is being created.
  • 1: The host is running.
  • 2: The host is faulty.
  • 3: The host is being replaced.
  • 4: The host is deprecated.
  • 5: The host is being deleted.
  • 6: The host is restarting.
IPAddress String 192.xx.xx.xx

The internal IP address of the host.

InstanceNumber String 4

The total number of instances that are created on the host.

MemAllocationRatio String 90

The maximum memory usage per host in the dedicated cluster.

VPCId String vpc-bpxxxxxxx

The ID of the VPC to which the host belongs.

VSwitchId String vsw-bpxxxxxxx

The ID of the vSwitch associated with the specified VPC.

ZoneId String cn-hangzhou-i

The zone ID of the host.

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

The ID of the request.

Examples

Sample requests


http(s)://rds.aliyuncs.com/?Action=DescribeDedicatedHosts
&DedicatedHostGroupId=dhg-7a9xxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<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 format

{
	"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"
}

Error codes

For a list of error codes, visit the API Error Center.