DescribeDedicatedHostClusters - 查詢Dedicated Host組的詳情 - Elastic Compute Service

查詢一個或多個Dedicated Host組的詳細資料。

介面說明

請求參數的作用類似於一個過濾器，過濾器為邏輯與（AND）關係。如果某一參數為空白，則過濾器不起作用。但是參數DedicatedHostClusterIds的值如果是一個空 JSON 數組，即[]，則視為該過濾器有效，且傳回值為空白。

調試

您可以在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	否	Dedicated Host組要加入的資源群組 ID。使用該參數過濾資源時，資源數量不能超過 1000 個。說明不支援預設資源群組過濾。	rg-bp67acfmxazb4p****
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	Dedicated Host組的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://`。使用一個標籤過濾資源，查詢到該標籤下的資源數量不能超過 1000 個；使用多個標籤過濾資源，查詢到同時綁定了多個標籤的資源數量不能超過 1000 個。如果資源數量超過 1000 個，請使用 ListTagResources 介面進行查詢。	TestKey
Value	string	否	Dedicated Host組的標籤值。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能包含`http://`或`https://`。	TestValue
RegionId	string	是	Dedicated Host組所在的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
ZoneId	string	否	Dedicated Host組所在的可用性區域 ID。您可以調用 DescribeZones 查看阿里雲地區下的可用性區域。	cn-hangzhou-f
DedicatedHostClusterIds	string	否	Dedicated Host組 ID 列表。取值可以由多個Dedicated Host組 ID 組成一個 JSON 數組，格式為`["dc-xxxxxxxxx", "dc-yyyyyyyyy", … ,"dc-zzzzzzzzz"]`。支援最多 100 個 ID，用半形逗號字元隔開。	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]
DedicatedHostClusterName	string	否	Dedicated Host組名稱。	myDDHCluster
PageNumber	integer	否	Dedicated Host組狀態列表的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100。預設值：10。	5

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	輸入時設定的每頁行數。	5
RequestId	string	請求 ID。	214A2187-B06F-4E49-A081-4D053466A8C7
PageNumber	integer	Dedicated Host組狀態列表的頁碼。	1
TotalCount	integer	Dedicated Host總個數。	2
DedicatedHostClusters	object
DedicatedHostCluster	array<object>	由一個或多個Dedicated Host組資訊組成的數組。
	array<object>
Description	string	Dedicated Host組描述。	This-is-my-DDHCluster
DedicatedHostClusterId	string	Dedicated Host組 ID。	dc-bp12wlf6am0vz9v2****
ResourceGroupId	string	Dedicated Host組的資源群組 ID。	rg-bp67acfmxazb4p****
ZoneId	string	Dedicated Host組所在的可用性區域 ID。	cn-hangzhou-f
RegionId	string	Dedicated Host組所在的地區 ID。	cn-hangzhou
DedicatedHostClusterName	string	Dedicated Host組名稱。	myDDHCluster
Tags	object
Tag	array<object>	Dedicated Host組的標籤。
	object
TagValue	string	Dedicated Host組的標籤值。	TestValue
TagKey	string	Dedicated Host組的標籤鍵。	TestKey
DedicatedHostIds	object
DedicatedHostId	array	Dedicated Host組下的Dedicated Host ID 列表。
	string	Dedicated Host ID。	dh-bp181e5064b5sotr****
DedicatedHostClusterCapacity	object	Dedicated Host組容量。
AvailableVcpus	integer	當前可用 vCPU 數。	2
AvailableMemory	integer	當前可用記憶體大小。單位：GiB。	4
TotalMemory	integer	總記憶體大小。單位：GiB。	8
TotalVcpus	integer	總 vCPU 數。	4
LocalStorageCapacities	object
LocalStorageCapacity	array<object>	本機存放區容量。
	object
DataDiskCategory	string	資料盤類型。可能值： cloud：普通雲端硬碟。 cloud_efficiency：高效雲端硬碟。 cloud_ssd：SSD 雲端硬碟。 ephemeral_ssd：本地 SSD 盤。 cloud_essd：ESSD 雲端硬碟。	cloud
AvailableDisk	integer	當前可用本地碟大小。單位：GiB。	20
TotalDisk	integer	本地碟總大小。單位：GiB。	40
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	Dedicated Host組內 ECS 執行個體規格的可用容量。
	object
InstanceType	string	執行個體規格。	ecs.c6.26xlarge
AvailableInstanceCapacity	integer	可用的執行個體規格容量。	0

樣本

正常返回樣本

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。