全部產品
Search
文件中心

Cloud Monitor:InstallMonitoringAgent - 為指定阿里雲主機安裝CloudMonitor外掛程式

更新時間:Oct 30, 2025

調用InstallMonitoringAgent介面為指定阿里雲主機安裝CloudMonitor外掛程式。

介面說明

前提條件

請確保阿里雲主機已安裝雲助手。關於如何安裝雲助手,請參見雲助手概述

背景資訊

本介面僅適用於阿里雲主機,即 ECS 執行個體。 通過 API 安裝CloudMonitor外掛程式的成功率約為 95%,如果安裝失敗,則請手動安裝。關於如何安裝CloudMonitor外掛程式,請參見安裝和卸載 C++版本外掛程式

使用說明

本文將提供一個樣本,強製為阿里雲主機i-m5e0k0bexac8tykr****安裝最新版本CloudMonitor外掛程式。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:InstallMonitoringAgent

create

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Force

boolean

是否強制安裝CloudMonitor外掛程式。取值:

  • true(預設值):強制安裝。

  • false:不強制安裝。

true

InstanceIds

array

阿里雲主機 ID。

N 的取值範圍:1~10。

說明

InstallCommandInstanceIds必須二選一。

i-m5e0k0bexac8tykr****

string

阿里雲主機 ID。

N 的取值範圍:1~10。

說明

InstallCommandInstanceIds必須二選一。

i-m5e0k0bexac8tykr****

InstallCommand

string

為當前阿里雲帳號下的所有阿里雲主機安裝CloudMonitor外掛程式。取值:

  • onlyInstallNotHasAgent : 僅為未安裝CloudMonitor外掛程式的阿里雲主機安裝最新版本外掛程式。

  • onlyUpgradeAgent:僅為已安裝非最新版本CloudMonitor外掛程式的阿里雲主機升級外掛程式。

  • installAndUpgrade:不僅為未安裝CloudMonitor外掛程式的阿里雲主機安裝最新版本外掛程式,且為已安裝非最新版本CloudMonitor外掛程式的阿里雲主機升級外掛程式。

說明

如果您已設定該參數,參數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. 未找到指定資源。

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

變更歷史

更多資訊,參考變更詳情