All Products
Search

This Product

    Cloud Monitor:InstallMonitoringAgent

    Document Center

    Cloud Monitor:InstallMonitoringAgent

    Last Updated:Oct 30, 2025

    Call the InstallMonitoringAgent operation to install the CloudMonitor agent on specified Alibaba Cloud hosts.

    Operation description

    Prerequisites

    Ensure that Cloud Assistant is installed on the Alibaba Cloud host. For more information, see Cloud Assistant overview.

    Background information

    This API applies only to Alibaba Cloud hosts, which are Elastic Compute Service (ECS) instances. The success rate for installing the CloudMonitor agent using this API is approximately 95%. If the installation fails, you must manually install the agent. For more information about how to install the CloudMonitor agent, see Install and uninstall the C++ agent.

    Example

    This example shows how to forcibly install the latest version of the CloudMonitor agent on the ECS instance 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 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.

    You can specify from 1 to 10 instance IDs.

    Note

    You must specify either InstallCommand or InstanceIds.

    i-m5e0k0bexac8tykr****

    string

    No

    The ID of the Alibaba Cloud host.

    You can specify from 1 to 10 instance IDs.

    Note

    You must specify either InstallCommand or InstanceIds.

    i-m5e0k0bexac8tykr****
    InstallCommand

    string

    No

    The installation command. This command installs the CloudMonitor agent on all Alibaba Cloud hosts that belong to your Alibaba Cloud account. Valid values:

    • onlyInstallNotHasAgent: Installs the latest version of the CloudMonitor agent only on Alibaba Cloud hosts where the agent is not installed.

    • onlyUpgradeAgent: Upgrades the CloudMonitor agent only on Alibaba Cloud hosts where an earlier version of the agent is installed.

    • installAndUpgrade: Installs the latest version of the CloudMonitor agent on Alibaba Cloud hosts where the agent is not installed, and upgrades the agent on Alibaba Cloud hosts where an earlier version of the agent is installed.

    Note

    If you set this parameter, the InstanceIds parameter is invalid.

    onlyInstallNotHasAgent

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The status code.

    Note

    A value of 200 indicates that the request was successful.

    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 was successful. Valid values:

    • true: The operation was successful.

    • false: The operation failed.

    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.
    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.