查询专属集群内的主机信息。
接口说明
专属集群功能以集群形式批量管理实例,一个地域可以创建多个专属集群,一个专属集群包含多个主机,一个主机包含多个实例。详情请参见专属集群简介。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDedicatedHosts | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域ID。可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
DedicatedHostGroupId | string | 否 | 专属集群ID。可调用DescribeDedicatedHostGroups获取。 | dhg-7a9xxxxxxxx |
OrderId | long | 否 | 订单ID。 | 102565235 |
HostType | string | 否 | 主机存储类型。取值:
| dhg_cloud_ssd |
HostStatus | string | 否 | 主机状态。取值:
| 1 |
AllocationStatus | string | 否 | 主机当前是否允许分配实例。取值:
| 1 |
ZoneId | string | 否 | 可用区ID。 | cn-hangzhou-i |
DedicatedHostId | string | 否 | 专属集群主机ID。 | ch-t4nn100ddxxxxxxxx |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidUserId.NotSupport | The userid have no permission. | 用户ID没有权限。 |
404 | InvalidDedicatedHostGroup.NotFound | Specified DedicatedHostGroup does not exists. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-06-23 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | |||||||||
|