DescribeMonitoringAgentStatuses - 查詢CloudMonitor外掛程式運行狀態 - Cloud Monitor

調用DescribeMonitoringAgentStatuses介面查詢CloudMonitor外掛程式運行狀態。

介面說明

This topic describes how to query the status of the CloudMonitor agent that is installed on the i-hp3dunahluwajv6f**** instance. The result indicates that the CloudMonitor agent is in the running state.

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeMonitoringAgentStatuses

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceIds	string	否	The instance IDs. Separate multiple instance IDs with commas (,).	i-hp3dunahluwajv6f****
HostAvailabilityTaskId	string	否	The ID of the availability monitoring task.	126****

For more information about common request parameters, see Common parameters.

返回參數

名稱	類型	描述	樣本值
	object	The response parameters.
Code	string	The HTTP status code. 說明 The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
NodeStatusList	object
NodeStatus	array<object>	The host status information.
	object
Status	string	The status of the CloudMonitor agent. Valid values: running: The CloudMonitor agent is running. stopped: The CloudMonitor agent is stopped. installing: The CloudMonitor agent is being installed. install_faild: The CloudMonitor agent fails to be installed. abnormal: The CloudMonitor agent is not properly installed. not_installed: The CloudMonitor agent is not installed.	running
InstanceId	string	The instance ID.	i-hp3dunahluwajv6f****
AutoInstall	boolean	Indicates whether the CloudMonitor agent is automatically installed. Valid values: true: The CloudMonitor agent is automatically installed. false: The CloudMonitor agent is not automatically installed.	true
OsMonitorStatus	string	The status of SysOM. Valid values: installing: SysOM is being installed. running: SysOM is running. stopped: SysOM is stopped. uninstalling: SysOM is being uninstalled.	running
OsMonitorErrorCode	string	The error status of SysOM. Valid values: `install_fail`: SysOM fails to be installed or an unknown error occurs. `install_assist_invalid`: SysOM fails to be installed because the status of Cloud Assistant is invalid. `install_assist_command_fail`: SysOM fails to be installed because the installation command fails to run. `uninstall_fail`: SysOM fails to be uninstalled or an unknown error occurs. `uninstall_assist_invalid`: SysOM fails to be uninstalled because the status of Cloud Assistant is invalid. `uninstall_assist_command_fail`: SysOM fails to be uninstalled because the uninstallation command fails to run.	install_fail
OsMonitorErrorDetail	string	The details of the execution error. Valid values: `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID. `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK). `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file. `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found. `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.	Command.ErrorCode.Fail.Downlaod.REGIN_ID
OsMonitorVersion	string	The SysOM version.	1.3.0-12
OsMonitorConfig	string	Indicates whether the SysAK monitoring feature is enabled.`` Valid values: `true`: The SysAK monitoring feature is enabled. `false`: the SysAK monitoring feature is disabled.	{"sysak":true}
AgentInstallErrorCode	string	The error code returned when the CloudMonitor agent is installed. Valid values: Common.Timeout: The installation timed out. Common.SLR: The service-linked role for CloudMonitor is unauthorized. Common.OS: The operating system is not supported. Assist.Invalid: Cloud Assistant is not running. Assist.Invoke: An error occurred when the installation program is started. Assist.Execute: An error occurred when the installation program is running.	Assist.Invalid
LoongCollectorVersion	string	LoongCollector Version	0.1.0
LoongCollectorStatus	string	LoongCollector Status	running

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	未找到指定資源。

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

變更歷史

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