全部产品
Search

搜索本产品

    云数据库 RDS：DescribeDedicatedHostGroups - 查询RDS主机组信息

    文档中心

    云数据库 RDS：DescribeDedicatedHostGroups - 查询RDS主机组信息

    更新时间：Jun 06, 2023

    查询RDS专属集群信息。

    接口说明

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    rds:DescribeDedicatedHostGroupsREAD
    • RDS
      acs:rds:*:{#accountId}:dbinstance/*
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

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

    		cn-hangzhou
    DedicatedHostGroupIdstring否

    专属集群ID。

    		dhg-7a9xxxxxxxx
    ImageCategorystring否

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

    • WindowsWithMssqlStdLicense：Windows（含SQL Server标准版License）。
    • WindowsWithMssqlEntLisence：Windows（含SQL Server企业版License）。
    • WindowsWithMssqlWebLisence：Windows（含SQL ServerWeb版License）。
    • AliLinux：Linux。
    		WindowsWithMssqlStdLicense

    返回参数

    名称类型描述示例值
    object

    返回参数详情如下。

    RequestIdstring

    请求ID。

    		AB44DC0A-7E77-442A-97A9-C6418694CB22
    DedicatedHostGroupsobject []

    专属集群信息列表。

    DiskAllocateRationfloat

    当前专属集群已分配的磁盘比例。单位：百分号（%）。

    		0.49
    CreateTimestring

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

    		1571125370000
    DedicatedHostCountGroupByHostTypeobject

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

    • dhg_cloud_ssd：云盘
    • dhg_local_ssd：本地盘
    		dhg_cloud_ssd
    Textstring

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

    		testHostGroup/dhg-7a9xxxxxxxx
    DedicatedHostGroupIdstring

    当前专属集群的ID。

    		dhg-7a9xxxxxxxx
    DiskUtilityfloat

    当前专属集群的磁盘利用率。单位：百分号（%）。

    		0
    MemUsedAmountfloat

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

    		0
    MemAllocatedAmountfloat

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

    		16384
    CpuAllocationRatiointeger

    当前专属集群的CPU超配比。单位：百分号（%）。关于超配比的更多信息，请参见管理集群。

    		200
    MemAllocationRatiointeger

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

    		90
    MemUtilityfloat

    当前专属集群的内存利用率。单位：百分号（%）。

    		0
    MemAllocateRationfloat

    当前专属集群已分配的内存比例。单位：百分号（%）。

    		33.7
    CpuAllocatedAmountfloat

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

    		8
    DedicatedHostGroupDescstring

    当前专属集群的名称。

    		testHostGroup
    CpuAllocateRationfloat

    当前专属集群已分配CPU的比例。单位：百分号（%）。

    		25
    InstanceNumberinteger

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

    		4
    OpenPermissionstring

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

    • 0或者null：不可开放。
    • 1：可开放。
    • 3：已开放。
    		3
    VPCIdstring

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

    		vpc-bp1oxxxxxx
    DiskAllocatedAmountfloat

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

    		200
    HostNumberinteger

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

    		3
    DiskUsedAmountfloat

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

    		20
    AllocationPolicystring

    当前专属集群的资源调度的分配策略。返回值：

    • Evenly：均衡分配
    • Intensively：紧凑分配
    		Evenly
    Enginestring

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

    		MySQL
    DiskAllocationRatiointeger

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

    		200
    BastionInstanceIdstring

    堡垒机ID。

    		bastionhost-cn-m7xxxxxxxx
    HostReplacePolicystring

    主机故障时系统的处理策略。返回值：

    • Auto：自动替换主机。
    • Manual：手动替换主机。
    		Auto
    ZoneIDListarray

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

    string

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

    		cn-hangzhou

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    500ForbiddenUser not authorized to operate on the specified resource.

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