All Products
Search
Document Center

Container Service for Kubernetes:ListClusterAddonInstances

Last Updated:Nov 07, 2024

Queries the component instances that are running in the specified cluster and the information about the component instances. The information includes the component version and status.

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

Request syntax

GET /clusters/{cluster_id}/addon_instances HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The cluster ID.

c02b3e03be10643e8a644a843ffcb****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

addonsarray<object>

A list of components that are installed in the cluster.

addonsobject
namestring

The component name.

coredns
statestring

The status of the component. Valid values:

  • active: The component is installed.
  • updating: The component is being modified.
  • upgrading: The component is being updated.
  • deleting: The component is being uninstalled.
active
versionstring

The version of the component.

v1.9.3.10-7dfca203-aliyun

Examples

Sample success responses

JSONformat

{
  "addons": [
    {
      "name": "coredns",
      "state": "active",
      "version": "v1.9.3.10-7dfca203-aliyun"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history