tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ExecuteScalingPolicy

Last updated: 2024-10-25 15:16:36

    1. API Description

    Domain name for API request: as.tencentcloudapi.com.

    This API is used to execute a scaling policy.

    • The scaling policy can be executed based on the scaling policy ID.
    • The policy cannot be executed if there are ongoing scaling actions on the scaling group.
    • Executing a target tracking policy is not supported.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: ExecuteScalingPolicy.
    Version Yes String Common Params. The value used for this API: 2018-04-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    AutoScalingPolicyId Yes String Auto-scaling policy ID. This parameter is not available to a target tracking policy.
    HonorCooldown No Boolean Whether to check if the auto scaling group is in the cooldown period. Default value: false
    TriggerSource No String Source that triggers the scaling policy. Valid values: API and CLOUD_MONITOR. Default value: API. The value CLOUD_MONITOR is specific to the Cloud Monitor service.

    3. Output Parameters

    Parameter Name Type Description
    ActivityId String Scaling activity ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Triggering a scaling policy

    This example shows you how to trigger an alarm scaling policy.

    Input Example

    POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExecuteScalingPolicy
<Common request parameters>

{
    "HonorCooldown": "false",
    "AutoScalingPolicyId": "asp-f59pppuh"
}

    Output Example

    {
    "Response": {
        "ActivityId": "asa-o4v87ae9",
        "RequestId": "116213d6-2269-44cc-af76-c4a8dc7dbdf9"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    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
    FailedOperation.NoActivityToGenerate No scaling activity is generated.
    InternalError An internal error occurred.
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.InvalidAutoScalingPolicyId Invalid alarm-triggered policy ID.
    InvalidParameterValue.TargetTrackingScalingPolicy Executing a target tracking policy is not supported.
    ResourceInUse.AutoScalingGroupNotActive The scaling group is disabled.
    ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
    ResourceNotFound.ScalingPolicyNotFound The alarm policy does not exist.
    ResourceUnavailable.AutoScalingGroupAbnormalStatus The auto scaling group is exceptional.
    ResourceUnavailable.AutoScalingGroupInActivity The auto scaling group is active.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy