调用DescribeDedicatedHostGroups接口查询RDS专属集群信息。

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

调试

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

请求参数

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

系统规定参数。取值:DescribeDedicatedHostGroups

RegionId String cn-hangzhou

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

DedicatedHostGroupId String dhg-7a9xxxxxxxx

专属集群ID。

ImageCategory String WindowsWithMssqlStdLicense

根据主机镜像查询专属集群。取值:

  • WindowsWithMssqlStdLicense:Windows(含SQL Server标准版License)。
  • WindowsWithMssqlEntLisence:Windows(含SQL Server企业版License)。
  • WindowsWithMssqlWebLisence:Windows(含SQL ServerWeb版License)。
  • AliLinux:Linux。

返回数据

名称 类型 示例值 描述
DedicatedHostGroups Array of DedicatedHostGroups

专属集群信息列表。

DedicatedHostGroups
AllocationPolicy String Evenly

当前专属集群的资源调度的分配策略。取值:

  • Evenly:均衡分配
  • Intensively:紧凑分配
BastionInstanceId String bastionhost-cn-m7xxxxxxxx

堡垒机ID。

CpuAllocateRation Float 25

当前专属集群已分配CPU的比例。单位:%。

CpuAllocatedAmount Float 8

当前专属集群已分配CPU的个数。

CpuAllocationRatio Integer 200

当前专属集群的CPU超配比。单位:%。关于超配比的更多信息,请参见管理集群

CreateTime String 1571125370000

当前专属集群创建时间的时间戳。

DedicatedHostCountGroupByHostType Map dhg_cloud_ssd

当前专属集群里的主机存储类型。取值:

  • dhg_cloud_ssd:云盘
  • dhg_local_ssd:本地盘
DedicatedHostGroupDesc String testHostGroup

当前专属集群的名称。

DedicatedHostGroupId String dhg-7a9xxxxxxxx

当前专属集群的ID。

DiskAllocateRation Float 0.49

当前专属集群已分配的磁盘比例。单位:%。

DiskAllocatedAmount Float 200

当前专属集群中已分配的磁盘容量。单位:GB。

DiskAllocationRatio Integer 200

当前专属集群的磁盘空间超配比。单位:%。关于超配比的更多信息,请参见管理集群

DiskUsedAmount Float 20

当前专属集群的已使用磁盘容量。单位:GB。

DiskUtility Float 0

当前专属集群的磁盘利用率。单位:%。

Engine String MySQL

当前专属集群的数据库引擎。

HostNumber Integer 3

当前专属集群中主机的总个数。

HostReplacePolicy String Auto

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

  • Auto:自动替换主机。
  • Manual:手动替换主机。
InstanceNumber Integer 4

当前专属集群中实例的总个数。

MemAllocateRation Float 33.7

当前专属集群已分配的内存比例。单位:%。

MemAllocatedAmount Float 16384

当前专属集群中已分配的内存数量。

MemAllocationRatio Integer 90

当前专属集群的内存超配比。单位:%。关于超配比的更多信息,请参见管理集群

MemUsedAmount Float 0

当前专属集群中已使用的内存数量。单位:MB。

MemUtility Float 0

当前专属集群的内存利用率。单位:%。

OpenPermission String 3

主机OS权限开放状态。返回值:

  • 0或者null:不可开放。
  • 1:可开放。
  • 3:已开放。
Text String testHostGroup/dhg-7a9xxxxxxxx

当前专属集群的名称和ID信息。由DedicatedHostGroupDescDedicatedHostGroupId拼接,格式为:DedicatedHostGroupDesc/DedicatedHostGroupId。

VPCId String vpc-bp1oxxxxxx

当前专属集群所在专有网络VPC ID。

ZoneIDList List cn-hangzhou

当前专属集群主机所在的可用区列表。

RequestId String AB44DC0A-7E77-442A-97A9-C6418694CB22

请求ID。

示例

请求示例

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

正常返回示例

XML格式

<DescribeDedicatedHostGroups>
  <RequestId>AB44DC0A-7E77-442A-97A9-C6418694CB22</RequestId>
  <DedicatedHostGroups>
        <DedicatedHostGroups>
              <DiskAllocationRatio>200</DiskAllocationRatio>
              <DiskUsedAmount>20</DiskUsedAmount>
              <InstanceNumber>4</InstanceNumber>
              <AllocationPolicy>Evenly</AllocationPolicy>
              <HostReplacePolicy>Auto</HostReplacePolicy>
              <DedicatedHostGroupId>dhg-7a9xxxxxxxx</DedicatedHostGroupId>
              <BastionInstanceId>bastionhost-cn-m7xxxxxxxx</BastionInstanceId>
              <MemAllocatedAmount>16384</MemAllocatedAmount>
              <OpenPermission>3</OpenPermission>
              <MemAllocateRation>33.7</MemAllocateRation>
              <DiskAllocatedAmount>200</DiskAllocatedAmount>
              <Engine>MySQL</Engine>
              <MemUtility>0</MemUtility>
              <MemAllocationRatio>90</MemAllocationRatio>
              <CpuAllocateRation>25</CpuAllocateRation>
              <VPCId>vpc-bp1oxxxxxx</VPCId>
              <CreateTime>1571125370000</CreateTime>
              <Text>testHostGroup/dhg-7a9xxxxxxxx</Text>
              <MemUsedAmount>0</MemUsedAmount>
              <DedicatedHostGroupDesc>testHostGroup</DedicatedHostGroupDesc>
              <DiskUtility>0</DiskUtility>
              <CpuAllocationRatio>200</CpuAllocationRatio>
              <DiskAllocateRation>0.49</DiskAllocateRation>
              <HostNumber>3</HostNumber>
              <CpuAllocatedAmount>8</CpuAllocatedAmount>
              <DedicatedHostCountGroupByHostType>dhg_cloud_ssd</DedicatedHostCountGroupByHostType>
              <ZoneIDList>
                    <ZoneIDList>cn-hangzhou</ZoneIDList>
              </ZoneIDList>
        </DedicatedHostGroups>
  </DedicatedHostGroups>
</DescribeDedicatedHostGroups>

JSON格式

{
	"RequestId": "AB44DC0A-7E77-442A-97A9-C6418694CB22",
	"DedicatedHostGroups": {
		"DedicatedHostGroups": [{
			"DiskAllocationRatio": "200",
			"DiskUsedAmount": "20",
			"InstanceNumber": "4",
			"AllocationPolicy": "Evenly",
			"HostReplacePolicy": "Auto",
			"DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
			"BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
			"MemAllocatedAmount": "16384",
			"OpenPermission": "3",
			"MemAllocateRation": "33.7",
			"DiskAllocatedAmount": "200",
			"Engine": "MySQL",
			"MemUtility": "0",
			"MemAllocationRatio": "90",
			"CpuAllocateRation": "25",
			"VPCId": "vpc-bp1oxxxxxx",
			"CreateTime": "1571125370000",
			"Text": "testHostGroup/dhg-7a9xxxxxxxx",
			"MemUsedAmount": "0",
			"DedicatedHostGroupDesc": "testHostGroup",
			"DiskUtility": "0",
			"CpuAllocationRatio": "200",
			"DiskAllocateRation": "0.49",
			"HostNumber": "3",
			"CpuAllocatedAmount": "8",
			"DedicatedHostCountGroupByHostType": "dhg_cloud_ssd",
			"ZoneIDList": {
				"ZoneIDList": "cn-hangzhou"
			}
		}]
	}
}

错误码

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