GetUpgradeInstanceProgress

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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
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

Input Example

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

Output Example

{
  "Response": {
    "LifeState": "xx",
    "Instances": [
      {
        "StartAt": "xx",
        "InstanceID": "xx",
        "Detail": [
          {
            "StartAt": "xx",
            "Step": "xx",
            "LifeState": "xx",
            "EndAt": "xx",
            "FailedMsg": "xx"
          },
          {
            "LifeState": "xx",
            "Step": "xx",
            "StartAt": "xx",
            "EndAt": "xx",
            "FailedMsg": "xx"
          },
          {
            "LifeState": "xx",
            "Step": "xx",
            "StartAt": "xx",
            "EndAt": "xx",
            "FailedMsg": "xx"
          },
          {
            "LifeState": "xx",
            "Step": "xx",
            "StartAt": "xx",
            "EndAt": "xx",
            "FailedMsg": "xx"
          }
        ],
        "EndAt": "xx",
        "CheckResult": {
          "Items": [
            {
              "WorkLoadKind": "xx",
              "After": 1,
              "Namespace": "xx",
              "WorkLoadName": "xx",
              "Pods": [
                "xx"
              ],
              "Before": 1
            }
          ],
          "CheckPass": true,
          "SinglePods": [
            "xx"
          ]
        },
        "LifeState": "xx"
      }
    ],
    "Done": 1,
    "RequestId": "xx",
    "ClusterStatus": {
      "PodTotal": 0,
      "NotReadyPod": 0
    },
    "Total": 3
  }
}

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

Tencent Cloud CLI 3.0

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
InvalidParameter.Param	Invalid parameter.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages