InstallMonitoringAgent - CloudMonitor - Alibaba Cloud Documentation Center

Operation description

The Cloud Assistant client is installed on an ECS instance. For more information about how to install the Cloud Assistant client, see Overview .

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
Force	boolean	No	Specifies whether to install the CloudMonitor agent. Valid values: true (default value): yes false: no	true
InstanceIds	array	No
	string	No	The IDs of the ECS instances. Valid values of N: 1 to 10. Note You must specify either the `InstallCommand` or the `InstanceIds` parameter.	i-m5e0k0bexac8tykr****
InstallCommand	string	No	Specifies whether to install the CloudMonitor agent on all ECS instances that belong to the current Alibaba Cloud account. Valid values: `onlyInstallNotHasAgent`: installs the latest version of the CloudMonitor agent only on ECS instances on which the agent is not installed. `onlyUpgradeAgent`: upgrades the CloudMonitor agent to the latest version only for ECS instances on which an earlier version of the agent is installed. `installAndUpgrade`: installs the latest version of the CloudMonitor agent on ECS instances on which the agent is not installed, and upgrades the CloudMonitor agent to the latest version for ECS instances on which an earlier version of the agent is installed. Note If you set the InstallCommand parameter, the `InstanceIds` parameter does not take effect.	onlyInstallNotHasAgent

For more information about common request parameters, see Common parameters.

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The ID of the request.	0BDAF8A8-04DC-5F0C-90E4-724D42C41945
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C41945",
  "Success": true
}

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

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

Change time	Summary of changes	Operation

No change history