tencent cloud

弹性伸缩

产品简介
产品概述
产品优势
应用场景
使用限制
访问管理
购买指南
快速入门
五分钟创建伸缩方案
步骤1:创建启动配置
步骤2:创建伸缩组
步骤3:创建伸缩策略
教程
创建 Web 服务
创建高性能计算集群
创建请求类服务器
配置高可用业务
启动配置
启动配置概述
创建启动配置
查看启动配置列表
更改启动配置
检测异常
伸缩组
伸缩组概述
创建伸缩组
查看伸缩组列表
修改伸缩组
修改伸缩组绑定的实例
将负载均衡与伸缩组结合
删除伸缩组
创建通知
创建伸缩活动通知
指定通知接收人
扩缩容
生命周期挂钩
管理定时任务
管理告警触发策略
实例健康检查
手动扩容
缩容处理
查看伸缩活动
暂停及恢复扩缩容
指定实例免于缩容
伸缩活动取消
伸缩活动失败
冷却时间说明
监控
监控告警指标
运行状态检查
定时任务
定时任务执行时间说明
故障处理
伸缩组失效
伸缩活动失败
实践教程
为伸缩组设置固定出口 IP
部署弹性 Web 应用服务
设置服务开机启动
客户案例
高性能计算:碳云数据挖掘
API 文档
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
常见问题
联系我们
词汇表

DescribeAutoScalingInstances

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:28:15

1. API Description

Domain name for API request: as.intl.tencentcloudapi.com.

This API (DescribeAutoScalingInstances) is used to query the information of instances associated with AS.

  • You can query the details of instances based on information such as instance ID and auto scaling group ID. For more information on filters, see Filter.
  • If the parameter is empty, a certain number (specified by Limit and 20 by default) of instances of the current user will be returned.

A maximum of 60 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAutoScalingInstances.
Version Yes String Common Params. The value used for this API: 2018-04-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N No Array of String IDs of the CVM instances to query. the instance ID list has a length limit of 100. InstanceIds and Filters cannot be specified simultaneously.
You can get available instance ids in the following ways:.
  • Query instance ID by logging in to the console.
  • .
  • Get the instance ID by calling the api DescribeInstances and retrieving the InstanceId from the returned information.
  • .
    Filters.N No Array of Filter Filter criteria

  • instance-id - String - required: no - (filter condition) filter by instance id. get the instance id by logging in to the console or making an api call to DescribeInstances, and retrieve the InstanceId from the returned information.
  • .
  • auto-scaling-group-id - String - required: no - (filter) filter by auto scaling group id. you can obtain the scaling group id by logging in to the console or making an api call to DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the returned information.
  • .
    The maximum number of Filters per request is 10, and the maximum number of Filter.Values is 5. parameters do not support specifying both InstanceIds and Filters.
    Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section in the API overview.
    Limit No Integer The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction.

    3. Output Parameters

    Parameter Name Type Description
    AutoScalingInstanceSet Array of Instance List of instance details.
    TotalCount Integer Number of eligible instances.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Viewing Instances

    This example shows you how to query information of the instance based on the specified instance ID or filter criteria.

    Input Example

    POST / HTTP/1.1
    Host: as.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAutoScalingInstances
    <Common request parameters>
    
    {
        "InstanceIds": [
            "ins-1fswxz1m"
        ]
    }

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "AutoScalingInstanceSet": [
                {
                    "ProtectedFromScaleIn": false,
                    "Zone": "ap-guangzhou-3",
                    "LaunchConfigurationId": "asc-5fzsm72a",
                    "InstanceId": "ins-1fswxz1m",
                    "VersionNumber": 1,
                    "DisasterRecoverGroupIds": [],
                    "AddTime": "2018-08-21T12:05:12Z",
                    "CreationType": "AUTO_CREATION",
                    "AutoScalingGroupName": "asgname",
                    "AutoScalingGroupId": "asg-4o61gsxi",
                    "HealthStatus": "HEALTHY",
                    "LifeCycleState": "IN_SERVICE",
                    "LaunchConfigurationName": "Series 2 local disk",
                    "InstanceType": "S2.SMALL2",
                    "WarmupStatus": "IN_WARMUP"
                }
            ],
            "RequestId": "2ae3e836-d47a-431c-b54b-4e1c2f419e5b"
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError An internal error occurred.
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.
    InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.InvalidFilter Invalid filter condition.
    InvalidParameterValue.InvalidInstanceId Invalid instance ID.
    InvalidParameterValue.LimitExceeded The value exceeds the limit.
    LimitExceeded.FilterValuesTooLong Too many values for the specified filter

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈