InstallAgent - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Installs an agent on a specified instance.

Operation description

Calling this operation to install an agent is asynchronous. After you call this operation, a task_id is returned. You can use this ID to call the GetAgentTask operation to query the task execution status.

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

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
agent_id	string	Yes	The ID of the component to install.	74a86327-3170-412c-8e67-da3389ec56a9
agent_version	string	Yes	The version of the component to install.	3.4.0-1
install_type	string	Yes	The installation type. Valid values: InstallAndUpgrade: installs the component if it does not exist, or updates it if it exists. OnlyInstallNotHasAgent: installs the component if it does not exist, or takes no action if it exists. OnlyUpgradeHasAgent: takes no action if the component does not exist, or updates it if it exists. OnlyInstallWithoutStart: only installs the component without starting the service.	InstallAndUpgrade
instances	array<object>	Yes	The list of instances on which to install the component.
	object	Yes	The instance information.
instance	string	Yes	The instance ID.	i-wz9b9vucz1iubsz8sjqo
region	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	1D8887FC-4BDB-5A1C-AB19-135C29A9E481
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.	Success
data	object	The response data.
task_id	string	The task ID. You can use this task ID to call the GetAgentTask operation to query the task execution status.	26b3cd97389c43dcad6bc4901c36fcec
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error message.	""

Examples

Success response

JSON format

{
  "RequestId": "1D8887FC-4BDB-5A1C-AB19-135C29A9E481",
  "code": "Success",
  "data": {
    "task_id": "26b3cd97389c43dcad6bc4901c36fcec"
  },
  "message": "\"\""
}

Error codes

HTTP status code	Error code	Error message	Description
400	SysomOpenAPI.AgentNotExists	Agent not exists.	Agent does not exist.
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.	Component task does not exist.
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.	Agent version does not exist.
400	SysomOpenAPI.InstanceNotExists	Instance not exists.	Instance does not exist
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.	Invalid parameter passed when calling interface
400	SysomOpenAPI.MissingParameter	Missing parameters.	Missing parameter
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.	No SysOM Agent is available.
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.	The instance is not authorized.
400	SysomOpenAPI.NotOwnInstance	Not own current instance.	The specified instance does not belong to the current user.
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.	Diagnosis result does not belong to the current account
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.	Unsupported SysOM client version.
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.	Server error, please correct the code according to the error message
400	SysomOpenAPI.ServiceRoleNotExists	Service role does not exist, please init the sysom service first.	The service role does not exist. Activate the Alinux console first.
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.