tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyScalingPolicy

Last updated: 2024-11-27 15:17:53

    1. API Description

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

    This API (ModifyScalingPolicy) is used to modify an alarm trigger policy.

    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: ModifyScalingPolicy.
    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 Alarm policy ID.
    ScalingPolicyName No String Alarm policy name.
    AdjustmentType No String The method to adjust the desired capacity after the alarm is triggered. It’s only available when ScalingPolicyType is Simple. Valid values:
  • CHANGE_IN_CAPACITY: Increase or decrease the desired capacity
  • EXACT_CAPACITY: Adjust to the specified desired capacity
  • PERCENT_CHANGE_IN_CAPACITY: Adjust the desired capacity by percentage
    • AdjustmentValue No Integer The adjustment value for the expected number of instances after an alarm is triggered. It applies only to simple policies.
  • When AdjustmentType is CHANGE_IN_CAPACITY, a positive AdjustmentValue indicates an increase in the number of instances after the alarm is triggered, and a negative AdjustmentValue indicates a decrease in the number of instances after the alarm is triggered.
  • When AdjustmentType is EXACT_CAPACITY, the value of AdjustmentValue represents the expected number of instances after the alarm is triggered, which should be greater than or equal to 0.
  • When AdjustmentType is PERCENT_CHANGE_IN_CAPACITY, a positive AdjustmentValue indicates an increase in the number of instances by percentage after the alarm is triggered, and a negative AdjustmentValue indicates a decrease in the number of instances by percentage after the alarm is triggered. The unit is: %.
    		•
    Cooldown No Integer Cooldown period (in seconds). It’s only available when ScalingPolicyType is Simple.
    MetricAlarm No MetricAlarm Alarm monitoring metric. It’s only available when ScalingPolicyType is Simple.
    PredefinedMetricType No String Preset monitoring item. It’s only available when ScalingPolicyType is TARGET_TRACKING. Valid values:
  • ASG_AVG_CPU_UTILIZATION: Average CPU utilization
  • ASG_AVG_LAN_TRAFFIC_OUT: Average private bandwidth out
  • ASG_AVG_LAN_TRAFFIC_IN: Average private bandwidth in
  • ASG_AVG_WAN_TRAFFIC_OUT: Average public bandwidth out
  • ASG_AVG_WAN_TRAFFIC_IN: Average public bandwidth in
    		•
    TargetValue No Integer Target value. It’s only available when ScalingPolicyType is TARGET_TRACKING. Value ranges:
  • ASG_AVG_CPU_UTILIZATION (in %): [1, 100)
  • ASG_AVG_LAN_TRAFFIC_OUT (in Mbps): >0
  • ASG_AVG_LAN_TRAFFIC_IN (in Mbps): >0
  • ASG_AVG_WAN_TRAFFIC_OUT (in Mbps): >0
  • ASG_AVG_WAN_TRAFFIC_IN (in Mbps): >0
    		•
    EstimatedInstanceWarmup No Integer Instance warm-up period (in seconds). It’s only available when ScalingPolicyType is TARGET_TRACKING. Value range: 0-3600.
    DisableScaleIn No Boolean Whether to disable scale-in. It’s only available when ScalingPolicyType is TARGET_TRACKING. Valid values:
  • true: Scaling in is not allowed.
  • false: Allows both scale-out and scale-in
    		•
    NotificationUserGroupIds.N No Array of String This parameter is diused. Please use CreateNotificationConfiguration instead.
    Notification group ID, which is the set of user group IDs.

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying the Simple Alarm Triggering Policy

    This example shows you how to specify the policy ID to modify the attributes of a simple policy.

    Input Example

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

{
    "AutoScalingPolicyId": "asp-iir70sxv",
    "Cooldown": "60",
    "ScalingPolicyName": "cpu_policy_test",
    "AdjustmentType": "CHANGE_IN_CAPACITY",
    "MetricAlarm": {
        "Period": "60",
        "ContinuousTime": "5",
        "ComparisonOperator": "GREATER_THAN",
        "Statistic": "AVERAGE",
        "Threshold": "50",
        "MetricName": "CPU_UTILIZATION"
    },
    "NotificationUserGroupIds": [
        "1678"
    ],
    "AdjustmentValue": "1"
}

    Output Example

    {
    "Response": {
        "RequestId": "91413a64-9587-486b-aef4-9aba5e8a0068"
    }
}

    Example2 Modifying the Target Tracking Alarm Triggering Policy

    This example shows you how to specify the policy ID to modify the attributes of a target tracking policy.

    Input Example

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

{
    "AutoScalingPolicyId": "asp-9uroe7ta",
    "ScalingPolicyName": "target-trackiing-test-policy",
    "DisableScaleIn": false,
    "EstimatedInstanceWarmup": 300,
    "TargetValue": 60,
    "PredefinedMetricType": "ASG_AVG_CPU_UTILIZATION"
}

    Output Example

    {
    "Response": {
        "RequestId": "881a6752-55e8-4485-878a-a80065732a9f"
    }
}

    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
    InternalError.RequestError An internal request error occurred.
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.InvalidAutoScalingPolicyId Invalid alarm-triggered policy ID.
    InvalidParameterValue.InvalidNotificationUserGroupId The notification group ID should be a numeric string.
    InvalidParameterValue.Range The value is outside the specified range.
    InvalidParameterValue.ScalingPolicyNameDuplicate The alarm policy name already exists.
    InvalidParameterValue.ThresholdOutOfRange The specified threshold must be within the valid range.
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
    ResourceNotFound.ScalingPolicyNotFound The alarm policy does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy