tencent cloud

文档反馈

CreateApplicationAutoscaler

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

    1. API Description

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

    This API is used to create 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: CreateApplicationAutoscaler.
    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.
    Autoscaler No Autoscaler Auto scaling rule

    3. Output Parameters

    Parameter Name Type Description
    Result String Scaling rule ID
    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 Creating a scaling rule

    This example shows you how to create a scaling rule.

    Input Example

    POST / HTTP/1.1
    Host: tem.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateApplicationAutoscaler
    <Common request parameters>
    
    {
        "SourceChannel": 0,
        "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": "xx",
            "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.AutoScalerNameInvalid
    InvalidParameterValue.CronHpaReplicasInvalid The specified desired capacity of the scheduled action is incorrect.
    InvalidParameterValue.HpaMetricsInvalid The desired capacity of scaling is incorrect.
    InvalidParameterValue.HpaThresholdInvalid Invalid elastic scaling threshold
    InvalidParameterValue.InvalidCronScalerPeriod Invalid scheduled period
    InvalidParameterValue.NamespaceNotBelongToAppid The namespace does not belong to the current account.
    InvalidParameterValue.ScalerNameDuplicated The auto scaler name already exists.
    MissingParameter.AutoScalerNameNull The scaling rule name cannot be empty
    MissingParameter.MinMaxNumNull The minimum and maximum number for auto scaling are required.
    ResourceNotFound.ServiceNotFound The application is not found.
    ResourceNotFound.ServiceRunningVersionNotFound No running pod is found.
    ResourceUnavailable.ApplicationStopped The application is stopped.
    UnauthorizedOperation.UnauthorizedOperation Not authorized