DescribeClusterAddonsUpgradeStatus - Container Service for Kubernetes

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

You can call the DescribeClusterAddonsUpgradeStatus operation to query the update progress of a component by component name.

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:DescribeClusterAddonsUpgradeStatus	get	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	none	none

Request syntax

GET /clusters/{ClusterId}/components/upgradestatus HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c23421cfa74454bc8b37163fd19af****
componentIds	array	Yes	The list of component names.
	string	Yes	The component name.	metric-server

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
	object	The details about the update progress of the components.
addon_info	object	The information about the component.
component_name	string	The name of the component.	cloud-controller-manager
version	string	The current version of the component.	v1.9.3.340-g9830b58-aliyun
ready_to_upgrade	string	Indicates whether the component meets the update conditions. Valid values: `true`: The component meets the update conditions. `false`: The component does not meet the update conditions.	true
tasks	object	The details of the update task.
created_at	string	The start time of the task.	2020-12-28T17:00:50Z
finished_at	string	The end time of the task.	2020-12-28T17:05:36Z
status	string	The status of the update task. Valid values: `Upgrading`: The update task is in progress. `Success`: The update task is successful. `Failed`: The update task failed. `Running`: The component is being installed. `Paused`: The update task is paused. `Canceled:` The update task is canceled.	Success
is_canceled	boolean	Indicates whether the update task is canceled. Valid values: `true`: The update task is canceled. `false`: The update task is not canceled.	false

Examples

Sample success responses

JSONformat

{
  "key": {
    "addon_info": {
      "component_name": "cloud-controller-manager",
      "version": "v1.9.3.340-g9830b58-aliyun",
      "ready_to_upgrade": "true"
    },
    "tasks": {
      "created_at": "2020-12-28T17:00:50Z",
      "finished_at": "2020-12-28T17:05:36Z",
      "status": "Success",
      "is_canceled": false
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-01-12	The API operation is deprecated	View Change Details