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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:DescribeDedicatedHostGroups | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| DedicatedHostGroupId | string | No | The dedicated cluster ID. | dhg-7a9xxxxxxxx |
| ImageCategory | string | No | The image based on which the hosts in the dedicated clusters are created. Valid values:
| WindowsWithMssqlStdLicense |
Response parameters
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 code | Error code | Error message |
|---|---|---|
| 400 | Forbidden | User not authorized to operate on the specified resource. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-20 | API Description Update. The Error code has changed | View Change Details |
| 2023-06-30 | The Error code has changed | View Change Details |