tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

GetUpgradeInstanceProgress

最后更新时间：2023-09-18 16:00:25

1. API Description

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

This API is used to obtain the current progress of the node upgrade.

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: GetUpgradeInstanceProgress.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region No String Common Params. This parameter is not required for this API.
ClusterId Yes String Cluster ID
Limit No Integer Maximum number of nodes to be queried
Offset No Integer The starting node for the query

3. Output Parameters

Parameter Name Type Description
Total Integer Total nodes to upgrade
Done Integer Total upgraded nodes
LifeState String The lifecycle of the upgrade task
process: running
paused: stopped
pausing: stopping
done: completed
timeout: timed out
aborted: canceled
Instances Array of InstanceUpgradeProgressItem Details of upgrade progress of each node
ClusterStatus InstanceUpgradeClusterStatus Current cluster status
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the upgrade status

This example shows you how to query the upgrade status.

Input Example

https://tke.tencentcloudapi.com/?Action=GetUpgradeInstanceProgress
&ClusterId=cls-xxxxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "ClusterStatus": {
            "PodTotal": 0,
            "NotReadyPod": 0
        },
        "Done": 0,
        "Instances": [
            {
                "CheckResult": {
                    "CheckPass": false,
                    "Items": [
                        {
                            "After": 0,
                            "Before": 2,
                            "Namespace": "default",
                            "Pods": [
                                "kubernetes-proxy-67fd23cf4d-2tcxw",
                                "kubernetes-proxy-67fd23cf4d-qd99j"
                            ],
                            "WorkLoadKind": "ReplicaSet",
                            "WorkLoadName": "kubernetes-proxy-67fd23cf4d"
                        }
                    ],
                    "SinglePods": []
                },
                "Detail": [
                    {
                        "EndAt": null,
                        "FailedMsg": "precheck failed",
                        "LifeState": "failed",
                        "StartAt": "2023-02-08T08:29:51Z",
                        "Step": "preCheck"
                    },
                    {
                        "EndAt": null,
                        "FailedMsg": "",
                        "LifeState": "pending",
                        "StartAt": null,
                        "Step": "drain"
                    },
                    {
                        "EndAt": null,
                        "FailedMsg": "",
                        "LifeState": "pending",
                        "StartAt": null,
                        "Step": "remove"
                    },
                    {
                        "EndAt": null,
                        "FailedMsg": "",
                        "LifeState": "pending",
                        "StartAt": null,
                        "Step": "reset"
                    },
                    {
                        "EndAt": null,
                        "FailedMsg": "",
                        "LifeState": "pending",
                        "StartAt": null,
                        "Step": "postCheck"
                    }
                ],
                "EndAt": null,
                "InstanceID": "ins-wggphft5",
                "LifeState": "paused",
                "StartAt": "2023-02-08T16:29:46+08:00"
            }
        ],
        "LifeState": "aborted",
        "RequestId": "b224fa4b-fedf-4061-baa9-d547ew858df",
        "Total": 1
    }
}

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.TaskNotFound No task found
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款