Queries details about 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 DescribeDedicatedHostGroups

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

RegionId String Yes cn-hangzhou

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

DedicatedHostGroupId String No dhg-7a9xxxxxxxx

The ID of the dedicated cluster.

Response parameters

Parameter Type Example Description
RequestId String AB44DC0A-7E77-442A-97A9-C6418694CB22

The ID of the request.

DedicatedHostGroups Array

An array that consists of the information about the dedicated cluster.

DedicatedHostGroupId String dhg-7a9xxxxxxxx

The ID of the dedicated cluster.

DedicatedHostGroupDesc String testHostGroup

The name of the dedicated cluster.

CpuAllocationRatio Integer 200

The CPU overcommitment ratio of the dedicated cluster.

MemAllocationRatio Integer 90

The maximum memory usage per host in the dedicated cluster.

DiskAllocationRatio Integer 200

The storage overcommitment ratio of the dedicated cluster.

AllocationPolicy String Evenly

The policy based on which the system allocates the resources in the dedicated cluster. Valid values:

  • Evenly: The system evenly allocates the resources to all the hosts in the dedicated cluster.
  • Intensively: The system preferentially allocates the resources to the heavily loaded hosts in the dedicated cluster.
HostReplacePolicy String Auto

The policy based on which the system handles host failures. Valid values:

  • Auto: The system automatically replaces faulty hosts.
  • Manual: You must manually replace faulty hosts.
CreateTime String 1571125370000

The time when the dedicated cluster was created.

VPCId String vpc-bp1oxxxxxx

The ID of the VPC to which the dedicated cluster belongs.

HostNumber Integer 3

The number of hosts in the dedicated cluster.

InstanceNumber Integer 4

The number of instances in the dedicated cluster.

Engine String MySQL

The database engine that is used for the dedicated cluster.

Text String testHostGroup/dhg-7a9xxxxxxxx

The name and ID of the dedicated cluster. The value of this parameter consists of two parts: the value of the DedicatedHostGroupDesc parameter and the value of the DedicatedHostGroupId parameter. Format: DedicatedHostGroupDesc/DedicatedHostGroupId.

DedicatedHostCountGroupByHostType Map dhg_cloud_ssd

The type of storage media that is used for the dedicated cluster. Valid values:

  • dhg_cloud_ssd: standard or enhanced SSD
  • dhg_local_ssd: local SSD
ZoneIDList List cn-hangzhou

An array that consists of the zones to which the hosts in the dedicated cluster belong.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDedicatedHostGroupsResponse>
  <RequestId>E749160D-1FA9-449C-BE4B-CAD795860CD0</RequestId>
  <DedicatedHostGroups>
        <DedicatedHostGroups>
              <DiskAllocationRatio>200</DiskAllocationRatio>
              <AllocationPolicy>Evenly</AllocationPolicy>
              <InstanceNumber>0</InstanceNumber>
              <MemAllocationRatio>90</MemAllocationRatio>
              <VPCId>vpc-bp1oxxxxxx</VPCId>
              <DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
              <HostReplacePolicy>Auto</HostReplacePolicy>
              <CreateTime>1571123846000</CreateTime>
              <Text>testHostGroup/dhg-7a9xxxxxxxx</Text>
              <ZoneIDList>
        </ZoneIDList>
              <DedicatedHostGroupDesc>testHostGroup</DedicatedHostGroupDesc>
              <CpuAllocationRatio>200</CpuAllocationRatio>
              <HostNumber>0</HostNumber>
              <Engine>mysql</Engine>
        </DedicatedHostGroups>
  </DedicatedHostGroups>
</DescribeDedicatedHostGroupsResponse>

JSON format

{
	"RequestId": "E749160D-1FA9-449C-BE4B-CAD795860CD0",
	"DedicatedHostGroups": {
		"DedicatedHostGroups": [
			{
				"DiskAllocationRatio": 200,
				"AllocationPolicy": "Evenly",
				"InstanceNumber": 0,
				"MemAllocationRatio": 90,
				"VPCId": "vpc-bp1oxxxxxx",
				"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
				"HostReplacePolicy": "Auto",
				"CreateTime": "1571123846000",
				"Text": "testHostGroup/dhg-7a9xxxxxxxx",
				"ZoneIDList": {
					"ZoneIDList": []
				},
				"DedicatedHostGroupDesc": "testHostGroup",
				"CpuAllocationRatio": 200,
				"HostNumber": 0,
				"Engine": "mysql"
			}
		]
	}
}

Error codes

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