调用DescribeDedicatedHostGroups接口查询RDS主机组信息。

主机组功能以集群形式批量管理实例,一个地域创建多个主机组,一个主机组包含多个主机,一个主机包含多个实例。详情请参见主机组简介

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedHostGroups

系统规定参数。取值:DescribeDedicatedHostGroups

RegionId String cn-hangzhou

地域ID。可以通过接口DescribeRegions查看可用的地域ID。

DedicatedHostGroupId String dhg-7a9xxxxxxxx

主机组ID。

返回数据

名称 类型 示例值 描述
RequestId String AB44DC0A-7E77-442A-97A9-C6418694CB22

请求ID。

DedicatedHostGroups Array

主机组信息列表。

DedicatedHostGroupId String dhg-7a9xxxxxxxx

主机组ID。

DedicatedHostGroupDesc String testHostGroup

主机组名称。

CpuAllocationRatio Integer 200

主机组的CPU超配比。

MemAllocationRatio Integer 90

主机组中每台主机的内存最大使用率。

DiskAllocationRatio Integer 200

主机组的空间超配比。

AllocationPolicy String Evenly

主机组资源调度的分配策略。取值:

  • Evenly:均衡分配
  • Intensively:紧凑分配
HostReplacePolicy String Auto

主机故障时系统的处理策略。取值:

  • Auto:自动替换主机
  • Manual:手动替换主机
CreateTime String 1571125370000

主机组创建时间的时间戳。

VPCId String vpc-bp1oxxxxxx

主机组所在专有网络VPC ID。

HostNumber Integer 3

主机组内的主机总数。

InstanceNumber Integer 4

主机组内的实例总数。

Engine String MySQL

主机组的引擎。

Text String testHostGroup/dhg-7a9xxxxxxxx

主机组名称和ID信息。由DedicatedHostGroupDesc DedicatedHostGroupId拼接,格式为:DedicatedHostGroupDesc/DedicatedHostGroupId。

DedicatedHostCountGroupByHostType Map dhg_cloud_ssd

主机组主机存储类型。取值:

  • dhg_cloud_ssd:云盘
  • dhg_local_ssd:本地盘
ZoneIDList List cn-hangzhou

主机组主机所在的可用区列表。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDedicatedHostGroups
&RegionId=cn-hangzhou
&DedicatedHostGroupId=dhg-7a9xxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDedicatedHostGroupsResponse>
  <RequestId>E749160D-1FA9-449C-BE4B-CAD795860CD0</RequestId>
  <DedicatedHostGroups>
        <DedicatedHostGroups>
              <DiskAllocationRatio>200</DiskAllocationRatio>
              <AllocationPolicy>Evenly</AllocationPolicy>
              <InstanceNumber>0</InstanceNumber>
              <MemAllocationRatio>90</MemAllocationRatio>
              <VPCId>vpc-bp1oxxxxxx</VPCId>
              <DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
              <HostReplacePolicy>Auto</HostReplacePolicy>
              <CreateTime>1571123846000</CreateTime>
              <Text>testHostGroup/dhg-7a9xxxxxxxx</Text>
              <ZoneIDList>
        </ZoneIDList>
              <DedicatedHostGroupDesc>testHostGroup</DedicatedHostGroupDesc>
              <CpuAllocationRatio>200</CpuAllocationRatio>
              <HostNumber>0</HostNumber>
              <Engine>mysql</Engine>
        </DedicatedHostGroups>
  </DedicatedHostGroups>
</DescribeDedicatedHostGroupsResponse>

JSON 格式

{
	"RequestId": "E749160D-1FA9-449C-BE4B-CAD795860CD0",
	"DedicatedHostGroups": {
		"DedicatedHostGroups": [
			{
				"DiskAllocationRatio": 200,
				"AllocationPolicy": "Evenly",
				"InstanceNumber": 0,
				"MemAllocationRatio": 90,
				"VPCId": "vpc-bp1oxxxxxx",
				"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
				"HostReplacePolicy": "Auto",
				"CreateTime": "1571123846000",
				"Text": "testHostGroup/dhg-7a9xxxxxxxx",
				"ZoneIDList": {
					"ZoneIDList": []
				},
				"DedicatedHostGroupDesc": "testHostGroup",
				"CpuAllocationRatio": 200,
				"HostNumber": 0,
				"Engine": "mysql"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。