InstallCloudMonitor - Security Center - Alibaba Cloud Documentation Center

Installs the CloudMonitor agent on specified servers.

Operation description

Note Before you call this operation, make sure that the Security Center agent on your servers is online and the servers can access Alibaba Cloud services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:InstallCloudMonitor	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ArgusVersion	string	Yes	The version of the CloudMonitor agent that you want to install on the servers. For more information about the latest version of the CloudMonitor agent, see Overview .	3.5.6
AgentAccessKey	string	No	The AccessKey ID that is required to install the CloudMonitor agent. You can call the DescribeMonitoringAgentAccessKey operation to query the AccessKey ID. Note This parameter is required only when you install the CloudMonitor agent on servers that are not deployed on Alibaba Cloud.	usY*****R_U
AgentSecretKey	string	No	The AccessKey secret that is required to install the CloudMonitor agent. You can call the DescribeMonitoringAgentAccessKey operation to query the AccessKey secret. Note This parameter is required only when you install the CloudMonitor agent on servers that are not deployed on Alibaba Cloud.	UCxF2R1sIO90XlU9****
InstanceIdList	array	No	The IDs of the servers on which you want to install the CloudMonitor agent. Separate multiple IDs with commas (,).
	string	No	The 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. If you specify both the InstanceIdList and UuidList parameters, the CloudMonitor agent is installed on all the specified servers.	[VMware-564d4e22ce6d9207-c97c8af3a448**,VMware-564d4a9574e0b8ab-843ba10d8b0c,VMware-564dbb7fddaf27ce-629271166745**]
UuidList	array	No	The UUIDs of the servers on which you want to install the CloudMonitor agent. Separate multiple UUIDs with commas (,).
	string	No	The 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. If you specify both the InstanceIdList and UuidList parameters, the CloudMonitor agent is installed on all the specified servers.	[inet-c669e5d9-0adf-4d71-a9ce-65ed2730**,inet-2e87cce8-763d-4dcd-b39f-d592e1b0,inet-7c676676-06fa-442e-90fb-b802e5d6**]

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	F92AFB96-FACC-57E7-928E-678D04B94CAE
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	false
Code	string	The error code returned if the request fails.	IllegalParam
Message	string	The error message returned.	There was an error with your request.
HttpStatusCode	integer	The HTTP status code returned.	400

Examples

Sample success responses

JSONformat

{
  "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	Description
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.	The error message returned because the Security Center agent is offline. Make sure that the Security Center agent is online and try again.
400	InvalidParam	There was an error with your request.	An error occurred while processing your request. Try again later.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history