DescribeDedicatedHostGroups - API Refrences| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDedicatedHostGroups	The operation that you want to perform. Set the value to DescribeDedicatedHostGroups.
RegionId	String	Yes	cn-hangzhou	The ID of the region. For more information about region IDs, see Region IDs.
DedicatedHostGroupId	String	No	dhg-872yt76ann7e****	The ID of the dedicated cluster. You can view the dedicated cluster ID on the Dedicated Clusters page in the ApsaraDB MyBase console. If this parameter is not specified, the details of all hosts within the region are returned. If a dedicated cluster ID is specified, the details of all hosts in the dedicated cluster within the region are returned.
ImageCategory	String	No	AliLinux	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
Engine	String	No	mysql	The database engine used to filter hosts. Valid values: mysql mssql pgsql

Response parameters


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

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeDedicatedHostGroups
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-872yt76ann7e****
&ImageCategory=ESSD
&Engine=mysql
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D6E068C3-25BC-455A-85FE-45F0B22E12SD",
  "DedicatedHostGroups" : {
    "DiskAllocateRation" : 100,
    "DeployType" : "origin",
    "CreateTime" : "2021-05-07T02:00Z",
    "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" : "cn-hangzhou-f"
  }
}

Error codes


HTTP status code	Error codes	Error message	Description
403	Permission.NotSupport	You are not authorized to perform this action.	The error message returned because you are not authorized to perform this operation.

For a list of error codes, visit the API Error Center.