DescribeMonitorData - Simple Application Server - Alibaba Cloud Documentation Center

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

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

swas-open:DescribeMonitorData

get

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
ClientToken	string	No	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
InstanceId	string	Yes	The ID of the simple application server.	2ad1ae67295445f598017499dc****
MetricName	string	Yes	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
Period	string	Yes	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, set Period to 3600 (one hour). In other cases, set Period based on your business requirements.	60
StartTime	string	Yes	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
EndTime	string	Yes	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
NextToken	string	No	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***
Length	string	No	The number of entries per page. Valid values: 1 to 1440.	100

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
Datapoints	string	The monitoring data.	[]
Period	string	The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds. Note If you set the MetricName request parameter to FLOW_USED, the value of Period is 3600 (one hour).	60
NextToken	string	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

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.