Help & DocumentationAuto ScalingAPI DocumentationScaling Group APIsDescribeAutoScalingInstances

DescribeAutoScalingInstances

Last updated: 2019-12-05 14:06:57

PDF

Contents：

1. API Description

Domain name for API request: as.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 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeAutoScalingInstances
Version Yes String Common parameter. The value used for this API: 2018-04-19
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N No Array of String ID of the CVM instance to be queried. This parameter does not support specifying both InstanceIds and Filters at the same time.
Filters.N No Array of Filter Filter.
  • instance-id - String - Required: No - (Filter) Filter by instance ID.
  • auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.

    • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. This parameter does not support specifying both InstanceIds and Filters at the same time.
    Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section in the API overview.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in the API overview.

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a Specified Instance

    Input Example

    https://as.tencentcloudapi.com/?Action=DescribeAutoScalingInstances
&InstanceIds.0=ins-1fswxz1m
&<Common request parameter>

    Output Example

    {
  "Response": {
    "TotalCount": 1,
    "AutoScalingInstanceSet": [
      {
        "ProtectedFromScaleIn": false,
        "Zone": "ap-guangzhou-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": "series 2 local disk",
        "InstanceType": "S2.SMALL2"
      }
    ],
    "RequestId": "2ae3e836-d47a-431c-b54b-4e1c2f419e5b"
  }
}

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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 Internal error.
    InvalidFilter Invalid filter.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.