InstallClusterAddons - Container Service for Kubernetes - Alibaba Cloud Documentation Center

Installs a component by specifying the name and version of the component. To enhance Kubernetes capabilities, you can install a variety of components in Container Service for Kubernetes (ACK) clusters, such as fully-managed core components and application, logging and monitoring, network, storage, and security group components.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cs:InstallClusterAddons	create	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	cs:AddonNames	none

Request syntax

POST /clusters/{ClusterId}/components/install HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c82e6987e2961451182edacd74faf****
body	array<object>	No	The request body.	ags-metrics-collector
	object	No
name	string	Yes	The component name.	ags-metrics-collector
version	string	Yes	The component version. Note You can call the DescribeClusterAddonsVersion operation to query the version of a component.	v1.0.0.2-cc3b2d6-aliyun
config	string	No	The custom component settings that you want to use. The value is a JSON string.	{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}

Response parameters

Parameter	Type	Description	Example
	object
cluster_id	string	The ID of the cluster.	c82e6987e2961451182edacd74faf****
task_id	string	The ID of the job.	T-5a54309c80282e39ea00002f
request_id	string	The request ID.	48BD70F6-A7E6-543D-9F23-08DEB764C92E

Examples

Sample success responses

JSONformat

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "task_id": "T-5a54309c80282e39ea00002f",
  "request_id": "48BD70F6-A7E6-543D-9F23-08DEB764C92E"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-12-12	The response structure of the API has changed	View Change Details