DescribeDedicatedHostClusters_云服务器 ECS_API文档

插件下载了解更多
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.

接口说明

请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数DedicatedHostClusterIds的值如果是一个空 JSON 数组,即[],则视为该过滤器有效,且返回值为空。

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:DescribeDedicatedHostClusters
Get
DedicatedHostCluster
acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}
DedicatedHostCluster
acs:ecs:{#regionId}:{#accountId}:ddhcluster/*

请求参数

字段名称字段详情
Statusstring
说明 该参数暂未上线,不支持使用。
示例值:null
LockReasonstring
说明 该参数暂未上线,不支持使用。
示例值:null
ResourceGroupIdstring

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

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

标签列表。

子级条数 <= 20
RegionIdstring

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

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

专有宿主机组所在的可用区 ID。您可以调用 DescribeZones 查看阿里云地域下的可用区。

示例值:cn-hangzhou-f参考取值来源:
    DescribeZones
DedicatedHostClusterIdsstring

专有宿主机组 ID 列表。取值可以由多个专有宿主机组 ID 组成一个 JSON 数组,格式为["dc-xxxxxxxxx", "dc-yyyyyyyyy", … ,"dc-zzzzzzzzz"]。支持最多 100 个 ID,用半角逗号字符隔开。

示例值:["dc-bp12wlf6am0vz9v2****", "dc-bp12wlf6am0vz9v3****"]参考取值来源:
    CreateDedicatedHostCluster
    DescribeDedicatedHosts
DedicatedHostClusterNamestring

专有宿主机组名称。

示例值:myDDHCluster
PageNumberinteger<int32>

专有宿主机组状态列表的页码。展开详情

示例值:1取值 >= 1
PageSizeinteger<int32>

分页查询时设置的每页行数。展开详情

示例值:5取值 <= 100

返回参数

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

输入时设置的每页行数。

示例值:5
RequestIdstring

请求 ID。

示例值:214A2187-B06F-4E49-A081-4D053466A8C7
PageNumberinteger<int32>

专有宿主机组状态列表的页码。

示例值:1
TotalCountinteger<int32>

专有宿主机总个数。

示例值:2
DedicatedHostClustersobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
MissingParamter.RegionId
The regionId should not be null.诊断
400
InvalidParameter.DedicatedHostClusterIds
The specified parameter dedicatedHostClusterIds is not valid.诊断
400
InvalidRegion.NotFound
The specified parameter RegionId is not valid.诊断
400
InvalidZone.NotFound
The specified parameter ZoneId is not valid.诊断
403
InvalidDedicatedHostIds.Malformed
The amount of specified dedicatedHostClusterIds exceeds the limit.诊断

变更历史

暂无变更历史

相关示例