全部产品
Search

搜索本产品

    云监控：InstallMonitoringAgent - 为指定阿里云主机安装云监控插件

    文档中心

    云监控：InstallMonitoringAgent - 为指定阿里云主机安装云监控插件

    更新时间：Nov 05, 2024

    调用InstallMonitoringAgent接口为指定阿里云主机安装云监控插件。

    接口说明

    前提条件

    请确保阿里云主机已安装云助手。关于如何安装云助手，请参见云助手概述。

    背景信息

    本接口仅适用于阿里云主机，即 ECS 实例。 通过 API 安装云监控插件的成功率约为 95%，如果安装失败，则请手动安装。关于如何安装云监控插件，请参见安装和卸载 C++版本插件。

    使用说明

    本文将提供一个示例，强制为阿里云主机i-m5e0k0bexac8tykr****安装最新版本云监控插件。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cms:InstallMonitoringAgentcreate
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Forceboolean否

    是否强制安装云监控插件。取值：

    • true（默认值）：强制安装。
    • false：不强制安装。
    		true
    InstanceIdsarray否

    阿里云主机 ID。

    N 的取值范围：1~10。

    说明 InstallCommand和InstanceIds必须二选一。
    string否

    阿里云主机 ID。

    N 的取值范围：1~10。

    说明 InstallCommand和InstanceIds必须二选一。
    		i-m5e0k0bexac8tykr****
    InstallCommandstring否

    为当前阿里云账号下的所有阿里云主机安装云监控插件。取值：

    • onlyInstallNotHasAgent ： 仅为未安装云监控插件的阿里云主机安装最新版本插件。

    • onlyUpgradeAgent：仅为已安装非最新版本云监控插件的阿里云主机升级插件。

    • installAndUpgrade：不仅为未安装云监控插件的阿里云主机安装最新版本插件，且为已安装非最新版本云监控插件的阿里云主机升级插件。

    说明 如果您已设置该参数，参数InstanceIds的设置无效。
    		onlyInstallNotHasAgent

    关于公共请求参数的详情，请参见公共参数。

    返回参数

    名称类型描述示例值
    object
    Codestring

    状态码。

    说明 200 表示成功。
    		200
    Messagestring

    错误信息。

    		The specified resource is not found.
    RequestIdstring

    请求 ID。

    		0BDAF8A8-04DC-5F0C-90E4-724D42C41945
    Successboolean

    操作是否成功。取值：

    • true：成功。

    • false：失败。

    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400ParameterInvalidIllegal parameters.-
    403AccessForbiddenUser not authorized to operate on the specified resource.-
    404ResourceNotFoundThe specified resource is not found.未找到指定资源。
    500InternalErrorThe request processing has failed due to some unknown error.-

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史