All Products
Search
Document Center

ApsaraDB RDS:DescribeDedicatedHostGroups

Last Updated:Mar 22, 2024

Queries information about an ApsaraDB MyBase dedicated cluster.

Operation description

Dedicated clusters allow you to manage a number of instances in a cluster 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDedicatedHostGroupsREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
DedicatedHostGroupIdstringNo

The dedicated cluster ID.

dhg-7a9xxxxxxxx
ImageCategorystringNo

The image based on which the hosts in the dedicated clusters are created. Valid values:

  • WindowsWithMssqlStdLicense: a Windows image that contains the licenses of SQL Server Standard Edition
  • WindowsWithMssqlEntLisence: a Windows image that contains the licenses of SQL Server Enterprise Edition
  • WindowsWithMssqlWebLisence: a Windows image that contains the licenses of SQL Server Web Edition
  • AliLinux: a Linux image
WindowsWithMssqlStdLicense

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

AB44DC0A-7E77-442A-97A9-C6418694CB22
DedicatedHostGroupsobject []

The information about dedicated clusters returned.

DiskAllocateRationfloat

The percentage of allocated disk space in the dedicated cluster. Unit: %.

0.49
CreateTimestring

The timestamp when the dedicated cluster was created.

1571125370000
DedicatedHostCountGroupByHostTypeobject

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

  • dhg_cloud_ssd: cloud disks
  • dhg_local_ssd: local disks
dhg_cloud_ssd
Textstring

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

testHostGroup/dhg-7a9xxxxxxxx
DedicatedHostGroupIdstring

The ID of the dedicated cluster.

dhg-7a9xxxxxxxx
DiskUtilityfloat

The disk usage of the dedicated cluster. Unit: %.

0
MemUsedAmountfloat

The amount of used memory space in the dedicated cluster. Unit: MB.

0
MemAllocatedAmountfloat

The amount of allocated memory space in the dedicated cluster.

16384
CpuAllocationRatiointeger

The core overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see Manage a dedicated cluster.

200
MemAllocationRatiointeger

The memory overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see Manage a dedicated cluster.

90
MemUtilityfloat

The memory usage of the dedicated cluster. Unit: %.

0
MemAllocateRationfloat

The percentage of allocated memory space in the dedicated cluster. Unit: %.

33.7
CpuAllocatedAmountfloat

The number of allocated cores in the dedicated cluster.

8
DedicatedHostGroupDescstring

The name of the dedicated cluster.

testHostGroup
CpuAllocateRationfloat

The percentage of allocated cores in the dedicated cluster. Unit: %.

25
InstanceNumberinteger

The total number of instances in the dedicated cluster.

4
OpenPermissionstring

Indicates whether the feature that allows you to have the OS permissions on the host is enabled. Valid values:

  • 0 or null: The permissions cannot be granted.
  • 1: The permissions can be granted.
  • 3: The permissions have been granted.
3
VPCIdstring

The ID of the virtual private cloud (VPC) to which the dedicated cluster belongs.

vpc-bp1oxxxxxx
DiskAllocatedAmountfloat

The amount of allocated disk space in the dedicated cluster. Unit: GB.

200
HostNumberinteger

The total number of hosts in the dedicated cluster.

3
DiskUsedAmountfloat

The amount of used disk space in the dedicated cluster. Unit: GB.

20
AllocationPolicystring

The policy based on which the system allocates 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.
Evenly
Enginestring

The database engine of the instances in the dedicated cluster.

MySQL
DiskAllocationRatiointeger

The disk overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see Manage a dedicated cluster.

200
BastionInstanceIdstring

The ID of the bastion host.

bastionhost-cn-m7xxxxxxxx
HostReplacePolicystring

The policy that is used to handle host failures. Valid values:

  • Auto: The system automatically replaces faulty hosts.
  • Manual: You must manually replace faulty hosts.
Auto
ZoneIDListarray

The zones to which the hosts of the dedicated cluster belong.

string

The zones to which the hosts of the dedicated cluster belong.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "AB44DC0A-7E77-442A-97A9-C6418694CB22",
  "DedicatedHostGroups": {
    "DedicatedHostGroups": [
      {
        "DiskAllocateRation": 0.49,
        "CreateTime": "1571125370000",
        "DedicatedHostCountGroupByHostType": {
          "test": "test",
          "test2": 1
        },
        "Text": "testHostGroup/dhg-7a9xxxxxxxx",
        "DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
        "DiskUtility": 0,
        "MemUsedAmount": 0,
        "MemAllocatedAmount": 16384,
        "CpuAllocationRatio": 200,
        "MemAllocationRatio": 90,
        "MemUtility": 0,
        "MemAllocateRation": 33.7,
        "CpuAllocatedAmount": 8,
        "DedicatedHostGroupDesc": "testHostGroup",
        "CpuAllocateRation": 25,
        "InstanceNumber": 4,
        "OpenPermission": "3",
        "VPCId": "vpc-bp1oxxxxxx",
        "DiskAllocatedAmount": 200,
        "HostNumber": 3,
        "DiskUsedAmount": 20,
        "AllocationPolicy": "Evenly",
        "Engine": "MySQL",
        "DiskAllocationRatio": 200,
        "BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
        "HostReplacePolicy": "Auto",
        "ZoneIDList": {
          "ZoneIDList": [
            "cn-hangzhou"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400ForbiddenUser not authorized to operate on the specified resource.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-30The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
    Added Error Codes: 400