DescribeDedicatedHosts分页
本接口用于查询一台或多台专有宿主机的详细信息。通过该接口,您可以获取包括专有宿主机的物理性能指标、机器码、使用状态以及已创建的ECS实例列表等信息。您能够根据具体需求,通过指定相关参数,如专有宿主机ID列表、专有宿主机集群ID、宿主机名称、状态等,精准地查询所需的专有宿主机详细信息,为高效管理和优化云计算资源提供有力支持
服务地址:
华东1 金融云
输入参数
只看必填
RegionId专有宿主机所属的地域ID
ZoneId可用区ID
DedicatedHostIds专有宿主机ID列表
DedicatedHostName专有宿主机的名称
Status专有宿主机的使用状态
DedicatedHostType专有宿主机的规格
LockReason专有宿主机被锁定的原因
ResourceGroupId专有宿主机所在资源组ID
Tag标签列表
0
Key专有宿主机的标签键
Value专有宿主机的标签值
DedicatedHostClusterId专有宿主机集群ID
SocketDetails是否展示Socket维度容量信息
分页参数
PageNumber该参数即将下线
PageSize该参数即将下线
NextToken查询凭证(Token)
MaxResults分页查询时每页的最大条目数
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

您可以通过以下任一方式查询一台或多台专有宿主机的详细信息:

  • 指定DedicatedHostIds查询专有宿主机的详细信息。
  • 指定DedicatedHostClusterId查询专有宿主机集群内专有宿主机的详细信息。

请求参数

字段名称字段详情
RegionIdstring

专有宿主机所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

可用区 ID。您可以调用 DescribeZones 查看最新的阿里云可用区列表。

示例值:cn-hangzhou-g参考取值来源:
    DescribeZones
DedicatedHostIdsstring

专有宿主机 ID 列表。最多支持 100 个 ID ,ID 之间用半角逗号(,)隔开。

示例值:["dh-bp165p6xk2tlw61e****", "dh-bp1f9vxmno7emy96****"]参考取值来源:
    AllocateDedicatedHosts
    DescribeDedicatedHostClusters
DedicatedHostNamestring

专有宿主机的名称。

示例值:MyDDHTestName
Statusstring

专有宿主机的使用状态。取值范围:展开详情

示例值:Available
DedicatedHostTypestring

专有宿主机的规格。您可以调用 DescribeDedicatedHostTypes 接口获得最新的专有宿主机规格列表。

示例值:ddh.g5参考取值来源:
    DescribeDedicatedHostTypes
    AllocateDedicatedHosts
LockReasonstring

专有宿主机被锁定的原因。取值范围:展开详情

示例值:financial
PageNumberinteger<int32>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
示例值:1取值 >= 1
PageSizeinteger<int32>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
示例值:10取值 <= 100
ResourceGroupIdstring

专有宿主机所在资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。展开详情

示例值:rg-aek3b6jzp66****参考取值来源:
    DescribeSecurityGroups
Tagarray<object>

标签列表。列表长度范围:0~20。

子级条数 <= 20
DedicatedHostClusterIdstring

专有宿主机集群 ID。

示例值:dc-bp12wlf6am0vz9v2****参考取值来源:
    CreateDedicatedHostCluster
    DescribeDedicatedHostClusters
SocketDetailsstring

是否展示 Socket 维度容量信息。您可以通过 Socket 维度容量信息查看剩余资源信息(vCPU、内存使用量、剩余量和总量信息),从而判断是否可以创建出对应规格的 ECS 实例。取值范围:展开详情

示例值:true
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。

示例值:e71d8a535bd9cc11
MaxResultsinteger<int32>

分页查询时每页的最大条目数。一旦设置该参数,即表示使用 MaxResults 与 NextToken 组合参数的查询方式。展开详情

示例值:10取值 <= 100

返回参数

字段名称字段详情
PageSizeinteger<int32>

输入时设置的每页行数。

示例值:1
RequestIdstring

请求 ID。

示例值:7654525A-9964-4ABB-8BCD-98F8835E809A
PageNumberinteger<int32>

专有宿主机列表的页码。

示例值:5
TotalCountinteger<int32>

专有宿主机总数。

示例值:3
NextTokenstring

本次调用返回的查询凭证(Token)。当使用 MaxResults 和 NextToken 方式进行分页查询,且该返回值为空时,表示无更多返回的数据信息。

示例值:e71d8a535bd9cc11
DedicatedHostsobject
变更历史
暂无变更历史