Installs the CloudMonitor agent on specified servers.
Operation description
Before installation, ensure that the Security Center agent on your server is online and that your server has Normal access to Alibaba Cloud services.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-sas:InstallCloudMonitor |
none |
*All Resource
|
None | 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 Agent 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 AccessKey secret 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 a successful API call. If both parameters are specified, the CloudMonitor agent is installed on the union of the servers specified by these 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 a successful API call. If both parameters are specified, the CloudMonitor agent is installed on the union of the servers specified by these 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 ID of the request. This unique identifier is generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues. |
F92AFB96-FACC-57E7-928E-678D04B94CAE |
| Success |
boolean |
Indicates whether the API call was successful. Valid values:
|
false |
| Code |
string |
The error code returned if the API call fails. |
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 |
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. |
| 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.