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

前提条件

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

背景信息

本接口仅适用于阿里云主机,即ECS实例。

通过API安装云监控插件的成功率约为95%,如果安装失败,则请手动安装。关于如何安装云监控插件,请参见安装和卸载C++版本插件

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String InstallMonitoringAgent

要执行的操作,取值:InstallMonitoringAgent

Force Boolean true

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

  • true(默认值):强制安装。
  • false:不强制安装。
InstallCommand String onlyInstallNotHasAgent

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

  • onlyInstallNotHasAgent : 仅为未安装云监控插件的阿里云主机安装最新版本插件。
  • onlyUpgradeAgent:仅为已安装非最新版本云监控插件的阿里云主机升级插件。
  • installAndUpgrade:不仅为未安装云监控插件的阿里云主机安装最新版本插件,且为已安装非最新版本云监控插件的阿里云主机升级插件。
说明 如果您已设置该参数,参数InstanceIds的设置无效。
InstanceIds.N RepeatList i-m5e0k0bexac8tykr****

阿里云主机ID。N的取值范围:1~10。

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

返回数据

名称 类型 示例值 描述
RequestId String 0BDAF8A8-04DC-5F0C-90E4-724D42C41945

请求ID。

Code String 200

状态码。

说明 200表示成功。
Success Boolean true

操作是否成功。取值:

  • true:成功。
  • false:失败。
Message String The specified resource is not found.

错误信息。

示例

请求示例

http(s)://[Endpoint]/?Action=InstallMonitoringAgent
&InstanceIds.1=i-m5e0k0bexac8tykr****
&<公共请求参数>

正常返回示例

XML格式

<InstallMonitoringAgentResponse>
	  <RequestId>0BDAF8A8-04DC-5F0C-90E4-724D42C41945</RequestId>
	  <Code>200</Code>
	  <Success>true</Success>
</InstallMonitoringAgentResponse>

JSON格式

{
    "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C41945",
    "Code": 200,
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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