查询实例

最近更新时间: 2026-09-17 00:04:45

1. 接口描述

接口请求域名: as.api3.fincloud.tencent.cn。

本接口(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 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds Array of String 待查询云服务器(CVM)的实例ID。参数不支持同时指定InstanceIds和Filters。
示例值: ["ins-1fswxz1m\n"]
Filters Array of Filter 过滤条件。
  •  instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。
  •  auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。
  • 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIdsFilters
    示例值:查看
    Offset Int64 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值: 0
    Limit Int64 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值: 20

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidParameter.Conflict 参数冲突,指定的多个参数冲突,不能同时存在。
    InvalidParameterValue.Filter 无效的过滤器。
    InvalidFilter 无效的过滤器。
    InternalError 内部错误

    5. 示例

    示例1 查询指定实例

    输入示例

    https://as.api3.fincloud.tencent.cn/?Action=DescribeAutoScalingInstances
    &InstanceIds.0=ins-1fswxz1m
    &<公共请求参数>
    

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "AutoScalingInstanceSet": [
                {
                    "ProtectedFromScaleIn": false,
                    "Zone": "ap-region-3",
                    "LaunchConfigurationId": "asc-5fzsm72a",
                    "InstanceId": "ins-1fswxz1m",
                    "VersionNumber": 1,
                    "AddTime": "2018-08-21T12:05:12Z",
                    "CreationType": "AUTO_CREATION",
                    "AutoScalingGroupId": "asg-4o61gsxi",
                    "HealthStatus": "HEALTHY",
                    "LifeCycleState": "IN_SERVICE",
                    "LaunchConfigurationName": "系列2本地盘",
                    "InstanceType": "S2.SMALL2"
                }
            ],
            "RequestId": "2ae3e836-d47a-431c-b54b-4e1c2f419e5b"
        }
    }