ListClusterAddonInstances - ENS - Alibaba Cloud Documentation Center

Retrieves a list of add-on instances installed in a destination cluster and returns information such as their version and status.

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

ens:ListClusterAddonInstances

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	eck-xxxxxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	125B04C7-3D0D-4245-AF96-14E3758E3F06
Addons	array<object>	The list of add-on information.
	array<object>	The information about the add-on.
Name	string	The name of the add-on.	test1
Version	string	The version number.	v1
CleanupCloudResources	boolean	Specifies whether to automatically clean up associated cloud resources.	true
Status	string	The current status of the component. Valid values: enabling: The component is being enabled. enabled: The component is enabled. disabling: The component is being disabled. disabled: The component is disabled. upgrading: The component is being upgraded.	enabled
ConfigSchema	array<object>	The list of schemas for the custom parameters of the component.
	object	The schema for the custom parameters of the component.
AppVersion	string	The application version.	7380581386597434629002
ConfigVersion	string	The configuration version.	4572581386436834662215
Name	string	The name of the component.	edge-csi-lite
Params	string	The custom parameters of the component.	{"key1": "val1"}

Examples

Success response

JSON format

{
  "RequestId": "125B04C7-3D0D-4245-AF96-14E3758E3F06",
  "Addons": [
    {
      "Name": "test1",
      "Version": "v1",
      "CleanupCloudResources": true,
      "Status": "enabled",
      "ConfigSchema": [
        {
          "AppVersion": "7380581386597434629002",
          "ConfigVersion": "4572581386436834662215",
          "Name": "edge-csi-lite",
          "Params": "{\"key1\": \"val1\"}"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadRequest	Request param error.	Request parameter error

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.