Deploy CloudMonitor Agent on Hybrid Servers via API - Security Center - Alibaba Cloud - Security Center

Operation description

Note

Before installation, make sure that the Security Center client on your server is online and that your server can access Alibaba Cloud services over the network.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ArgusVersion	string	Yes	The version of the CloudMonitor agent to install. You can obtain the latest CloudMonitor agent version from Plugin overview.	3.5.6
AgentAccessKey	string	No	The AccessKey required to install the CloudMonitor agent. You can call the DescribeMonitoringAgentAccessKey operation to obtain this parameter. Note This parameter is required only when you install the CloudMonitor agent on a non-Alibaba Cloud server.	usY*****R_U
AgentSecretKey	string	No	The AccessSecret required to install the CloudMonitor agent. You can call the DescribeMonitoringAgentAccessKey operation to obtain this parameter. Note This parameter is required only when you install the CloudMonitor agent on a non-Alibaba Cloud server.	UCxF2R1sIO90XlU9****
InstanceIdList	array	No	The list of instance IDs of the servers on which you want to install the CloudMonitor agent. Separate multiple IDs with commas (,).
	string	No	The list of instance IDs of the servers on which you want to install the CloudMonitor agent. Separate multiple IDs with commas (,). Note You must specify at least one of the InstanceIdList and UuidList parameters for the operation to succeed. If both parameters are specified, the CloudMonitor agent is installed on the union of the servers specified by the two parameters.	[VMware-564d4e22ce6d9207-c97c8af3a448**,VMware-564d4a9574e0b8ab-843ba10d8b0c,VMware-564dbb7fddaf27ce-629271166745**]
UuidList	array	No	The list of UUIDs of the servers on which you want to install the CloudMonitor agent. Separate multiple UUIDs with commas (,).
	string	No	The list of UUIDs of the servers on which you want to install the CloudMonitor agent. Separate multiple UUIDs with commas (,). Note You must specify at least one of the InstanceIdList and UuidList parameters for the operation to succeed. If both parameters are specified, the CloudMonitor agent is installed on the union of the servers specified by the two parameters.	[inet-c669e5d9-0adf-4d71-a9ce-65ed2730**,inet-2e87cce8-763d-4dcd-b39f-d592e1b0,inet-7c676676-06fa-442e-90fb-b802e5d6**]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.	F92AFB96-FACC-57E7-928E-678D04B94CAE
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	false
Code	string	The error code returned when the operation failed.	IllegalParam
Message	string	The detailed information about the error code.	There was an error with your request.
HttpStatusCode	integer	The HTTP status code.	400

Examples

Success response

JSON format

{
  "RequestId": "F92AFB96-FACC-57E7-928E-678D04B94CAE",
  "Success": false,
  "Code": "IllegalParam",
  "Message": "There was an error with your request.",
  "HttpStatusCode": 400
}

Error codes

HTTP status code	Error code	Error message
400	ConsoleError	The error message is %s %s.
400	IllegalParam	Illegal param
400	MachineNotExist	The machine does not exist.
400	AgentNotOnline	The agent not online.
400	InvalidParam	There was an error with your request.
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.