tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateClusterKubeconfig

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

    1. API Description

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

    This API is used to update the Kubeconfig information of a cluster.

    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: UpdateClusterKubeconfig.
    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 The cluster ID.
    SubAccounts.N No Array of String List of sub-account UINs. If it’s not specified, the SubUin used to invoke this API is used.

    3. Output Parameters

    Parameter Name Type Description
    UpdatedSubAccounts Array of String List of updated sub-account UINs
    Note: This parameter may return null, indicating that no valid values 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 Updating the Kubeconfig information of a cluster

    This example shows you how to update the Kubeconfig information of a cluster.

    Input Example

    https://tke.tencentcloudapi.com/?Action=UpdateClusterKubeconfig 
&ClusterId=cls-65r1c5nu 
&SubAccounts.0=123456 
&SubAccounts.1=123457 
&SubAccounts.2=123458 
&<Common request parameters>

    Output Example

    {
    "Response": {
        "UpdatedSubAccounts": [
            "123456",
            "123457",
            "1234568"
        ],
        "RequestId": "33483fde-efec-4d3c-8ff6-340d9dbc2d01"
    }
}

    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 Internal error.
    InternalError.Db DB error.
    InternalError.KubernetesPatchOperationError Kubernetes Patch operation failed.
    InvalidParameter Parameter error.
    InvalidParameter.Param Invalid parameter.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy