1. Interface Description
Interface request domain name: as.api3.convergecloud.com.
This API (ExecuteScalingPolicy) is used to run a scaling policy.
- You can run a scaling policy based on the scaling policy ID.
- When the scaling group to which a scaling policy belongs is performing a scaling activity, the system rejects to run the scaling policy.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-31 17:05:44.
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: ExecuteScalingPolicy |
| 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 |
| AutoScalingPolicyId | Yes | No | String | ID of the alarm-based scaling policy. Example: asp-f59pppuh |
| HonorCooldown | No | No | Bool | Specifies whether to check if the scaling group is in the cooldown period. Default value: false. Example: false |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ActivityId | String | ID of the scaling activity. Example: asa-o4v87ae9 |
| 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 |
|---|---|
| ResourceUnavailable.AutoScalingGroupInActivity | The auto scaling group is active. |
| InternalError | Internal error. |