tencent cloud

文档反馈

ModifyApplicationAutoscaler

最后更新时间:2023-12-04 16:38:14

    1. API Description

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

    This API is used to modify a scaling rule.

    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: ModifyApplicationAutoscaler.
    Version Yes String Common Params. The value used for this API: 2021-07-01.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ApplicationId Yes String Application ID
    EnvironmentId Yes String Environment ID
    SourceChannel No Integer Source channel. Please keep the default value.
    AutoscalerId No String Scaling rule ID
    Autoscaler No Autoscaler Auto scaling policy

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether the action is successful
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a scalin rule

    This example show you how to modify a scaling rule.

    Input Example

    POST / HTTP/1.1
    Host: tem.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyApplicationAutoscaler
    <Common request parameters>
    
    {
        "SourceChannel": 0,
        "AutoscalerId": "xx",
        "Autoscaler": {
            "ModifyDate": "xx",
            "Description": "xx",
            "CronHorizontalAutoscaler": [
                {
                    "Priority": 0,
                    "Schedules": [
                        {
                            "StartAt": "xx",
                            "TargetReplicas": 0
                        }
                    ],
                    "Enabled": true,
                    "Period": "xx",
                    "Name": "xx"
                }
            ],
            "MinReplicas": 0,
            "AutoscalerId": "xx",
            "Enabled": true,
            "HorizontalAutoscaler": [
                {
                    "MinReplicas": 0,
                    "Metrics": "xx",
                    "Enabled": true,
                    "Threshold": 0,
                    "MaxReplicas": 0
                }
            ],
            "EnableDate": "xx",
            "AutoscalerName": "xx",
            "CreateDate": "xx",
            "MaxReplicas": 0
        },
        "ApplicationId": "xx",
        "EnvironmentId": "xx"
    }
    

    Output Example

    {
        "Response": {
            "Result": true,
            "RequestId": "xx"
        }
    }
    

    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.DefaultInternalError The server is busy. Retry later.
    InvalidParameterValue.AtLeastOneScalerRuleShouldBeApplied Please enable at least one type of scaling rules.
    InvalidParameterValue.AutoScalerLargerThanOne Only one auto scaler can be specified.
    InvalidParameterValue.CronHpaReplicasInvalid The specified desired capacity of the scheduled action is incorrect.
    InvalidParameterValue.HpaMinMaxInvalid The minimum or maximum number for auto scaling is invalid.
    MissingParameter.MinMaxNumNull The minimum and maximum number for auto scaling are required.
    MissingParameter.ScalerIdNull The scaling rule ID is missing.
    ResourceUnavailable.ApplicationStopped The application is stopped.
    UnauthorizedOperation.UnauthorizedOperation Not authorized