DescribeMonitoringAgentStatuses - Cloud Monitor - Alibaba Cloud Documentation Center

You can call the DescribeMonitoringAgentStatuses operation to query the status of the CloudMonitor agent.

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeMonitoringAgentStatuses

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	string	No	The instance IDs. Separate multiple instance IDs with commas (,).	i-hp3dunahluwajv6f****
HostAvailabilityTaskId	string	No	The ID of the availability monitoring task.	126****

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	string	The HTTP status code. Note 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_failed: 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 Analysis 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	The LoongCollector version.	0.1.0
LoongCollectorStatus	string	The LoongCollector status.	running

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.