UpdateClusterAgentConfig - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

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:UpdateClusterAgentConfig

update

*All Resource

*

None

Request syntax

PUT /api/v1/am/agent/updateClusterAgentConfig HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
agentId	string	Yes	The ID of the component whose configuration you want to update.	74a86327-3170-412c-8e67-da3389ec56a9
clusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to obtain the cluster ID.	c8b90bc1b2ef0436f81213c032b75c5f3
configId	string	Yes	The ID of the component configuration to be installed on the cluster.	f0078fbb-4213-11f0-a19b-00163e4ae208

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. If the value is `Success`, the authorization is successful. Other status codes indicate that the authorization failed. If the authorization fails, check the `message` field for the detailed fault message.	SysomOpenAPI.ServerError
data	object	The returned data.
taskId	string	The task ID. You can call the GetAgentTask operation by using this task ID to check the execution status of the task.	bbe94a98-4192-4172-b856-95777e0a55d7
message	string	The error message. If the value of `code` is `Success`, this field is empty. Otherwise, this field contains the error message of the request.	success
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "SysomOpenAPI.ServerError",
  "data": {
    "taskId": "bbe94a98-4192-4172-b856-95777e0a55d7"
  },
  "message": "success",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	Server error, please correct the code according to the error message
400	SysomOpenAPI.AgentConfigDuplicate	Agent config already exists, please change the name. %s.	Configuration name conflict. You are not allowed to create a configuration with the same name.
400	SysomOpenAPI.AgentConfigNotExists	Agent config does not exists.	Agent configuration does not exist
400	SysomOpenAPI.AgentTaskJobNotFinish	Agent Task Job is already running on instances.	An installation task is already running
400	SysomOpenAPI.ClusterStatusNotRunning	Cluster The cluster status is not Running and may be in operation. Please try again later.	The cluster status is not Running and may be in operation. Please try again later.
400	SysomOpenAPI.ClusterNotExists	The cluster does not exist. %s.	The cluster does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.