DescribeClusterAddonsUpgradeStatus API reference and deprecation notice - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Note

This API has been deprecated. We recommend migrating to CS(2015-12-15) - ListClusterAddonInstances 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:DescribeClusterAddonsUpgradeStatus

get

*Cluster

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
componentIds	array	Yes	The list of component names.
	string	Yes	The component name.	metric-server

Response elements

Element	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.