InstallCloudMonitor - 安装云监控插件 - 云安全中心

为指定服务器安装云监控插件。

接口说明

说明安装前请确保您的服务器上的云安全中心客户端在线，并且您的服务器的网络可以正常访问阿里云服务。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:InstallCloudMonitor	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ArgusVersion	string	是	要安装的云监控插件的版本。您可以通过插件概览获取最新的云监控插件版本。	3.5.6
AgentAccessKey	string	否	安装云监控插件时所需要的 AccessKey。您可以调用 DescribeMonitoringAgentAccessKey 接口获取该参数。说明仅非阿里云服务器安装云监控插件需要设置此参数。	usY*****R_U
AgentSecretKey	string	否	安装云监控插件时所需要的 AccessSecret。您可以调用 DescribeMonitoringAgentAccessKey 接口获取该参数。说明仅非阿里云服务器安装云监控插件需要设置此参数。	UCxF2R1sIO90XlU9****
InstanceIdList	array	否	要安装云监控插件的服务器的实例 ID 列表。多个 ID 之间使用半角逗号（,）分隔。
	string	否	要安装云监控插件的服务器的实例 ID 列表。多个 ID 之间使用半角逗号（,）分隔。说明 InstanceIdList、UuidList 这两个参数必须要至少设置一个，接口才能调用成功。当这两个参数同时设置时，安装云监控插件的服务器为这两个参数对应的服务器的并集。	[VMware-564d4e22ce6d9207-c97c8af3a448**,VMware-564d4a9574e0b8ab-843ba10d8b0c,VMware-564dbb7fddaf27ce-629271166745**]
UuidList	array	否	要安装云监控插件的服务器的 UUID 列表。多个 UUID 之间使用半角逗号（,）分隔。
	string	否	要安装云监控插件的服务器的 UUID 列表。多个 UUID 之间使用半角逗号（,）分隔。说明 InstanceIdList、UuidList 这两个参数必须要至少设置一个，接口才能调用成功。当这两个参数同时设置时，安装云监控插件的服务器为这两个参数对应的服务器的并集。	[inet-c669e5d9-0adf-4d71-a9ce-65ed2730**,inet-2e87cce8-763d-4dcd-b39f-d592e1b0,inet-7c676676-06fa-442e-90fb-b802e5d6**]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	F92AFB96-FACC-57E7-928E-678D04B94CAE
Success	boolean	接口调用是否成功。取值： true：接口调用成功。 false：接口调用失败。	false
Code	string	接口调用失败的错误码。	IllegalParam
Message	string	错误码的详细信息。	There was an error with your request.
HttpStatusCode	integer	HTTP 状态码。	400

示例

正常返回示例

JSON格式

{
  "RequestId": "F92AFB96-FACC-57E7-928E-678D04B94CAE",
  "Success": false,
  "Code": "IllegalParam",
  "Message": "There was an error with your request.",
  "HttpStatusCode": 400
}

错误码

HTTP status code	错误码	错误信息	描述
400	ConsoleError	The error message is %s %s.	错误信息为%s %s。
400	IllegalParam	Illegal param	无效参数
400	MachineNotExist	The machine does not exist.	所操作的机器不存在，请确认后重新操作。
400	AgentNotOnline	The agent not online.	客户端不在线不支持操作，请保持客户端在线后再进行操作。
400	InvalidParam	There was an error with your request.	您的请求发生错误，请稍后重试！
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史