Use GetUpgradeStatus to query cluster upgrade progress - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Note

This API has been deprecated. We recommend migrating to CS(2015-12-15) - DescribeTaskInfo for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:GetUpgradeStatus

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.