You can call this operation to install the CloudMonitor agent for the specified ECS instance. This operation is not applicable to non-Alibaba Cloud ECS servers.

For more information about the agent, see CloudMonitor GoLang agent introduction.

Ensure that the Server Guard agent is installed on your instance before calling this operation. The Server Guard agent is integrated into security images and installed by default on purchased ECS instances. You can log on to the Server Guard console to view the status of the agent on each server.

The success rate of installing the CloudMonitor agent by calling this operation is about 95%. If the installation fails, you can log on to the host for manual installation. For more information, see Install the CloudMonitor GoLang agent.


You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
InstanceIds.N RepeatList Yes i-123****

The ID of the ECS instance.

Action String No InstallMonitoringAgent

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

Force Boolean No true

Indicates whether to force install. Default value: true.

Response parameters

Parameter Type Example Description
Code String 200

The status code. A value of 200 indicates that the call is successful.

Message String Successfully

The installation error message.

RequestId String host-abc12356

The request ID for troubleshooting.

Success Boolean true

Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.


Sample requests

http(s)://[Endpoint]/? Action=InstallMonitoringAgent
&InstanceIds. 1=i-123****
&<Common request parameters>

Successful response examples

XML format


JSON format


Error code

View error codes