調用InstallMonitoringAgent接口為指定阿里云主機安裝云監控插件。
接口說明
前提條件
請確保阿里云主機已安裝云助手。關于如何安裝云助手,請參見云助手概述。
背景信息
本接口僅適用于阿里云主機,即 ECS 實例。 通過 API 安裝云監控插件的成功率約為 95%,如果安裝失敗,則請手動安裝。關于如何安裝云監控插件,請參見安裝和卸載 C++版本插件。
使用說明
本文將提供一個示例,強制為阿里云主機i-m5e0k0bexac8tykr****
安裝最新版本云監控插件。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cms:InstallMonitoringAgent | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Force | boolean | 否 | 是否強制安裝云監控插件。取值:
| true |
InstanceIds | array | 否 | 阿里云主機 ID。 N 的取值范圍:1~10。 說明
InstallCommand 和InstanceIds 必須二選一。
| |
string | 否 | 阿里云主機 ID。 N 的取值范圍:1~10。 說明
InstallCommand 和InstanceIds 必須二選一。
| i-m5e0k0bexac8tykr**** | |
InstallCommand | string | 否 | 為當前阿里云賬號下的所有阿里云主機安裝云監控插件。取值:
說明
如果您已設置該參數,參數 InstanceIds 的設置無效。
| onlyInstallNotHasAgent |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "The specified resource is not found.",
"RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C41945",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ParameterInvalid | Illegal parameters. | - |
403 | AccessForbidden | User not authorized to operate on the specified resource. | - |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定資源。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史