tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyClusterImage

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

1. API Description

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

This API is used to modify the cluster image.

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: ModifyClusterImage.
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
ImageId Yes String Specifies a valid image ID in the format like img-xxxx. You can query it by logging in to the console, or by calling the API DescribeImages to get the ImageId field in the returned information.

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 cluster image

Input Example

https://tke.tencentcloudapi.com/?Action=ModifyClusterImage
&ClusterId=cls-xxxxxxxx
&ImageId=img-xxxxxxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "0b45d041-0f53-428f-ac89-51375d018e95"
    }
}

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.DbRecordNotFound Record not found.
FailedOperation.Param Invalid parameter.
InternalError Internal error.
InternalError.CvmCommon Error in node creation.
InternalError.Db DB error.
InternalError.DbRecordNotFound Record not found.
InternalError.ImageIdNotFound Image not found.
InternalError.OsNotSupport Image OS not supported.
InternalError.Param Parameter error.
InternalError.UnexceptedInternal Internal error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.VersionNotSupportCgroupV2 In customer creation parameters, k8s version, runtime version, or tke-eni-agent version do not support the chosen operating system's CgroupV2.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy