Deploy Security Center Agent on Multiple Servers Using OperateAgentClientInstall API - Security Center - Alibaba Cloud - Security 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

yundun-sas:OperateAgentClientInstall

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	string	No	The IDs of the servers on which to install the Security Center agent. Separate multiple IDs with commas (,). Note You must specify at least one of InstanceIds and Uuids. If you specify InstanceIds, you must also specify Region and Os.	i-uf6j8vq9l4r5ntht****
Uuids	string	No	The UUIDs of the servers on which to install the Security Center agent. Separate multiple UUIDs with commas (,). Note You must specify at least one of InstanceIds and Uuids.	1587bedb-fdb4-48c4-9330-************
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	en
Region	string	No	The region of the servers. Valid values include the following regions: cn-hangzhou: China (Hangzhou) cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-zhangjiakou: China (Zhangjiakou) cn-shenzhen: China (Shenzhen)	cn-hangzhou
Os	string	No	The operating system of the servers. Valid values: linux windows	linux

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AE79B457-877C-51C6-AD72-0D34A025D***
AegisCelintInstallResposeList	array<object>	The installation results.
	object	The details of each installation result.
Uuid	string	The UUID of the server.	1587bedb-fdb4-48c4-9330-****
InstanceId	string	The ID of the server.	i-uf6j8vq9l4r5ntht****
RecordId	integer	The ID of the installation task.	2856

Examples

Success response

JSON format

{
  "RequestId": "AE79B457-877C-51C6-AD72-0D34A025D***",
  "AegisCelintInstallResposeList": [
    {
      "Uuid": "1587bedb-fdb4-48c4-9330-****",
      "InstanceId": "i-uf6j8vq9l4r5ntht****",
      "RecordId": 2856
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstallNotGranted	The installation permission is not granted.	Insufficient permissions, please log on to the RAM console to grant AliyunServiceRoleForSas permissions.
500	InternalError	The request processing has failed due to some unknown error.
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.