Tenant Cloud Compute Auto Scaling Scaling Group APIs DescribeAutoScalingInstances

DescribeAutoScalingInstances

Last Updated At: 2026-08-02 00:05:30

1. Interface Description

Interface request domain name: as.api3.convergecloud.com.

This API (DescribeAutoScalingInstances) is used to query the information about instances associated with Auto Scaling.

  • You can query the details of instances based on information such as the instance ID and scaling group ID. For more information about the supported filters, see Filters.
  • If you specified no filters in the request, the returned number of instances is determined by the Limit parameter in the request. The default value of the Limit parameter is 20.

Default interface request rate limit: 10 times per second.

Interface update time: 2019-10-31 18:28:18.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeAutoScalingInstances
Version Yes No String Public parameter, The value of this interface: 2018-04-19
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds No No Array of String IDs of the CVM instances to query. InstanceIds and Filters cannot be specified at the same time.
Example: ["ins-1fswxz1m\n"]
Filters No No Array of Filter Filter conditions.
  •  instance-id - String - Required: No - (Filter condition) Filter by instance ID.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.
    • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. InstanceIds and Filters cannot be specified at the same time.
    Example:View
    Offset No No Int64 Offset. Default value: 0. For more information on Offset, see the relevant section in API Introduction.
    Example: 0
    Limit No No Int64 Number of returned items. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in API Introduction.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    AutoScalingInstanceSet Array of Instance The information about the instances.
    Example:View
    TotalCount Uint64 Total number of IP address template groups returned.
    Example: 1
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.
    InvalidFilter Invalid filter.
    InternalError Internal error.