DescribeDedicatedHostGroups - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Queries the information about hosts in dedicated clusters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
cddc:DescribeDedicatedHostGroups	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. For more information, see Region IDs.	cn-hangzhou
DedicatedHostGroupId	string	No	The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID. If you leave this parameter empty, the information about all hosts within the region is returned. If you specify a dedicated cluster ID, the information about all hosts in the dedicated cluster within the region is returned.	dhg-872yt76ann7e****
ImageCategory	string	No	The image of the host. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition. WindowsWithMssqlStdLicense: SQL Server Standard Edition. WindowsWithMssqlEntLicense: SQL Server Enterprise Edition. WindowsWithMssqlWebLicense: SQL Server Web Edition. AliLinux: other images.	AliLinux
Engine	string	No	The database engine used to filter hosts. Valid values: MySQL SQL Server PosgreSQL Redis	MySQL

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22E12SD
DedicatedHostGroups	array<object>	The queried hosts.
DedicatedHostGroups	object
DiskAllocateRation	float	The disk allocation rate of the host.	100
DeployType	string	The instance deployment mode of the host.	origin
CreateTime	string	The time when the host was created.	2021-05-07T02:00Z
DedicatedHostCountGroupByHostType	object	The number of hosts by storage type.	2
Text	string	The description of the host.	mysql-host
DedicatedHostGroupId	string	The ID of the dedicated cluster in which the host is created.	dhg-34639v1jt4y4****
DiskUtility	float	The disk usage of the host.	0
MemUsedAmount	float	The amount of used memory.	0
MemAllocatedAmount	float	The amount of memory allocated to the host.	0
CpuAllocationRatio	integer	The CPU overcommit ratio of the host.	200
MemAllocationRatio	integer	The memory overcommit ratio of the host.	100
MemAllocateRation	float	The memory allocation ratio of the host.	9.38
MemUtility	float	The memory usage.	0
CpuAllocatedAmount	float	The number of CPU cores allocated to the host.	3
DedicatedHostGroupDesc	string	The name of the dedicated cluster in which the host is created.	dhg-34639v1jt4y4****
CpuAllocateRation	float	The CPU allocation ratio of the host.	9.38
InstanceNumber	integer	The number of instances deployed on the host.	2
OpenPermission	string	Indicates whether the host OS permissions are granted. Valid values: 0 or 1: no. 2 or 3 (default): yes. Note When you create a dedicated cluster that runs MySQL, SQL Server, or PostgreSQL, you can grant the host OS permissions based on your business requirements.	1
VPCId	string	The virtual private cloud (VPC) ID of the dedicated cluster in which the host is created.	vpc-bp1ov7as4yvz4kxei****
DiskAllocatedAmount	float	The disk storage allocated to the host.	1024
HostNumber	integer	The number of hosts.	2
DiskUsedAmount	float	The disk storage used by the host.	1024
AllocationPolicy	string	The policy that is used to allocate host resources. Valid values: Evenly: The system preferentially deploys database instances on the hosts where no resources or fewer resources are allocated. This maximizes system stability. Intensively: The system preferentially deploys database instances on the hosts that are created earlier and have more allocated resources. This maximizes resource utilization.	Evenly
Engine	string	The database engine of the host.	MySQL
DiskAllocationRatio	integer	The storage overcommit ratio of the host.	200
BastionInstanceId	string	The ID of the primary instance deployed on the host. If no primary instance is deployed on the host, an empty string is returned.	rm-bp15rszyxs4t3****
HostReplacePolicy	string	The policy that is used for host troubleshooting. Valid values: Auto (default): The system automatically replaces faulty hosts. Manual: You must manually replace faulty hosts.	Auto
ZoneIDList	array
ZoneIDList	string	The zones where the hosts are created.	cn-hangzhou-f

Examples

Sample success responses

JSONformat

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E12SD",
  "DedicatedHostGroups": {
    "DedicatedHostGroups": [
      {
        "DiskAllocateRation": 100,
        "DeployType": "origin",
        "CreateTime": "2021-05-07T02:00Z",
        "DedicatedHostCountGroupByHostType": 2,
        "Text": "mysql-host",
        "DedicatedHostGroupId": " dhg-34639v1jt4y4****",
        "DiskUtility": 0,
        "MemUsedAmount": 0,
        "MemAllocatedAmount": 0,
        "CpuAllocationRatio": 200,
        "MemAllocationRatio": 100,
        "MemAllocateRation": 9.38,
        "MemUtility": 0,
        "CpuAllocatedAmount": 3,
        "DedicatedHostGroupDesc": " dhg-34639v1jt4y4****",
        "CpuAllocateRation": 9.38,
        "InstanceNumber": 2,
        "OpenPermission": 1,
        "VPCId": "vpc-bp1ov7as4yvz4kxei****",
        "DiskAllocatedAmount": 1024,
        "HostNumber": 2,
        "DiskUsedAmount": 1024,
        "AllocationPolicy": "Evenly",
        "Engine": "MySQL",
        "DiskAllocationRatio": 200,
        "BastionInstanceId": "rm-bp15rszyxs4t3****",
        "HostReplacePolicy": "Auto",
        "ZoneIDList": {
          "ZoneIDList": [
            "cn-hangzhou-f"
          ]
        },
        "Category": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Permission.NotSupport	You are not authorized to perform this action.	You are not authorized to perform the action.

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

Change history

Change time	Summary of changes	Operation

No change history