文档

DescribeDedicatedHosts - 查询RDS主机组内的主机信息

更新时间:

查询专属集群内的主机信息。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

cn-hangzhou
DedicatedHostGroupIdstring

专属集群 ID。可调用 DescribeDedicatedHostGroups 获取。

dhg-7a9xxxxxxxx
OrderIdlong

订单 ID。

102565235
HostTypestring

主机存储类型。取值:

  • dhg_cloud_ssd:ESSD 云盘。
  • dhg_local_ssd:SSD 本地盘。
dhg_cloud_ssd
HostStatusstring

主机状态。取值:

  • 0:创建中
  • 1:使用中
  • 2:宕机
  • 3:宕机下线(替换主机中)
  • 4:下线
  • 5:删除
  • 6:重启中
1
AllocationStatusstring

主机当前是否允许分配实例。取值:

  • 0:不允许分配。
  • 1:允许分配。
1
ZoneIdstring

可用区 ID。

cn-hangzhou-i
DedicatedHostIdstring

专属集群主机 ID。

ch-t4nn100ddxxxxxxxx

返回参数

名称类型描述示例值
object
DedicatedHostGroupIdstring

主机组 ID。

dhg-7a9xxxxxxxx
RequestIdstring

请求 ID。

C860658E-68A6-46C1-AF6E-3AE7C4D3CACF
DedicatedHostsobject []

主机信息列表。

HostTypestring

主机存储类型。返回值:

  • dhg_cloud_ssd:ESSD 云盘。
  • dhg_local_ssd:SSD 本地盘。
dhg_cloud_ssd
HostStoragestring

主机存储容量。单位:MB。

2097152
MemoryUsedstring

已使用内存。单位:MB。

16384
DedicatedHostGroupIdstring

专属集群 ID。

dhg-7a9xxxxxxxx
AllocationStatusstring

主机当前是否允许分配实例。返回值:

  • 0:不允许分配
  • 1:允许分配
1
StorageUsedstring

已使用存储空间。

0
DedicatedHostIdstring

主机 ID。

i-bpxxxxxxx
MemAllocationRatiostring

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

90
CreatedTimestring

主机创建时间。

2021-03-25 17:29:06.0
IPAddressstring

主机内网 IP 地址。

192.xx.xx.xx
HostStatusstring

主机状态。返回值:

  • 0:创建中
  • 1:使用中
  • 2:宕机
  • 3:宕机下线(替换主机中)
  • 4:下线
  • 5:删除
  • 6:重启中
1
HostNamestring

主机名称。

testHost1
HostCPUstring

主机 CPU 总核数。单位:个。

8
InstanceNumberstring

主机上的实例总数。

4
OpenPermissionstring

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

  • 0 或者 null:不可开放。
  • 1:可开放。
  • 3:已开放。
3
CpuUsedstring

主机 CPU 已使用核数。单位:个。

4
VPCIdstring

主机所属专有网络 VPC ID。

vpc-bpxxxxxxx
HostClassstring

主机规格。

ecs.i2.16xlarge
EndTimestring

主机到期时间。

2021-04-25T16:00:00Z
VSwitchIdstring

主机所属虚拟交换机 ID。

vsw-bpxxxxxxx
CPUAllocationRatiostring

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

200
ZoneIdstring

主机所在可用区 ID。

cn-hangzhou-i
ImageCategorystring

主机镜像。仅在 Engine 参数为 mssql 时返回。返回值:

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

实例的数据库引擎。

mysql
DiskAllocationRatiostring

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

200
HostMemstring

主机内存总量。单位:MB。

32238
BastionInstanceIdstring

堡垒机 ID。

bastionhost-cn-m7xxxxxxxx
AccountNamestring

专属集群主机账号。可通过 CreateDedicatedHostAccount 创建。

test123

示例

正常返回示例

JSON格式

{
  "DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
  "RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D3CACF",
  "DedicatedHosts": {
    "DedicatedHosts": [
      {
        "HostType": "dhg_cloud_ssd",
        "HostStorage": "2097152",
        "MemoryUsed": "16384",
        "DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
        "AllocationStatus": "1",
        "StorageUsed": "0",
        "DedicatedHostId": "i-bpxxxxxxx",
        "MemAllocationRatio": "90",
        "CreatedTime": "2021-03-25 17:29:06.0",
        "IPAddress": "192.xx.xx.xx",
        "HostStatus": "1",
        "HostName": "testHost1",
        "HostCPU": "8",
        "InstanceNumber": "4",
        "OpenPermission": "3",
        "CpuUsed": "4",
        "VPCId": "vpc-bpxxxxxxx",
        "HostClass": "ecs.i2.16xlarge",
        "EndTime": "2021-04-25T16:00:00Z",
        "VSwitchId": "vsw-bpxxxxxxx",
        "CPUAllocationRatio": "200",
        "ZoneId": "cn-hangzhou-i",
        "ImageCategory": "WindowsWithMssqlStdLicense",
        "Engine": "mysql",
        "DiskAllocationRatio": "200",
        "HostMem": "32238",
        "BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
        "AccountName": "test123"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidUserId.NotSupportThe userid have no permission.用户ID没有权限。
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.实例当前存在未支付订单,请支付后重试。
404InvalidDedicatedHostGroup.NotFoundSpecified DedicatedHostGroup does not exists.-

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)
文档反馈