调用InstallMonitoringAgent API为阿里云主机安装云监控插件-云监控-阿里云-云监控(CMS)-阿里云帮助中心

接口说明

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cms:InstallMonitoringAgent

create

*全部资源

*

无

名称	类型	必填	描述	示例值
Force	boolean	否	是否强制安装云监控插件。取值： true（默认值）：强制安装。 false：不强制安装。	true
InstanceIds	array	否	阿里云主机 ID。 N 的取值范围：1~10。说明 `InstallCommand`和`InstanceIds`必须二选一。	i-m5e0k0bexac8tykr****
	string	否	阿里云主机 ID。 N 的取值范围：1~10。说明 `InstallCommand`和`InstanceIds`必须二选一。	i-m5e0k0bexac8tykr****
InstallCommand	string	否	为当前阿里云账号下的所有阿里云主机安装云监控插件。取值： `onlyInstallNotHasAgent` ：仅为未安装云监控插件的阿里云主机安装最新版本插件。 `onlyUpgradeAgent`：仅为已安装非最新版本云监控插件的阿里云主机升级插件。 `installAndUpgrade`：不仅为未安装云监控插件的阿里云主机安装最新版本插件，且为已安装非最新版本云监控插件的阿里云主机升级插件。说明如果您已设置该参数，参数`InstanceIds`的设置无效。	onlyInstallNotHasAgent

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

名称	类型	描述	示例值
	object
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
RequestId	string	请求 ID。	0BDAF8A8-04DC-5F0C-90E4-724D42C41945
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true

正常返回示例

JSON格式

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

HTTP status code	错误码	错误信息	描述
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.	未找到指定资源。

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

更多信息，参考变更详情。