You can call the DescribeDedicatedHostGroups operation to query the information about one or more dedicated clusters.
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 MyBase?
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | Query dedicated clusters |
The operation that you want to perform. Set the value to DescribeDedicatedHostGroups. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the dedicated clusters. You can call the DescribeRegions operation to query the most recent region list. |
DedicatedHostGroupId | String | No | dhg-7a9xxxxxxxx |
The ID of the dedicated cluster. |
ImageCategory | String | No | WindowsWithMssqlStdLicense |
The image based on which the hosts in the dedicated clusters are created. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DedicatedHostGroups | Array of DedicatedHostGroups |
An array that consists of dedicated clusters returned. |
|
DedicatedHostGroups | |||
AllocationPolicy | String | Evenly |
The policy based on which the system allocates resources in the dedicated cluster. Valid values:
|
BastionInstanceId | String | bastionhost-cn-m7xxxxxxxx |
The ID of the bastion host. |
CpuAllocateRation | Float | 25 |
The percentage of allocated cores in the dedicated cluster. Unit: %. |
CpuAllocatedAmount | Float | 8 |
The number of allocated cores in the dedicated cluster. |
CpuAllocationRatio | Integer | 200 |
The core overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see Manage a dedicated cluster. |
CreateTime | String | 1571125370000 |
The timestamp when the dedicated cluster was created. |
DedicatedHostCountGroupByHostType | Map | dhg_cloud_ssd |
The type of storage media that is used for the hosts in the dedicated cluster. Valid values:
|
DedicatedHostGroupDesc | String | testHostGroup |
The name of the dedicated cluster. |
DedicatedHostGroupId | String | dhg-7a9xxxxxxxx |
The ID of the dedicated cluster. |
DiskAllocateRation | Float | 0.49 |
The percentage of allocated disk space in the dedicated cluster. Unit: %. |
DiskAllocatedAmount | Float | 200 |
The amount of allocated disk space in the dedicated cluster. Unit: GB. |
DiskAllocationRatio | Integer | 200 |
The disk overcommitment ratio of the dedicated cluster. Unit: %. For more information about the disk overcommitment ratio, see Manage a dedicated cluster. |
DiskUsedAmount | Float | 20 |
The amount of used disk space in the dedicated cluster. Unit: GB. |
DiskUtility | Float | 0 |
The disk usage of the dedicated cluster. Unit: %. |
Engine | String | MySQL |
The database engine that is run on the instances in the dedicated cluster. |
HostNumber | Integer | 3 |
The total number of hosts in the dedicated cluster. |
HostReplacePolicy | String | Auto |
The policy based on which the system handles host failures. Valid values:
|
InstanceNumber | Integer | 4 |
The total number of instances in the dedicated cluster. |
MemAllocateRation | Float | 33.7 |
The percentage of allocated memory space in the dedicated cluster. Unit: %. |
MemAllocatedAmount | Float | 16384 |
The amount of allocated memory space in the dedicated cluster. |
MemAllocationRatio | Integer | 90 |
The memory overcommitment ratio of the dedicated cluster. Unit: %. For more information about the memory overcommitment ratio, see Manage a dedicated cluster. |
MemUsedAmount | Float | 0 |
The amount of used memory space in the dedicated cluster. Unit: MB. |
MemUtility | Float | 0 |
The memory usage of the dedicated cluster. Unit: %. |
OpenPermission | String | 3 |
Indicates whether the operating system permissions of the hosts in the dedicated cluster can be granted. Valid values:
|
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. |
VPCId | String | vpc-bp1oxxxxxx |
The ID of the virtual private cloud (VPC) to which the dedicated cluster belongs. |
ZoneIDList | List | cn-hangzhou |
A list of zones to which the hosts of the dedicated cluster belong. |
RequestId | String | AB44DC0A-7E77-442A-97A9-C6418694CB22 |
The ID of the request. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=DescribeDedicatedHostGroups
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-7a9xxxxxxxx
&<Common request parameters>
Sample success responses
XML
format
<DescribeDedicatedHostGroups>
<RequestId>AB44DC0A-7E77-442A-97A9-C6418694CB22</RequestId>
<DedicatedHostGroups>
<DedicatedHostGroups>
<DiskAllocationRatio>200</DiskAllocationRatio>
<DiskUsedAmount>20</DiskUsedAmount>
<InstanceNumber>4</InstanceNumber>
<AllocationPolicy>Evenly</AllocationPolicy>
<HostReplacePolicy>Auto</HostReplacePolicy>
<DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
<BastionInstanceId>bastionhost-cn-m7xxxxxxxx</BastionInstanceId>
<MemAllocatedAmount>16384</MemAllocatedAmount>
<OpenPermission>3</OpenPermission>
<MemAllocateRation>33.7</MemAllocateRation>
<DiskAllocatedAmount>200</DiskAllocatedAmount>
<Engine>MySQL</Engine>
<MemUtility>0</MemUtility>
<MemAllocationRatio>90</MemAllocationRatio>
<CpuAllocateRation>25</CpuAllocateRation>
<VPCId>vpc-bp1oxxxxxx</VPCId>
<CreateTime>1571125370000</CreateTime>
<Text>testHostGroup/dhg-7a9xxxxxxxx</Text>
<MemUsedAmount>0</MemUsedAmount>
<DedicatedHostGroupDesc>testHostGroup</DedicatedHostGroupDesc>
<DiskUtility>0</DiskUtility>
<CpuAllocationRatio>200</CpuAllocationRatio>
<DiskAllocateRation>0.49</DiskAllocateRation>
<HostNumber>3</HostNumber>
<CpuAllocatedAmount>8</CpuAllocatedAmount>
<DedicatedHostCountGroupByHostType>dhg_cloud_ssd</DedicatedHostCountGroupByHostType>
<ZoneIDList>
<ZoneIDList>cn-hangzhou</ZoneIDList>
</ZoneIDList>
</DedicatedHostGroups>
</DedicatedHostGroups>
</DescribeDedicatedHostGroups>
<DedicatedHostGroups>
<DedicatedHostGroups>
<DiskAllocationRatio>200</DiskAllocationRatio>
<DiskUsedAmount>20</DiskUsedAmount>
<InstanceNumber>4</InstanceNumber>
<AllocationPolicy>Evenly</AllocationPolicy>
<HostReplacePolicy>Auto</HostReplacePolicy>
<DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
<BastionInstanceId>bastionhost-cn-m7xxxxxxxx</BastionInstanceId>
<MemAllocatedAmount>16384</MemAllocatedAmount>
<OpenPermission>3</OpenPermission>
<MemAllocateRation>33.7</MemAllocateRation>
<DiskAllocatedAmount>200</DiskAllocatedAmount>
<Engine>MySQL</Engine>
<MemUtility>0</MemUtility>
<MemAllocationRatio>90</MemAllocationRatio>
<CpuAllocateRation>25</CpuAllocateRation>
<VPCId>vpc-bp1oxxxxxx</VPCId>
<CreateTime>1571125370000</CreateTime>
<Text>testHostGroup/dhg-7a9xxxxxxxx</Text>
<MemUsedAmount>0</MemUsedAmount>
<DedicatedHostGroupDesc>testHostGroup</DedicatedHostGroupDesc>
<DiskUtility>0</DiskUtility>
<CpuAllocationRatio>200</CpuAllocationRatio>
<DiskAllocateRation>0.49</DiskAllocateRation>
<HostNumber>3</HostNumber>
<CpuAllocatedAmount>8</CpuAllocatedAmount>
<DedicatedHostCountGroupByHostType>dhg_cloud_ssd</DedicatedHostCountGroupByHostType>
<ZoneIDList>
<ZoneIDList>cn-hangzhou</ZoneIDList>
</ZoneIDList>
</DedicatedHostGroups>
</DedicatedHostGroups>
</DescribeDedicatedHostGroups>
JSON
format
{
"RequestId": "AB44DC0A-7E77-442A-97A9-C6418694CB22",
"DedicatedHostGroups": {
"DedicatedHostGroups": [{
"DiskAllocationRatio": "200",
"DiskUsedAmount": "20",
"InstanceNumber": "4",
"AllocationPolicy": "Evenly",
"HostReplacePolicy": "Auto",
"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
"BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
"MemAllocatedAmount": "16384",
"OpenPermission": "3",
"MemAllocateRation": "33.7",
"DiskAllocatedAmount": "200",
"Engine": "MySQL",
"MemUtility": "0",
"MemAllocationRatio": "90",
"CpuAllocateRation": "25",
"VPCId": "vpc-bp1oxxxxxx",
"CreateTime": "1571125370000",
"Text": "testHostGroup/dhg-7a9xxxxxxxx",
"MemUsedAmount": "0",
"DedicatedHostGroupDesc": "testHostGroup",
"DiskUtility": "0",
"CpuAllocationRatio": "200",
"DiskAllocateRation": "0.49",
"HostNumber": "3",
"CpuAllocatedAmount": "8",
"DedicatedHostCountGroupByHostType": "dhg_cloud_ssd",
"ZoneIDList": {
"ZoneIDList": "cn-hangzhou"
}
}]
}
}
Error codes
For a list of error codes, visit the API Error Center.