InstallMonitoringAgent-阿里云帮助中心

Operation description

Before you begin

Make sure that Cloud Assistant is installed on the Alibaba Cloud hosts. For more information about how to install Cloud Assistant, see Cloud Assistant overview.

Background information

This operation applies only to Alibaba Cloud hosts, which are ECS instances. The success rate of installing the CloudMonitor agent by calling this API operation is about 95%. If the installation fails, install the agent manually. For more information about how to install the CloudMonitor agent, see Install and uninstall the CloudMonitor agent for C++.

Usage notes

This topic provides an example on how to forcibly install the latest version of the CloudMonitor agent on the Alibaba Cloud host i-m5e0k0bexac8tykr****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:InstallMonitoringAgent

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Force	boolean	No	Specifies whether to forcibly install the CloudMonitor agent. Valid values: true (default): forcibly installs the agent. false: does not forcibly install the agent.	true
InstanceIds	array	No	The IDs of the Alibaba Cloud hosts. Valid values of N: 1 to 10. Note You must specify either InstallCommand or InstanceIds.	i-m5e0k0bexac8tykr****
	string	No	The IDs of the Alibaba Cloud hosts. Valid values of N: 1 to 10. Note You must specify either InstallCommand or InstanceIds.	i-m5e0k0bexac8tykr****
InstallCommand	string	No	Installs the CloudMonitor agent on all Alibaba Cloud hosts within the current Alibaba Cloud account. Valid values: onlyInstallNotHasAgent: installs the latest version of the agent only on Alibaba Cloud hosts on which the CloudMonitor agent is not installed. onlyUpgradeAgent: upgrades the agent only on Alibaba Cloud hosts on which a non-latest version of the CloudMonitor agent is installed. installAndUpgrade: installs the latest version of the agent on Alibaba Cloud hosts on which the CloudMonitor agent is not installed, and upgrades the agent on Alibaba Cloud hosts on which a non-latest version of the CloudMonitor agent is installed. Note If you specify this parameter, the InstanceIds parameter is ignored.	onlyInstallNotHasAgent
DryRun	boolean	No	Specifies whether to perform a dry run on the request. The dry run includes permission and instance status checks. Valid values: false (default): sends a normal request. If the request passes the check, the name and description of the route table are modified. true: sends a dry run request. Only a check is performed, and the name and description of the route table are not modified. Check items include whether required parameters are specified and the request format. If the request fails the check, the corresponding error is returned. If the request passes the check, the DryRunOperation error code is returned.	true

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

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Parameter invalid.	The parameter is missing or invalid.
412	DryRunOperation	%s.	dryRun Pre-Verification Results
500	InternalError	The request processing has failed due to some unknown error.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.