QueryMetric - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

Queries a metric.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
IntervalInSec	integer	Yes	The time interval at which you want to query metric data. Unit: milliseconds. Minimum value: 60000. Note If you set this parameter to 2147483647, all data in the specified time interval is returned.	100000
StartTime	long	Yes	The timestamp of the start time of the time range to query. The timestamp is accurate to milliseconds.	1575561600000
EndTime	long	Yes	The timestamp of the end time of the time range to query. The timestamp is accurate to milliseconds.	1575622455686
OrderBy	string	No	The field based on which you want to sort the returned entries.	count
Limit	integer	No	The maximum number of entries that you want to return.	100
Metric	string	Yes	The name of the metric. Valid values: `appstat.incall`: trace statistics `appstat.sql`: SQL statistics	appstat.incall
Order	string	No	The order in which you want to sort the returned entries. Valid values: ASC: ascending order DESC: descending order	ASC
ProxyUserId	string	No	The ID of the proxy user.	testefgag12
Filters	array<object>	No	The filter conditions.
	object	No	The filter conditions.
Key	string	No	The key of the field that you want to use to filter the returned entries.	http.status_code
Value	string	No	The value of the field that you want to use to filter the returned entries.	200
Dimensions	array	No	The dimensions of the metric that you want to query.
	string	No	The dimensions of the metric that you want to query.	pid
Measures	array	Yes	The measures of the metric that you want to query.
	string	Yes	If you set the Metric parameter to `appstat.incall`, the Measures parameter has the following valid values: `rt`: response time `count`: total number of records that you want to return `error`: number of errors `exception`: exception `errorrate`: error rate `qps`: number of requests per second If you set the Metric parameter to `appstat.sql`, the Measures parameter has the following valid values: `rt`: response time `count`: total number of records that you want to return `error`: number of errors `slowcount`: number of slow calls	rt

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The returned statistics.	{ "RequestId": "E2373982-D8CD-413D-B991-8EB678******", "Data": "{\"data\":[{\"date\":1583686800000,\"count\":0,\"rt\":0,\"rpc\":\"childSpan3\"}}
RequestId	string	The ID of the request.	1E2B6A4C-6B83-4062-8B6F-AEEC1F******

Examples

Sample success responses

JSONformat

{
  "Data": "{   \"RequestId\": \"E2373982-D8CD-413D-B991-8EB678******\",   \"Data\": \"{\\\"data\\\":[{\\\"date\\\":1583686800000,\\\"count\\\":0,\\\"rt\\\":0,\\\"rpc\\\":\\\"childSpan3\\\"}}",
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1F******"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history