Installs the CloudMonitor agent on specific servers.

Note Before you call this operation, make sure that the Security Center agent installed on the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes InstallCloudMonitor

The operation that you want to perform. Set the value to InstallCloudMonitor.

ArgusVersion String Yes 3.5.6

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.

AgentAccessKey String No usY*****R_U

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.
AgentSecretKey String No UCxF2R1sIO90XlU9****

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.
InstanceIdList.N String No [VMware-564d4e22ce6d9207-c97c8af3a448****,VMware-564d4a9574e0b8ab-843ba10d8b0c****,VMware-564dbb7fddaf27ce-629271166745****]

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.N and UuidList.N parameters. If both the InstanceIdList.N and UuidList.N parameters are specified, the CloudMonitor agent is installed on all specified servers.
UuidList.N String No [inet-c669e5d9-0adf-4d71-a9ce-65ed2730****,inet-2e87cce8-763d-4dcd-b39f-d592e1b0****,inet-7c676676-06fa-442e-90fb-b802e5d6****]

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.N and UuidList.N parameters. If both the InstanceIdList.N and UuidList.N parameters are specified, the CloudMonitor agent is installed on all specified servers.

Response parameters

Parameter Type Example Description
RequestId String F92AFB96-FACC-57E7-928E-678D04B94CAE

The ID of the request, which is used to locate and troubleshoot issues.

Success Boolean false

Indicates whether the request was successful. Valid values:

  • true: yes
  • false: no
Code String IllegalParam

The error code returned if the call fails.

Message String There was an error with your request.

The error message returned.

HttpStatusCode Integer 400

The HTTP status code returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=InstallCloudMonitor
&ArgusVersion=3.5.6
&AgentAccessKey=usY*****R_U
&AgentSecretKey=UCxF2R1sIO90XlU9****
&InstanceIdList=["[VMware-564d4e22ce6d9207-c97c8af3a448****,VMware-564d4a9574e0b8ab-843ba10d8b0c****,VMware-564dbb7fddaf27ce-629271166745****]"]
&UuidList=["[inet-c669e5d9-0adf-4d71-a9ce-65ed2730****,inet-2e87cce8-763d-4dcd-b39f-d592e1b0****,inet-7c676676-06fa-442e-90fb-b802e5d6****]"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<InstallCloudMonitorResponse>
    <RequestId>F92AFB96-FACC-57E7-928E-678D04B94CAE</RequestId>
    <Success>false</Success>
    <Code>IllegalParam</Code>
    <Message>There was an error with your request.</Message>
    <HttpStatusCode>400</HttpStatusCode>
</InstallCloudMonitorResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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. The error message is %s %s.
400 IllegalParam Illegal param The error message returned because the specified parameters are invalid.
400 MachineNotExist The machine does not exist. The error message returned because the specified servers are invalid. Check the server information and try again.
400 AgentNotOnline The agent not online. The error message returned because the Security Center agent installed on the servers is offline. Make sure that the agent is online and try again.
400 InvalidParam There was an error with your request. The error message returned because a request error occurred. Try again later.
500 ServerError ServerError The error message returned because a server error occurred.

For a list of error codes, visit the API Error Center.