InstallAgentForCluster - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

After you install a component on the target ACK cluster:

First, when the cluster is managed for the first time, the component is installed on all existing ECS instances in the cluster. If the cluster contains more than 50 nodes, only 50 instances are included in the first batch.
Then, the operating system console periodically checks the scaling status of the managed cluster. When a new ECS instance is added to the cluster, the operating system console automatically installs the component on the instance without user intervention.

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

sysom:InstallAgentForCluster

create

*All Resource

*

None

Request syntax

POST /api/v1/am/agent/install_agent_by_cluster HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
agent_id	string	No	The component ID.	74a86327-3170-412c-8e67-da3389ec56a9
agent_version	string	No	The component version.	3.4.0-1
cluster_id	string	No	The cluster ID. Note Pass the ID of the ACK cluster for this parameter.	c9d7f3fc3d42942afbcb65c1100ffb19d
config_id	string	No	The component configuration ID.	8gj86wrt7-3170-412c-8e67-da3389ecg6a9
grayscale_config	string	No	The canary release environment.	{"type":"numeric","config":{"value":2}}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	SysomOpenAPI.ServerError
data	object	The response data.
task_id	string	The task ID.	049ea0609515414b9e19c3389d7ba638
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the error information of the request.	success

Examples

Success response

JSON format

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "SysomOpenAPI.ServerError",
  "data": {
    "task_id": "049ea0609515414b9e19c3389d7ba638"
  },
  "message": "success"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SysomOpenAPI.RegionNotSupport	Region not supported.	Region is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.