tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyClusterAttribute

Last updated: 2024-11-14 14:53:10

    1. API Description

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

    This API is used to modify cluster attributes.

    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: ModifyClusterAttribute.
    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
    ProjectId No Integer Project of the Cluster
    ClusterName No String Cluster name
    ClusterDesc No String Cluster description
    ClusterLevel No String Cluster specification
    AutoUpgradeClusterLevel No AutoUpgradeClusterLevel Auto-upgrades cluster specification
    QGPUShareEnable No Boolean Whether to enable qGPU Sharing
    ClusterProperty No ClusterProperty Cluster attributes

    3. Output Parameters

    Parameter Name Type Description
    ProjectId Integer Project of the Cluster
    Note: this field may return null, indicating that no valid values can be obtained.
    ClusterName String Cluster name
    Note: this field may return null, indicating that no valid values can be obtained.
    ClusterDesc String Cluster description
    Note: this field may return null, indicating that no valid values can be obtained.
    ClusterLevel String Cluster specification
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoUpgradeClusterLevel AutoUpgradeClusterLevel Auto-upgrades cluster specification
    Note: This field may return null, indicating that no valid values can be obtained.
    QGPUShareEnable Boolean Whether to enable qGPU Sharing
    Note: This field may return null, indicating that no valid value can be obtained.
    ClusterProperty ClusterProperty Cluster attributes
    Note: This field may return "null", indicating that no valid value can be obtained.
    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 cluster attributes

    This example shows you how to modify cluster attributes.

    Input Example

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

{
    "AutoUpgradeClusterLevel": {
        "IsAutoUpgrade": true
    },
    "ClusterName": "tke-test",
    "ProjectId": 0,
    "ClusterDesc": "testing",
    "ClusterId": "cls-7ph3twqe",
    "ClusterLevel": "L5",
    "ClusterProperty": {
        "NodeNameType": "lan-ip"
        }

}

    Output Example

    {
    "Response": {
        "AutoUpgradeClusterLevel": {
            "IsAutoUpgrade": true
        },
        "ClusterName": "tke-test",
        "ProjectId": 0,
        "ClusterDesc": "testing",
        "QGPUShareEnable": true,
        "RequestId": "24564577-a642-4164-8752-4668d4ca8886",
        "ClusterLevel": "L5",
        "ClusterProperty": {
            "NodeNameType": "lan-ip"
        }
    }
}

    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.ComponentClientHttp Internal HTTP client error.
    FailedOperation.TradeCommon Query failed.
    FailedOperation.UnexpectedError Unexpected error.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.Db DB error.
    InternalError.DbAffectivedRows Database error.
    InternalError.DbRecordNotFound Record not found.
    InternalError.Param Parameter error.
    InternalError.TradeCommon Billing error.
    InternalError.TradeInsufficientBalance Insufficient account balance.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter.Param Invalid parameter.
    MissingParameter Missing parameter.
    ResourceInUse The resource is occupied.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    ResourceUnavailable.ClusterState The cluster’s status does support this operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy