Queries the status of the CloudMonitor agent.

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeMonitoringAgentStatuses

The operation that you want to perform. Set the value to DescribeMonitoringAgentStatuses.

InstanceIds String Yes i-hp3dunahluwajv6f****

The ID of the instance. Separate multiple instance IDs with commas (,).

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

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The HTTP status code 200 indicates that the call succeeds.
Message String The specified resource is not found.

The error message.

NodeStatusList Array of NodeStatus

The statuses.

NodeStatus
AutoInstall Boolean true

Indicates whether the automatic installation feature is enabled. Valid values:

  • true: The feature is enabled.
  • false: The feature is disabled.
InstanceId String i-hp3dunahluwajv6f****

The ID of the instance.

Status String running

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.
RequestId String 6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F

The ID of the request.

Success Boolean true

Indicates whether the call succeeds. Valid values:

  • true: The call succeeds.
  • false: The call fails.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeMonitoringAgentStatuses
&InstanceIds=i-hp3dunahluwajv6f****
&<Common request parameters>

Sample success responses

XML format

<DescribeMonitoringAgentStatusesResponse>
	  <RequestId>6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F</RequestId>
	  <NodeStatusList>
		    <NodeStatus>
			      <Status>running</Status>
			      <AutoInstall>true</AutoInstall>
			      <InstanceId>i-hp3dunahluwajv6f****</InstanceId>
		    </NodeStatus>
	  </NodeStatusList>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeMonitoringAgentStatusesResponse>

JSON format

{
  "RequestId": "6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F",
  "NodeStatusList": {
    "NodeStatus": [
      {
        "Status": "running",
        "AutoInstall": true,
        "InstanceId": "i-hp3dunahluwajv6f****"
      }
    ]
  },
  "Code": 200,
  "Success": true
}

Error codes

HttpCode Error code Error message Description
404 ResourceNotFound The specified resource is not found. The error message returned because the specified resource is not found.

For a list of error codes, visit the API Error Center.