查询实例

最近更新时间: 2024-09-03 18:49:37

1. 接口描述

接口请求域名: as.api3.cloud.sunhongs.com。

本接口(DescribeAutoScalingInstances)用于查询弹性伸缩关联实例的信息。

  • 可以根据实例ID、伸缩组ID等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter。
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的实例。

默认接口请求频率限制:10次/秒。

接口更新时间:2019-10-31 18:28:18。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeAutoScalingInstances
Version 是 否 String 公共参数,本接口取值:2018-04-19
Region 是 否 String 公共参数,详见产品支持的地域列表(TODO)
InstanceIds 否 否 Array of String 待查询云服务器(CVM)的实例ID。参数不支持同时指定InstanceIds和Filters。
Filters 否 否 Array of Filter 过滤条件。<br><li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。</li><br><li> auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。</li><br>每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。
Offset 否 否 Int64 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit 否 否 Int64 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

3. 输出参数

参数名称 类型 描述
AutoScalingInstanceSet Instance 实例详细信息列表。
TotalCount Uint64 符合条件的实例数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
InvalidParameter.Conflict
InvalidParameterValue.Filter
InvalidFilter
InternalError