DescribeDedicatedHostGroups - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Retrieves dedicated host group information for ApsaraDB for MyBase.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cddc:DescribeDedicatedHostGroups

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID. For more information, see Regions.	cn-hangzhou
DedicatedHostGroupId	string	No	Dedicated cluster ID. You can find this ID in the ApsaraDB for MyBase console under Clusters. If you leave this parameter empty, the system returns all dedicated hosts in the specified region. If you specify a dedicated cluster ID, the system returns all dedicated hosts in that cluster within the specified region.	dhg-872yt76ann7e****
ImageCategory	string	No	Host image category. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Always On Enterprise Edition Server Cluster Edition WindowsWithMssqlStdLicense: SQL Server Standard Edition WindowsWithMssqlEntLicense: SQL Server Server Enterprise Edition WindowsWithMssqlWebLicense: SQL Server Web Edition AliLinux: Other host images.	AliLinux
Engine	string	No	Filter dedicated hosts by database engine type. Valid values: MySQL SQL Server PostgreSQL	MySQL

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	D6E068C3-25BC-455A-85FE-45F0B22E12SD
DedicatedHostGroups	object
DedicatedHostGroups	array<object>	Detailed host information.
	array<object>
DiskAllocateRation	number	Disk allocation ratio.	100
DeployType	string	Instance deployment method.	origin
CreateTime	string	Host creation time.	2021-05-07T02:00Z
DedicatedHostCountGroupByHostType	object	The number of hosts for each storage class.	2
Text	string	Host description.	mysql-host
DedicatedHostGroupId	string	Dedicated cluster ID for the host.	dhg-34639v1jt4y4****
DiskUtility	number	Disk utilization.	0
MemUsedAmount	number	Memory usage.	0
MemAllocatedAmount	number	Memory allocation.	0
CpuAllocationRatio	integer	CPU overcommit ratio for the host.	200
MemAllocationRatio	integer	Memory overcommit ratio for the host.	100
MemAllocateRation	number	Allocated memory ratio.	9.38
MemUtility	number	Memory utilization.	0
CpuAllocatedAmount	number	CPU allocation.	3
DedicatedHostGroupDesc	string	Name of the dedicated cluster to which the host belongs.	dhg-34639v1jt4y4****
CpuAllocateRation	number	CPU allocation ratio.	9.38
InstanceNumber	integer	Number of instances on the host.	2
OpenPermission	string	Host OS permission. Valid values: 0 or 1: Disabled 2 or 3 (default): Enabled Note When you create a dedicated cluster with the MySQL, SQL Server, or PostgreSQL database engine, you can choose to enable OS permissions on hosts as needed.	1
VPCId	string	VPC ID of the dedicated cluster to which the host belongs.	vpc-bp1ov7as4yvz4kxei****
DiskAllocatedAmount	number	Disk allocation capacity.	1024
HostNumber	integer	Number of hosts.	2
DiskUsedAmount	number	Disk usage.	1024
AllocationPolicy	string	Host resource allocation policy. Valid values: Evenly: Balanced allocation. Maximizes system stability by allocating resources first to hosts with no allocated resources or fewer allocated resources. Intensively: Compact allocation. Maximizes resource utilization by allocating resources first to older hosts with more allocated resources.	Evenly
Engine	string	Database engine type for the host.	MySQL
DiskAllocationRatio	integer	Disk overcommit ratio for the host.	200
BastionInstanceId	string	Primary instance ID for the host. If no primary instance exists on the host, this value is an empty string.	rm-bp15rszyxs4t3****
HostReplacePolicy	string	Host failure handling policy. Valid values: Auto (default): Automatically replace failed hosts. Manual: Manually replace failed hosts.	Auto
ZoneIDList	object
ZoneIDList	array	List of zones where the host resides.
	string	List of zones where the host resides.	cn-hangzhou-f
Category	string	Dedicated cluster edition. Valid values: Pro: MyBase Dedicated Edition cluster Standard: MyBase Managed Edition cluster	Pro

Examples

Success response

JSON format

{
  "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": "Pro"
      }
    ]
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.