tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyClusterRuntimeConfig

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

1. API Description

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

This API is used to modify the latitude runtime configuration of clusters and node pools.

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: ModifyClusterRuntimeConfig.
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, required
DstK8SVersion No String This field is required when it is required to modify the runtime version based on another K8S version. For example, in scenarios where conflicts occur during upgrade verification.
ClusterRuntimeConfig No RuntimeConfig This field is required when it is required to modify the runtime of a cluster.
NodePoolRuntimeConfig.N No Array of NodePoolRuntime This field is required when it is required to modify the runtime of a node pool, specifying the part to be modified.

3. Output Parameters

Parameter Name Type Description
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 the cluster runtime configuration

Input Example

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

{
    "ClusterId": "clx-o8hjuza0",
    "DstK8SVersion": "1.24.4",
    "ClusterRuntimeConfig": {
        "RuntimeType": "containerd",
        "RuntimeVersion": "1.6.9"
    },
    "NodePoolRuntimeConfig": [
        {
            "NodePoolId": "np-3z37njiu",
            "RuntimeType": "containerd",
            "RuntimeVersion": "1.6.9",
            "NodePoolName": "np-test"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "fb370cb6-df57-4077-hjxk-758225788b9b"
    }
}

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
AuthFailure CAM signature/authentication error.
InternalError Internal error.
InternalError.Db DB error.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
MissingParameter Missing parameter.
ResourceUnavailable Resource is unavailable
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy