DescribeScalingPolicies

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

1. Interface Description

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

This API (DescribeScalingPolicies) is used to query alarm trigger policies.

Default interface request rate limit: 20 times per second.

Interface update time: 2019-10-31 18:33:02.

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: DescribeScalingPolicies
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
AutoScalingPolicyIds No No Array of String ID of one or more alarm policies, such as asp-i9vkg894. You can specify a maximum of 100 instance IDs in each request. AutoScalingPolicyIds and Filters cannot be specified at the same time.
Example: ["asp-5zffv598\n"]
Filters No No Array of Filter Filter conditions.
  •  auto-scaling-policy-id - String - Required: No - (Filter condition) Filter by alarm policy ID.
  •  auto-scaling-group-id - String - Required: No - (Filter condition) Filter by scaling group ID.
  •  scaling-policy-name - String - Required: No - (Filter condition) Filter by alarm policy name.
  • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. AutoScalingPolicyIds 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: 20
    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
    ScalingPolicySet Array of ScalingPolicy Details of Auto Scaling alarm trigger policies.
    Example:View
    TotalCount Uint64 Number of notifications 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
    InvalidParameter.Conflict Multiple parameters specified conflict and cannot co-exist.
    LimitExceeded The quota limit is exceeded.
    InvalidFilter Invalid filter.