edit-icon download-icon

Install the CloudMonitor agent

Last Updated: Dec 27, 2017


Call interfaces to install the CloudMonitor agent on a specified ECS instance. For more information about the agent, see Introduction to agent.


  • Before using interfaces, make sure that the What is Server Guard agent has been installed on your instance. The Server Guard agent is currently integrated into security images. It is installed by default on purchased ECS instances. Log on to the Server Guard console to check the agent is running on each server.

  • The success rate of installing the CloudMonitor agent by using the interfaces is about 95%. If installation fails, log on to the instance to Install the agent manually.

Request method


Request parameters

Name Type Required? Description
Action String Yes Required parameter; value: NodeInstall
UserId String Yes ID of an Alibaba Cloud user
InstanceId String Yes Instance ID, for example, i-22jja5c2l
Force Boolean No Whether to install the CloudMonitor agent forcibly. If the agent has been installed, the default value indicates forced installation

Return parameters

Name Type Description
Success Boolean Whether the request is successful
ErrorCode Integer Request failure status code. The value 200 indicates that the request is successful, and a non-200 value indicates that the request fails
RequestId String Requested UUID, which is used for log query
ErrorMessage String Request failure prompt message

Error code

Error code Description Meaning
400 Bad Request Syntactic error of the client request
403 Forbidden Not authorized
404 Not Found Client error, not found
500 Internal Server Error Server error
200 OK Normal


  • Request example
  1. http://metrics.cn-hangzhou.aliyuncs.com/?Action=NodeInstall
  2. &InstanceId= i-abcdefgh123456
  3. &Force=true
  4. &UserId= 1234567898765432
  5. &<Public request parameters>
  • Return example

XML format

  1. <NodeInstallResponse>
  2. <ErrorCode>200</ErrorCode>
  3. <Success>true</Success>
  4. </NodeInstallResponse>

JSON format

  1. {
  2. "ErrorCode": 200,
  3. "Success": true
  4. }
Thank you! We've received your feedback.