InstallMonitoringAgent - Cloud Monitor - Alibaba Cloud ドキュメントセンター

操作説明

前提条件

Alibaba Cloud ホストにクラウドアシスタントがインストールされていることを確認してください。詳細については、「クラウドアシスタントの概要」をご参照ください。

背景情報

この API は、Elastic Compute Service (ECS) インスタンスである Alibaba Cloud ホストにのみ適用されます。この API を使用して CloudMonitor エージェントをインストールする場合の成功率は約 95% です。インストールが失敗した場合は、エージェントを手動でインストールする必要があります。 CloudMonitor エージェントのインストール方法の詳細については、「C++ エージェントのインストールとアンインストール」をご参照ください。

例

この例では、ECS インスタンス i-m5e0k0bexac8tykr**** に CloudMonitor エージェントの最新バージョンを強制的にインストールする方法を示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:InstallMonitoringAgent

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Force	boolean	任意	CloudMonitor エージェントを強制的にインストールするかどうかを指定します。有効な値: true (デフォルト): エージェントを強制的にインストールします。 false: エージェントを強制的にインストールしません。	true
InstanceIds	array	任意	Alibaba Cloud ホストの ID。 1 から 10 個のインスタンス ID を指定できます。説明 `InstallCommand` または `InstanceIds` のいずれかを指定する必要があります。	i-m5e0k0bexac8tykr****
	string	任意	Alibaba Cloud ホストの ID。 1 から 10 個のインスタンス ID を指定できます。説明 `InstallCommand` または `InstanceIds` のいずれかを指定する必要があります。	i-m5e0k0bexac8tykr****
InstallCommand	string	任意	インストールコマンド。このコマンドは、Alibaba Cloud アカウントに属するすべての Alibaba Cloud ホストに CloudMonitor エージェントをインストールします。有効な値: `onlyInstallNotHasAgent`: エージェントがインストールされていない Alibaba Cloud ホストにのみ、CloudMonitor エージェントの最新バージョンをインストールします。 `onlyUpgradeAgent`: 以前のバージョンのエージェントがインストールされている Alibaba Cloud ホストでのみ CloudMonitor エージェントをアップグレードします。 `installAndUpgrade`: エージェントがインストールされていない Alibaba Cloud ホストに CloudMonitor エージェントの最新バージョンをインストールし、以前のバージョンのエージェントがインストールされている Alibaba Cloud ホストでエージェントをアップグレードします。説明このパラメーターを設定すると、`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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
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.	The specified resource is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。