GetUpgradeStatus - Container Service for Kubernetes - Alibaba Cloud Documentation Center

This API is deprecated. You are advised to use CS(2015-12-15) - DescribeTaskInfo.

You can call the GetUpgradeStatus operation to query the update progress of a cluster by cluster ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:GetUpgradeStatus	get	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request syntax

GET /api/v2/clusters/{ClusterId}/upgrade/status HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c106f377e16f34eb1808d6b9362c9****

Response parameters

Parameter	Type	Description	Example
	object	The details about the update progress of the cluster.
error_message	string	The error message returned during the update.	subject to actual return
precheck_report_id	string	The ID of the precheck report.	be4c8eb72de94d459ea7ace7c811d119
status	string	The status of the update. Valid values: `success`: The update is successful. `fail`: The update failed. `pause`: The update is paused. `running`: The update is in progress.	running
upgrade_step	string	The current phase of the update. Valid values: `not_start`: The update is not started. `prechecking`: The precheck is in progress. `upgrading`: The cluster is being updated. `pause`: The update is paused. `success`: The update is successful.	prechecking
upgrade_task	object	The details of the update task.
status	string	The status of the update task. Valid values: `running`: The update task is being executed. `Success`: The update task is successfully executed. `Failed`: The update task failed.	running
message	string	The description of the update task.	subject to actual return

Examples

Sample success responses

JSONformat

{
  "error_message": "subject to actual return",
  "precheck_report_id": "be4c8eb72de94d459ea7ace7c811d119",
  "status": "running",
  "upgrade_step": "prechecking",
  "upgrade_task": {
    "status": "running",
    "message": "subject to actual return"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-18	The API operation is deprecated	View Change Details