云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器专有宿主机DDHAPI参考专有宿主机DescribeDedicatedHosts - 查询专有宿主机信息
复制全文
下载 pdfDescribeDedicatedHosts - 查询专有宿主机信息
文档反馈
问问助手调用 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 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：未知
返回参数
DedicatedHosts object[] 示例值：--
专有宿主机信息。
AutoPlacement string 示例值：Off
专有宿主机是否支持自动部署，取值：
- On：支持自动部署。
- Off：不支持自动部署。
Capacity object 示例值：--
专有宿主机容量信息。
LocalVolumeCapacities object[] 示例值：--
专有宿主机挂载的本地盘容量信息。
AvailableSize integer 示例值：64
本地盘的剩余容量，单位：GiB。
TotalSize integer 示例值：512
本地盘的总容量，单位：GiB。
VolumeType string 示例值：LOCAL_SSD
本地盘类型，取值：
- LOCAL_SSD：SSD本地盘
- LOCAL_HDD：HDD本地盘
AvailableMemory integer 示例值：962560
剩余内存大小，单位：MiB。
AvailableVcpus integer 示例值：448
可用vCPU数量。
TotalMemory integer 示例值：962560
内存总容量，单位：MiB。
TotalVcpus integer 示例值：448
vCPU总数。
ChargeType string 示例值：PrePaid
专有宿主机的计费类型，取值：
PrePaid：包年包月。
CpuOvercommitRatio float 示例值：4
CPU超分比。
CreatedAt string 示例值：2022-06-28T18:29:38+08:00
专有宿主机创建时间。
DedicatedHostClusterId string 示例值：dc-ycle6b76kgv2wrsm****
专有宿主机集群ID。
DedicatedHostId string 示例值：dh-ycje2rquioh9l3bn****
专有宿主机ID。
DedicatedHostName string 示例值：dedicated-host-test
专有宿主机名称。
DedicatedHostTypeId string 示例值：ecs.ddhr2s
专有宿主机规格。
Description string 示例值：用于测试的专有宿主机
专有宿主机描述。
ExpiredAt string 示例值：2022-07-28T18:29:38+08:00
专有宿主机的到期时间。
HostRecovery string 示例值：Off
专有宿主机是否开启宕机自动迁移，取值：
- On：开启宕机自动迁移。
- Off：未开启宕机自动迁移。
Instances object[] 示例值：--
专有宿主机上部署的ECS实例信息。
InstanceId string 示例值：i-3tigy72q3u3vj0x2****
实例ID。
InstanceTypeId string 示例值：ecs.ddhr2s.define.c1m1
实例规格。
Status string 示例值：Available
专有宿主机的状态。
UpdatedAt string 示例值：2022-06-28T18:29:38+08:00
专有宿主机更新时间。
ZoneId string 示例值：cn-beijing-a
专有宿主机所在可用区ID。
NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******
本次调用返回的查询凭证值，返回为空表示该页为末页。
请求示例
GET /?Action=DescribeDedicatedHosts&Version=2020-04-01 HTTP/1.1
Host: ecs.cn-beijing.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,
"LocalVolumeCapacities": []
},
"DedicatedHostTypeId": "ecs.ddhr2s",
"ChargeType": "PrePaid",
"ExpiredAt": "2023-08-14T23:59:59+08:00"
}
],
"NextToken": "eWNsYTg0b2s1Y3Yyd3Jzb2do****"
}
}
错误码
最近更新时间：2025.09.04 16:59:42
这个页面对您有帮助吗？
有用
有用
无用
无用