DescribeDedicatedHostClusters - 查询专有宿主机集群信息--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

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

最近更新时间：2024.11.19 10:15:10首次发布时间：2024.04.22 11:34:50

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeDedicatedHostClusters	要执行的操作，取值：DescribeDedicatedHostClusters。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
DedicatedHostClusterIds.N	Array of 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	Array of Object	--	专有宿主机集群信息。
NextToken	String	eWNsYTg0b2s1Y3Yyd3Jzb2do****	本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeDedicatedHostClusters&Version=2020-04-01
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.	内部错误，请重试。如果多次尝试失败，请提交工单。