調用DescribeDedicatedHostClusters查詢一個或多個專有宿主機集群的詳細信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:DescribeDedicatedHostClusters | get | *DedicatedHostCluster acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}*DedicatedHostCluster acs:ecs:{#regionId}:{#accountId}:ddhcluster/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Status | string | 否 | 說明
該參數暫未上線，不支持使用。
| null |
| LockReason | string | 否 | 說明
該參數暫未上線，不支持使用。
| null |
| ResourceGroupId | string | 否 | 專有宿主機集群要加入的資源組 ID。使用該參數過濾資源時，資源數量不能超過 1000 個。 說明
不支持默認資源組過濾。
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽列表。 | ||
| Key | string | 否 | 專有宿主機集群的標簽鍵。N 的取值范圍：1~20。一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 使用一個標簽過濾資源，查詢到該標簽下的資源數量不能超過 1000 個；使用多個標簽過濾資源，查詢到同時綁定了多個標簽的資源數量不能超過 1000 個。如果資源數量超過 1000 個，請使用 ListTagResources 接口進行查詢。 | TestKey |
| Value | string | 否 | 專有宿主機集群的標簽值。N 的取值范圍：1~20。一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 | TestValue |
| RegionId | string | 是 | 專有宿主機集群所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ZoneId | string | 否 | 專有宿主機集群所在的可用區 ID。您可以調用 DescribeZones 查看阿里云地域下的可用區。 | cn-hangzhou-f |
| DedicatedHostClusterIds | string | 否 | 專有宿主機集群 ID 列表。取值可以由多個專有宿主機集群 ID 組成一個 JSON 數組，格式為 | ["dc-bp12wlf6am0vz9v2****", "dc-bp12wlf6am0vz9v3****"] |
| DedicatedHostClusterName | string | 否 | 專有宿主機集群名稱。 | myDDHCluster |
| PageNumber | integer | 否 | 專有宿主機集群狀態列表的頁碼。 起始值：1。 默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時設置的每頁行數。 最大值：100。 默認值：10。 | 5 |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 5,
"RequestId": "214A2187-B06F-4E49-A081-4D053466A8C7",
"PageNumber": 1,
"TotalCount": 2,
"DedicatedHostClusters": {
"DedicatedHostCluster": [
{
"Description": "This-is-my-DDHCluster",
"DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"ZoneId": "cn-hangzhou-f",
"RegionId": "cn-hangzhou",
"DedicatedHostClusterName": "myDDHCluster",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"DedicatedHostIds": {
"DedicatedHostId": [
"dh-bp181e5064b5sotr****"
]
},
"DedicatedHostClusterCapacity": {
"AvailableVcpus": 2,
"AvailableMemory": 4,
"TotalMemory": 8,
"TotalVcpus": 4,
"LocalStorageCapacities": {
"LocalStorageCapacity": [
{
"DataDiskCategory": "cloud",
"AvailableDisk": 20,
"TotalDisk": 40
}
]
},
"AvailableInstanceTypes": {
"AvailableInstanceType": [
{
"InstanceType": "ecs.c6.26xlarge",
"AvailableInstanceCapacity": 0
}
]
}
}
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingParamter.RegionId | The regionId should not be null. | 參數 RegionId 不得為空。 |
| 400 | InvalidParameter.DedicatedHostClusterIds | The specified parameter dedicatedHostClusterIds is not valid. | - |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 參數不合法。 |
| 400 | InvalidZone.NotFound | The specified parameter ZoneId is not valid. | 指定的ZoneId不合法。 |
| 403 | InvalidDedicatedHostIds.Malformed | The amount of specified dedicatedHostClusterIds exceeds the limit. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|