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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: GetUpgradeInstanceProgress. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-25. |
| Region | Yes | String | Common parameter. 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 |
| 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. |
https://tke.tencentcloudapi.com/?Action=GetUpgradeInstanceProgress
&ClusterId=cls-xxxxxx
&<Common request parameters>{
"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
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
Was this page helpful?