全部产品
Search
文档中心

云数据库 RDS:DescribeDedicatedHosts - 查询RDS主机组内的主机信息

更新时间:Jun 06, 2023

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
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"
      }
    ]
  }
}

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没有权限。
404InvalidDedicatedHostGroup.NotFoundSpecified DedicatedHostGroup does not exists.-

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新,OpenAPI 错误码发生变更
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404