All Products
Search
Document Center

Simple Application Server:DescribeCloudMonitorAgentStatuses

Last Updated:Apr 17, 2024

Queries the status of the CloudMonitor agent on simple application servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application servers. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
InstanceIdsstringYes

The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).

["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E1FEE
InstanceStatusListobject []

Indicates whether the Cloud Monitor agent was automatically installed on the simple application server.

Statusstring

The running status of the Cloud Monitoring plug-in. Possible values are:

  • running: Cloud Monitoring plug-in running.
  • stopped: Cloud Monitoring plug-in stopped.
  • installing: Cloud Monitoring plug-in installing.
  • install_faild: Cloud Monitoring plug-in installation failed.
  • abnormal: Cloud Monitoring plug-in installation abnormal.
  • not_installed: Cloud Monitoring plug-in not installed.
running
InstanceIdstring

The ID of the simple application server.

c854dc6f07e74953830bb5808d0****
AutoInstallboolean

Indicates whether the Cloud Monitor agent was automatically installed on the simple application server. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E1FEE",
  "InstanceStatusList": [
    {
      "Status": "running",
      "InstanceId": "c854dc6f07e74953830bb5808d0****",
      "AutoInstall": true
    }
  ]
}

Error codes

HTTP status codeError codeError message
500InternalErrorAn error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history