文档中心

云服务器

请输入

专有宿主机

DescribeDedicatedHostClusters - 查询专有宿主机集群信息

调用 DescribeDedicatedHostClusters 接口查询专有宿主机集群的详细信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeDedicatedHostClusters

要执行的操作，取值：DescribeDedicatedHostClusters。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

DedicatedHostClusterIds.N string[] 可选示例值：DedicatedHostClusterIds.1=dc-ycle6b76kgv2wrsm****&DedicatedHostClusterIds.2=dc-yclc1jr9j4arsp3j****

专有宿主机集群ID，最多支持10个。

参数 - N：表示专有宿主机集群的序号。

多个集群ID之间用&分隔。

DedicatedHostClusterName string 可选示例值：DDH-Cluster01

专有宿主机集群的名称。

不能以数字、中划线、下划线开头。

只能包含中文、字母、数字、下划线和中划线。

长度限制为1～128个字符。

暂不支持特殊字符。

MaxResults integer 可选示例值：10

分页查询时设置的每页行数：

最大值：100

默认值：10

NextToken string 可选示例值：--

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

ZoneId string 可选示例值：cn-beijing-a

专有宿主机集群所在的可用区ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

DedicatedHostClusters object[] 示例值：--

专有宿主机集群信息。

CreatedAt string 示例值：2023-08-11T10:30:25+08:00

专有宿主机集群的创建时间。

DedicatedHostClusterCapacity object 示例值：--

专有宿主机集群的容量信息。

LocalVolumeCapacities object[] 示例值：--

专有宿主机集群内的本地盘容量信息。

AvailableSize integer 示例值：64

本地盘的剩余容量，单位：GiB。

TotalSize integer 示例值：512

本地盘的总容量，单位：GiB。

VolumeType string 示例值：LOCAL_SSD

本地盘类型，取值：

LOCAL_SSD：SSD本地盘

LOCAL_HDD：HDD本地盘

AvailableInstanceTypes object[] 示例值：--

专有宿主机集群内ECS实例规格的可用容量。

AvailableCapacity integer 示例值：58

可用的实例规格容量。

InstanceType string 示例值：ecs.ddhr2s.define.c4m16

实例规格。

AvailableMemory integer 示例值：441

当前可用内存大小，单位：GiB。

AvailableVcpus integer 示例值：951296

可用vCPU数。

TotalMemory integer 示例值：972800

总内存大小，单位：GiB。

TotalVcpus integer 示例值：448

总vCPU数。

DedicatedHostClusterId string 示例值：dc-ycle6b76kgv2wrsm****

专有宿主机集群ID。

DedicatedHostClusterName string 示例值：DDH-Cluster01

专有宿主机集群名称。

DedicatedHostIds string[] 示例值：["dh-3tigy72q3u3vj0x2****","dh-ycje2rquioh9l3bn****"]

专有宿主机ID。

Description string 示例值：用于测试的专有宿主机集群

专有宿主机集群的描述信息。

UpdatedAt string 示例值：2023-08-11T10:30:25+08:00

专有宿主机集群的更新时间。

ZoneId string 示例值：cn-beijing-a

专有宿主机集群所在的可用区ID。

NextToken string 示例值：eWNsYTg0b2s1Y3Yyd3Jzb2do****

本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeDedicatedHostClusters&Version=2020-04-01 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2023071716274123B73A705E255110****",​
    "Action": "DescribeDedicatedHostClusters",​
    "Version": "2020-04-01",​
    "Service": "ecs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "DedicatedHostClusters": [​
      {​
        "CreatedAt": "2023-08-11T10:30:25+08:00",​
        "UpdatedAt": "2023-08-11T10:30:25+08:00",​
        "DedicatedHostClusterId": "dc-ycle6b76kgv2wrsm****",​
        "ZoneId": "cn-beijing-a",​
        "DedicatedHostClusterName": "DDH-Cluster01",​
        "Description": "用于测试的专有宿主机集群",​
        "DedicatedHostIds": [​
          "dh-3tigy72q3u3vj0x2***"​
        ],​
        "DedicatedHostClusterCapacity": {​
          "TotalVcpus": 448,​
          "AvailableVcpus": 441,​
          "TotalMemory": 972800,​
          "AvailableMemory": 951296,​
          "LocalVolumeCapacities": [ ],​
          "AvailableInstanceTypes": [​
            {​
              "InstanceType": "ecs.ddhr2s.define.c4m16",​
              "AvailableCapacity": 58​
            },​
            {​
              "InstanceType": "ecs.ddhr2s.define.c8m16",​
              "AvailableCapacity": 55​
            }​
          ]​
        }​
      }​
    ],​
    "NextToken": "eWNsYTg0b2s1Y3Yyd3Jzb2do****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MaximumDedicatedHostClusterIds	The number of specified DedicatedHostClusterIds exceeds the maximum limit.	指定的DedicatedHostClusterIds超过最大限制。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2025.09.04 16:59:42

这个页面对您有帮助吗？

有用

无用