tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterAsGroupOption

Last updated: 2024-11-14 14:50:00

    1. API Description

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

    Cluster auto scaling configuration

    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: DescribeClusterAsGroupOption.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String Cluster ID

    3. Output Parameters

    Parameter Name Type Description
    ClusterAsGroupOption ClusterAsGroupOption Cluster auto scaling attributes
    Note: this field may return null, indicating that no valid value was found.
    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 Configuring cluster auto scaling

    This example shows you how to configure cluster auto scaling.

    Input Example

    https://tke.tencentcloudapi.com/?Action=DescribeClusterAsGroupOption
&ClusterId=cls-hca1bmif
&<Common request parameters>

    Output Example

    {
    "Response": {
        "ClusterAsGroupOption": {
            "ScaleDownUnreadyTime": 0,
            "ScaleDownDelay": 0,
            "ScaleDownUtilizationThreshold": 0,
            "MaxTotalUnreadyPercentage": 0,
            "IsScaleDownEnabled": true,
            "OkTotalUnreadyCount": 0,
            "SkipNodesWithSystemPods": true,
            "MaxEmptyBulkDelete": 0,
            "UnregisteredNodeRemovalTime": 0,
            "SkipNodesWithLocalStorage": true,
            "IgnoreDaemonSetsUtilization": true,
            "Expander": "random",
            "ScaleDownUnneededTime": 0
        },
        "RequestId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"
    }
}

    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 Operation failed.
    FailedOperation.ClusterNotFound The cluster is not found.
    FailedOperation.ClusterState Cluster status error.
    FailedOperation.Param Invalid parameter.
    InternalError Internal error.
    InternalError.AccountUserNotAuthenticated Account not verified.
    InternalError.AsCommon Error creating scaling group resource.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.ClusterNotFound Cluster not found.
    InternalError.ClusterState Cluster status error.
    InternalError.Param Parameter error.
    InternalError.UnexceptedInternal Internal error.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy