All Products
Search
Document Center

Container Service for Kubernetes:DescribeAddons

Last Updated:Feb 29, 2024

You can call the DescribeAddons operation to query the details about all components that are supported by Container Service for Kubernetes (ACK).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeAddonsRead
  • All Resources
    *
    none
none

Request syntax

GET /clusters/components/metadata

Request parameters

ParameterTypeRequiredDescriptionExample
regionstringYes

The region ID of the cluster.

cn-beijing
cluster_typestringNo

The type of cluster. Valid values:

  • Kubernetes: ACK dedicated cluster.
  • ManagedKubernetes: ACK managed cluster. ACK managed clusters include ACK Pro clusters, ACK Basic clusters, ACK Serverless Pro clusters, ACK Serverless Basic clusters, ACK Edge Pro clusters, and ACK Edge Basic clusters.
  • ExternalKubernetes: registered cluster.
kubernetes
cluster_profilestringNo

The type of cluster. Valid values:

  • Default: ACK managed cluster
  • Serverless: ACK Serverless cluster
  • Edge: ACK Edge cluster
Default
cluster_specstringNo

The edition of the cluster. If you set the cluster type to ManagedKubernetes, the following editions are supported:

  • ack.pro.small: ACK Pro cluster
  • ack.standard: ACK Basic cluster

By default, this parameter is left empty. If you leave this parameter empty, clusters are not filtered by edition.

ack.pro.small
cluster_versionstringNo

The cluster version.

1.24.6-aliyun.1

Response parameters

ParameterTypeDescriptionExample
object

The response body parameters.

ComponentGroupsobject []

The list of the returned components.

group_namestring

The name of the component group.

storage
itemsobject []

The names of the components in the component group.

namestring

The name of the component.

flexvolume
StandardComponentsobject

Standard components.

object

The details of the standard components.

namestring

The name of the component.

ack-arena
versionstring

The version of the component.

0.5.0
descriptionstring

The description of the component.

***
requiredstring

Indicates whether the component is a required component. Valid values:

  • true: The component is required and must be installed when a cluster is created.
  • false: The component is optional. After a cluster is created, you can go to the Add-ons page to install the component.
false
disabledboolean

Indicates whether the automatic installation of the component is disabled. By default, some optional components, such as components for logging and Ingresses, are installed when a cluster is created. You can set this parameter to disable automatic component installation. Valid values:

  • true: disables automatic component installation.
  • false: enables automatic component installation.
false

Examples

Sample success responses

JSONformat

{
  "ComponentGroups": [
    {
      "group_name": "storage",
      "items": [
        {
          "name": "flexvolume"
        }
      ]
    }
  ],
  "StandardComponents": {
    "key": {
      "name": "ack-arena",
      "version": "0.5.0",
      "description": "***",
      "required": "false",
      "disabled": false
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-12The API operation is deprecatedsee changesets
Change itemChange content
API Deprecation DescriptionThe API operation is deprecated.