tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateEdgeClusterVersion

Last updated: 2023-09-18 16:00:12

1. API Description

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

This API is used to upgrade an edge cluster component to a TKE Edge version.

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: UpdateEdgeClusterVersion.
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
EdgeVersion Yes String Target version
RegistryPrefix No String Prefix of the image repository of a custom edge component
SkipPreCheck No Boolean Whether to skip precheck

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading an edge cluster

u200dThis example shows you how to upgrade an edge cluster add-on.

Input Example

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

{
    "ClusterId": "cls-xxxxxxxx",
    "EdgeVersion": "1.0.1"
}

Output Example

{
    "Response": {
        "RequestId": "2ac430cd-f7de-482e-b98e-f78a48e785e8"
    }
}

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.ClusterUpgradeNodeVersion The version of the cluster node is too old.
InternalError Internal error.
InternalError.ClusterUpgradeNodeVersion The version of the cluster node is outdated.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy