DescribeDedicatedHostClusters - 查询一个或多个专有宿主机集群的详细信息 - 云服务器 ECS

调用DescribeDedicatedHostClusters查询一个或多个专有宿主机集群的详细信息。

接口说明

请求参数的作用类似于一个过滤器，过滤器为逻辑与（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	否	专有宿主机集群要加入的资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	专有宿主机集群的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。	TestKey
Value	string	否	专有宿主机集群的标签值。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。	TestValue
RegionId	string	是	专有宿主机集群所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
ZoneId	string	否	专有宿主机集群所在的可用区 ID。您可以调用 DescribeZones 查看阿里云地域下的可用区。	cn-hangzhou-f
DedicatedHostClusterIds	string	否	专有宿主机集群 ID 列表。取值可以由多个专有宿主机集群 ID 组成一个 JSON 数组，格式为`["dc-xxxxxxxxx", "dc-yyyyyyyyy", … ,"dc-zzzzzzzzz"]`。支持最多 100 个 ID，用半角逗号字符隔开。	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]
DedicatedHostClusterName	string	否	专有宿主机集群名称。	myDDHCluster
PageNumber	integer	否	专有宿主机集群状态列表的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10。	5

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	输入时设置的每页行数。	5
RequestId	string	请求 ID。	214A2187-B06F-4E49-A081-4D053466A8C7
PageNumber	integer	专有宿主机集群状态列表的页码。	1
TotalCount	integer	专有宿主机总个数。	2
DedicatedHostClusters	array<object>	由一个或多个专有宿主机集群状态组成的数组。
DedicatedHostCluster	object
Description	string	专有宿主机集群描述。	This-is-my-DDHCluster
DedicatedHostClusterId	string	专有宿主机集群 ID。	dc-bp12wlf6am0vz9v2****
ResourceGroupId	string	专有宿主机集群的资源组 ID。	rg-bp67acfmxazb4p****
ZoneId	string	专有宿主机集群所在的可用区 ID。	cn-hangzhou-f
RegionId	string	专有宿主机集群所在的地域 ID。	cn-hangzhou
DedicatedHostClusterName	string	专有宿主机集群名称。	myDDHCluster
Tags	array<object>	专有宿主机集群的标签。
Tag	object
TagValue	string	专有宿主机集群的标签值。	TestValue
TagKey	string	专有宿主机集群的标签键。	TestKey
DedicatedHostIds	array	专有宿主机集群下的专有宿主机 ID 列表。
DedicatedHostId	string	专有宿主机 ID。	dh-bp181e5064b5sotr****
DedicatedHostClusterCapacity	object	专有宿主机集群容量。
AvailableVcpus	integer	当前可用 vCPU 数。	2
AvailableMemory	integer	当前可用内存大小。单位：GiB。	4
TotalMemory	integer	总内存大小。单位：GiB。	8
TotalVcpus	integer	总 vCPU 数。	4
LocalStorageCapacities	array<object>	本地存储容量。
LocalStorageCapacity	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	array<object>	专有宿主机集群内 ECS 实例规格的可用容量。
AvailableInstanceType	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.	-

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史