可以來查詢專屬集群的主機信息。
接口說明
添加主機后，您可以查看主機的詳細信息，包括性能監控、CPU 總數、內存總量、存儲總量等。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | cn-hangzhou | |
| DedicatedHostGroupId | string | 是 | 專屬集群 ID。您可以登錄云數據庫專屬集群控制臺，在專屬集群列表查看并獲取專屬集群 ID。 | dhg-h5i4p331f509**** |
| OrderId | long | 否 | 訂單號。 您可以前往費用與成本，在左側導航欄中選擇費用>訂購訂單>我的訂單，在我的訂單查看并獲取訂單號。 | 123456789 |
| HostType | string | 否 | 主機的存儲類型，取值：
| dhg_cloud_ssd |
| HostStatus | string | 否 | 主機狀態，取值：
說明
當主機出現故障時，主機會下線，下線過程中主機會遷移實例數據。
| 1 |
| AllocationStatus | string | 否 | 主機是否可分配實例，取值：
| Allocatable |
| ZoneId | string | 否 | 可用區 ID。您可以調用 DescribeRegions 接口獲取可用區 ID。 | ap-southeast-1a |
| DedicatedHostId | string | 否 | 專屬集群的主機 ID，您可以登錄云數據庫專屬集群控制臺，在主機列表查看并獲取主機 ID。 | ch-bp10a5id3boqi**** |
| PageNumbers | integer | 否 | 展示總頁碼數。 | 50 |
| PageSize | integer | 否 | 每頁展示數目。 | 20 |
| Tags | string | 否 | 查詢綁定有該標簽的主機，包括 TagKey 和 TagValue。單次最多支持傳入 5 組值，格式：{"key1":"value1","key2":"value2"...}。 說明
按照主機標簽過濾主機信息時，不需要填寫 DedicatedHostId 參數，否則會按照 DedicatedHostId 過濾主機信息。
| {"key1":"value1"} |
返回參數
示例
正常返回示例
JSON格式
{
"TotalRecords": 40,
"PageSize": 20,
"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EASER",
"PageNumbers": 2,
"DedicatedHostGroupId": "dhg-6w7q18iwt5jo****",
"DedicatedHosts": {
"DedicatedHosts": [
{
"HostType": "dhg_cloud_ssd",
"HostStorage": "1234",
"MemoryUsed": "24576",
"DedicatedHostGroupId": "dhg-6w7q18iwt5jo****",
"AllocationStatus": "Suspended",
"StorageUsed": "588800",
"EcsClassCode": "ecs.r5.16xlarge",
"DedicatedHostId": "ch-bp10a5id3boqi****",
"MemAllocationRatio": "90",
"CreatedTime": "2020-10-16 16:30:19",
"IPAddress": "192.168.XX.XX",
"HostStatus": "1",
"HostName": "ch-bp15xfnp706tl****",
"HostCPU": "16",
"CpuUsed": "10",
"InstanceNumber": "1",
"OpenPermission": "1",
"DistributionSymbol": "0",
"VPCId": "vpc-bp1roz55mrbj3ka1s****",
"HostClass": "rds.g6.4xlarge",
"EndTime": "2021-10-16 16:30:19",
"VSwitchId": "vsw-bp133c8ifzxd3iv6q****",
"ZoneId": "ap-southeast-1a",
"CPUAllocationRatio": "10",
"ImageCategory": "ALinux",
"Engine": "mysql",
"DiskAllocationRatio": "10",
"HostMem": "65536",
"BastionInstanceId": "bastionhost-cn-i7m2fgw****",
"AccountName": "test",
"AccountType": "Normal",
"DistributionTag": "t4n9uz07h3r1tmcejtxf:1",
"Category": "Standard",
"EcsId": "i-2zec7l031p0jtru3pn7a",
"DiskInfo": "{\\\"SystemDiskSize\\\":20,\\\"DataDiskCount\\\":0,\\\"DataDiskSize\\\":0,\\\"DataDiskCategory\\\":[\\\"\\\"],\\\"SystemDiskCategory\\\":\\\"cloud_essd\\\"}",
"ChargeType": "PREPAY",
"MssqlSupportVersion": "2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std"
}
]
},
"MaxAutoScaleHostStorage": 3661824
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Tag.InvalidTagsParameter | tags parameter is invalid | - |
| 400 | InvalidUserId.NotSupport | The userid have no permission. | - |
| 403 | Forbidden.RAM | User not authorized to operate on the specified resource, or this API does not support RAM. | 操作被禁止 |
| 404 | InvalidDedicatedHostGroup.NotFound | Specified DedicatedHostGroup does not exists. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史