备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 其他 主机 DescribeDedicatedHostGroups - 查询RDS主机组信息

DescribeDedicatedHostGroups - 查询RDS主机组信息

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询RDS专属集群信息。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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错误码错误信息描述
400ForbiddenUser not authorized to operate on the specified resource.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。

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

变更历史

变更时间变更内容概要操作
2023-06-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：500
    新增错误码：400
  • 本页导读 （1）
文档反馈