使用InstallCloudMonitor為伺服器安裝CloudMonitor外掛程式-Security Center-阿里雲

介面說明

說明

安裝前請確保您的伺服器上的Security Center用戶端線上，並且您的伺服器的網路可以正常訪問阿里雲服務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:InstallCloudMonitor

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ArgusVersion	string	是	要安裝的CloudMonitor外掛程式的版本。您可以通過外掛程式概覽擷取最新的CloudMonitor外掛程式版本。	3.5.6
AgentAccessKey	string	否	安裝CloudMonitor外掛程式時所需要的 AccessKey。您可以調用 DescribeMonitoringAgentAccessKey 介面擷取該參數。說明僅非阿里雲伺服器安裝CloudMonitor外掛程式需要設定此參數。	usY*****R_U
AgentSecretKey	string	否	安裝CloudMonitor外掛程式時所需要的 AccessSecret。您可以調用 DescribeMonitoringAgentAccessKey 介面擷取該參數。說明僅非阿里雲伺服器安裝CloudMonitor外掛程式需要設定此參數。	UCxF2R1sIO90XlU9****
InstanceIdList	array	否	要安裝CloudMonitor外掛程式的伺服器的執行個體 ID 列表。多個 ID 之間使用半形逗號（,）分隔。
	string	否	要安裝CloudMonitor外掛程式的伺服器的執行個體 ID 列表。多個 ID 之間使用半形逗號（,）分隔。說明 InstanceIdList、UuidList 這兩個參數必須要至少設定一個，介面才能調用成功。當這兩個參數同時設定時，安裝CloudMonitor外掛程式的伺服器為這兩個參數對應的伺服器的並集。	[VMware-564d4e22ce6d9207-c97c8af3a448**,VMware-564d4a9574e0b8ab-843ba10d8b0c,VMware-564dbb7fddaf27ce-629271166745**]
UuidList	array	否	要安裝CloudMonitor外掛程式的伺服器的 UUID 清單。多個 UUID 之間使用半形逗號（,）分隔。
	string	否	要安裝CloudMonitor外掛程式的伺服器的 UUID 清單。多個 UUID 之間使用半形逗號（,）分隔。說明 InstanceIdList、UuidList 這兩個參數必須要至少設定一個，介面才能調用成功。當這兩個參數同時設定時，安裝CloudMonitor外掛程式的伺服器為這兩個參數對應的伺服器的並集。	[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.
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.	您的請求發生錯誤，請稍後重試！
500	ServerError	ServerError	服務故障，請稍後重試！
403	NoPermission	caller has no permission	當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。