All Products
Search
Document Center

Simple Application Server:DescribeMonitorData

Last Updated:Apr 17, 2024

Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server.

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 server. 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 token 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
InstanceIdstringYes

The ID of the simple application server.

2ad1ae67295445f598017499dc****
MetricNamestringYes

The name of the metric. Valid values:

  • MEMORY_ACTUALUSEDSPACE: the memory usage. Unit: bytes.
  • DISKUSAGE_USED: the disk usage. Unit: bytes.
  • CPU_UTILIZATION: the CPU usage, in percentage.
  • VPC_PUBLICIP_INTERNETOUT_RATE: the outbound bandwidth. Unit: bits/s.
  • VPC_PUBLICIP_INTERNETIN_RATE: the inbound bandwidth. Unit: bits/s.
  • DISK_READ_IOPS: the read IOPS of the disk. Unit: count/s.
  • DISK_WRITE_IOPS: the write IOPS of the disk. Unit: count/s.
  • FLOW_USED: the traffic usage. Unit: bytes.
DISKUSAGE_USED
PeriodstringYes

The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.

Note

If MetricName is set to FLOW_USED, Period is set to 3600 (one hour). In other cases, set Period based on your business requirements.

**


60
StartTimestringYes

The beginning of the time range to query. The following formats are supported:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.
  • Time format: YYYY-MM-DDThh:mm:ssZ.
Note The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.

The interval between the start time and the end time is less than or equal to 31 days.

**


2022-09-07T04:04:44Z
EndTimestringYes

The end of the time range to query. The following formats are supported:

  • UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 January 1, 1970.
  • Time format: YYYY-MM-DDThh:mm:ssZ.
Note The interval between the start time and the end time is less than or equal to 31 days.
2022-09-08T08:04:44Z
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
LengthstringNo

The number of entries per page. Valid values: 1 to 1440.

100

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E****
Datapointsstring

The monitoring data.

[]
Periodstring

The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds.

Note

If MetricName is set to FLOW_USED, the value of Period is 3600 (one hour).

**


60
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***

Examples

Sample success responses

JSONformat

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "Datapoints": "[]",
  "Period": "60",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\n"
}

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.