All Products
Search
Document Center

Container Service for Kubernetes:ListAddons

Last Updated:Nov 07, 2024

Queries the available components based on specific conditions such as the region, cluster type, cluster subtype defined by cluster profile, and cluster version and queries the detailed information about a component. The information includes whether the component is managed, the supported custom parameter schema, and compatible operating system architecture.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:ListAddonslist
  • All Resources
    *
    none
none

Request syntax

GET /addons HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
region_idstringNo

The region of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.

cn-hangzhou
cluster_typestringNo

The type of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.

ManagedKubernetes
profilestringNo

The subtype of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.

Default
cluster_specstringNo

The specifications of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.

ack.pro.small
cluster_versionstringNo

The version of the cluster. If cluster_id is specified, this parameter is ignored. You must specify the region_id, cluster_type, profile, cluster_spec, and cluster_version parameters at the same time.

1.26.3-aliyun.1
cluster_idstringNo

The cluster ID. If you specify a cluster ID, only components used in the specified cluster are queried. Other parameters are ignored.

c02b3e03be10643e8a644a843ffcb****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

addonsarray<object>

The list of available components.

addonsobject
namestring

The component name.

arms-prometheus
versionstring

The version number.

1.1.9
managedboolean

Indicates whether the component is fully managed.

false
install_by_defaultboolean

Indicates whether the component is automatically installed by default.

false
categorystring

The category of the component.

monitor
config_schemastring

The schema of the custom parameters of the component.

{}
supported_actionsarray

Operations supported by the component. Valid values:

  • Install
  • Upgrade
  • Modify
  • Uninstall
supported_actionsstring

Operations supported by the component. Valid values:

  • Install
  • Upgrade
  • Modify
  • Uninstall
Install
architecturearray

Architectures supported by the component. Valid values:

  • amd64
  • arm64
architecturestring

Operations supported by the component. Valid values:

  • Install
  • Upgrade
  • Modify
  • Uninstall
amd64

Examples

Sample success responses

JSONformat

{
  "addons": [
    {
      "name": "arms-prometheus",
      "version": "1.1.9",
      "managed": false,
      "install_by_default": false,
      "category": "monitor",
      "config_schema": "{}",
      "supported_actions": [
        "Install"
      ],
      "architecture": [
        "amd64"
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history