Tenant Cloud Compute Auto Scaling Scaling Group APIs DescribeAutoScalingGroups

DescribeAutoScalingGroups

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

1. Interface Description

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

This API (DescribeAutoScalingGroups) is used to query the information about scaling groups.

  • You can query the details of scaling groups based on information such as scaling group ID, scaling group name, or launch configuration ID. For more information about the supported filters, see Filters.
  • If the filtering parameters are empty, a certain number (specified by Limit and 20 by default) of scaling groups that belong to the current user will be returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2019-10-31 18:25:58.

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: DescribeAutoScalingGroups
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
AutoScalingGroupIds No No Array of String ID of one or more scaling groups, such as asg-nkdwoui0. You can specify a maximum of 100 scaling activity IDs in each request. AutoScalingGroupIds and Filters cannot be specified at the same time.
Example: ["asg-nkdwoui0\n"]
Filters No No Array of Filter Filter conditions.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.
  •  auto-scaling-group-name - String - Required: No - (Filter condition) Filter by scaling group name.
  •  launch-configuration-id - String - Required: No - (Filter condition) Filter by launch configuration ID.
  •  tag-key - String - Required: No - (Filter condition) Filter by tag key.
  •  tag-value - String - Required: No - (Filter condition) Filter by tag value.
  •  tag:tag-key - String - Required: No - (Filter condition) Filter by tag key-value pair. Replace tag-key with a specific tag key. For more information about its usage, see Example 2.
    • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. AutoScalingGroupIds and Filters cannot be specified at the same time.
    Example:View
    Limit No No Uint64 Number of returned items. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in API Introduction.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0. For more information on Offset, see the relevant section in API Introduction.
    Example: 0

    3. Output Parameters

    Parameter name Type Description
    AutoScalingGroupSet Array of AutoScalingGroup Detailed information about scaling groups.
    Example:View
    TotalCount Uint64 Number of scaling groups that meet the specified conditions.
    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
    InvalidPermission The account is not authorized to perform this operation.
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    InvalidParameterValue.Filter Invalid filter.
    InvalidFilter Invalid filter.