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

文档中心

立即注册

导航

云服务器

DescribeDedicatedHosts - 查询专有宿主机信息

最近更新时间：2024.08.12 10:40:00首次发布时间：2024.04.22 11:34:50

调用 DescribeDedicatedHosts 接口获取专有宿主机的详细信息，包括宿主机状态、到期时间和已创建的实例列表等。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeDedicatedHosts	要执行的操作，取值：DescribeDedicatedHosts。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
DedicatedHostClusterId	String	否	dc-ycle6b76kgv2wrsm****	专有宿主机所属的集群ID。
DedicatedHostIds.N	Array of String	否	DedicatedHostIds.1=dh-3tigy72q3u3vj0x2**&DedicatedHostIds.2=dh-ycje2rquioh9l3bn**	专有宿主机ID，最多支持100个。参数 - N：表示专有宿主机ID的序号。多个ID之间用&分隔。
DedicatedHostName	String	否	dedicated-host-test	专有宿主机的名称，支持关键字模糊查询。
DedicatedHostTypeId	String	否	ecs.ddhr2s	专有宿主机规格。
MaxResults	Integer	否	10	分页查询时设置的每页行数：最大值：100 默认值：10
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
Status	String	否	Available	专有宿主机的状态，取值： Starting：启动中 Available：可用 Stopping：停止中 Stopped：已停止 Released：已释放 UnderAssessment：存在潜在风险 TempUnavailable：临时不可用 Pending：维护中 PermanentFailure：永久性故障 Unknown：未知
ZoneId	String	否	cn-beijing-a	专有宿主机所在可用区ID。您可以调用DescribeZones 查询一个地域下的可用区信息。

返回参数

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

参数	类型	示例值	描述
DedicatedHosts	Array of Object	--	专有宿主机信息。
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230714173759DC17D8F861B10D4D****",
        "Action": "DescribeDedicatedHosts",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "DedicatedHosts": [
            {
                "CreatedAt": "2023-07-14T17:17:56+08:00",
                "UpdatedAt": "2023-07-14T17:17:58+08:00",
                "DedicatedHostId": "dh-ycje2rquioh9l3bn****",
                "ZoneId": "cn-beijing-a",
                "Status": "Available",
                "DedicatedHostName": "dedicated-host-test",
                "Description": "",
                "AutoPlacement": "Off",
                "HostRecovery": "Off",
                "HostMaintenance": "Off",
                "CpuOvercommitRatio": 4,
                "Instances": [],
                "Capacity": {
                    "TotalVcpus": 448,
                    "AvailableVcpus": 448,
                    "TotalMemory": 962560,
                    "AvailableMemory": 962560
                },
                "DedicatedHostTypeId": "ecs.ddhr2s",
                "ChargeType": "PrePaid",
                "ExpiredAt": "2023-08-14T23:59:59+08:00"
            }
        ],
        "NextToken": "eWNsYTg0b2s1Y3Yyd3Jzb2do****"
    }
}

错误码

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

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