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

DescribeMonitoringAgentStatuses 操作を呼び出して、CloudMonitor エージェントのステータスをクエリできます。

操作説明

このトピックでは、インスタンス i-hp3dunahluwajv6f**** にインストールされている CloudMonitor エージェントのステータスをクエリする方法の例を示します。レスポンスは、CloudMonitor エージェントが running 状態であることを示します。

今すぐお試しください

この 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:DescribeMonitoringAgentStatuses

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceIds	string	任意	インスタンス ID。複数のインスタンス ID はコンマ (,) で区切ります。	i-hp3dunahluwajv6f****
HostAvailabilityTaskId	string	任意	可用性モニタリングタスクの ID。	126****

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Code	string	HTTP ステータスコード。説明状態コード 200 は、リクエストが成功したことを示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
RequestId	string	リクエスト ID。	6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
NodeStatusList	object
NodeStatus	array<object>	ホストステータス情報。
	object
Status	string	CloudMonitor エージェントのステータス。有効な値： running：CloudMonitor エージェントは実行中です。 stopped：CloudMonitor エージェントは停止しています。 installing：CloudMonitor エージェントはインストール中です。 install_failed：CloudMonitor エージェントのインストールに失敗しました。 abnormal：CloudMonitor エージェントが正しくインストールされていません。 not_installed：CloudMonitor エージェントはインストールされていません。	running
InstanceId	string	インスタンス ID。	i-hp3dunahluwajv6f****
AutoInstall	boolean	CloudMonitor エージェントが自動的にインストールされるかどうかを示します。有効な値： true：CloudMonitor エージェントは自動的にインストールされます。 false：CloudMonitor エージェントは自動的にインストールされません。	true
OsMonitorStatus	string	SysOM のステータス。有効な値： installing：SysOM はインストール中です。 running：SysOM は実行中です。 stopped：SysOM は停止しています。 uninstalling：SysOM はアンインストール中です。	running
OsMonitorErrorCode	string	SysOM のエラーステータス。有効な値： `install_fail`：SysOM のインストールに失敗したか、不明なエラーが発生しました。 `install_assist_invalid`：クラウドアシスタントのステータスが無効なため、SysOM のインストールに失敗しました。 `install_assist_command_fail`：インストールコマンドの実行に失敗したため、SysOM のインストールに失敗しました。 `uninstall_fail`：SysOM のアンインストールに失敗したか、不明なエラーが発生しました。 `uninstall_assist_invalid`：クラウドアシスタントのステータスが無効なため、SysOM のアンインストールに失敗しました。 `uninstall_assist_command_fail`：アンインストールコマンドの実行に失敗したため、SysOM のアンインストールに失敗しました。	install_fail
OsMonitorErrorDetail	string	実行エラーの詳細。有効な値： `Command.ErrorCode.Fail.Downlaod.REGIN_ID`：リージョン ID の取得に失敗しました。 `Command.ErrorCode.Fail.Downlaod.SYSAK`：System Analysis Kit (SysAK) の .rpm パッケージのダウンロードに失敗しました。 `Command.ErrorCode.Fail.Downlaod.CMON_FILE`：CMON ファイルのダウンロードに失敗しました。 `Command.ErrorCode.Fail.Downlaod.BTF`：BTF ファイルが見つからないため、SysAK の起動に失敗しました。 `Command.ErrorCode.Fail.Start.SYSAK`：不明なエラーのため、SysAK の起動に失敗しました。	Command.ErrorCode.Fail.Downlaod.REGIN_ID
OsMonitorVersion	string	SysOM のバージョン。	1.3.0-12
OsMonitorConfig	string	SysAK モニタリング機能が有効かどうかを示します。有効な値： `true`：SysAK モニタリング機能は有効です。 `false`：SysAK モニタリング機能は無効です。	{"sysak":true}
AgentInstallErrorCode	string	CloudMonitor エージェントのインストール時に返されるエラーコード。有効な値： Common.Timeout：インストールがタイムアウトしました。 Common.SLR：CloudMonitor のサービスリンクロールが承認されていません。 Common.OS：オペレーティングシステムはサポートされていません。 Assist.Invalid：クラウドアシスタントが実行されていません。 Assist.Invoke：インストールプログラムの起動時にエラーが発生しました。 Assist.Execute：インストールプログラムの実行中にエラーが発生しました。	Assist.Invalid
LoongCollectorVersion	string	LoongCollector のバージョン。	0.1.0
LoongCollectorStatus	string	LoongCollector のステータス。	running

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F",
  "Success": true,
  "NodeStatusList": {
    "NodeStatus": [
      {
        "Status": "running",
        "InstanceId": "i-hp3dunahluwajv6f****",
        "AutoInstall": true,
        "OsMonitorStatus": "running",
        "OsMonitorErrorCode": "install_fail",
        "OsMonitorErrorDetail": "Command.ErrorCode.Fail.Downlaod.REGIN_ID",
        "OsMonitorVersion": "1.3.0-12",
        "OsMonitorConfig": "{\"sysak\":true}",
        "AgentInstallErrorCode": "Assist.Invalid",
        "LoongCollectorVersion": "0.1.0",
        "LoongCollectorStatus": "running"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Illegal parameters.
500	InternalError	%s
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.

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

変更履歴

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