edit-icon download-icon

QueryMonitorInfoRequest

Last Updated: Jan 31, 2018

Function

Queries the information of basic monitoring and service monitoring.

Request URL

/pop/v5/monitor/queryMonitorInfo

Request method

POST

Request parameters

Parameter Type Required? Description
start Long Yes Start time; unit: ms
end Long Yes End time; unit: ms
metric String Yes Metric. A total of 21 metrics are available.
tags Json Yes Dimension
aggregator String Yes Aggregation mode. Optional values: sum; avg; max; min.
interval String No Time granularity. Optional values: 1m (1 minute); 5m (5 minutes); 15m (15 minutes); 1h (1 hour). The default value is 1m.

Description of tags

MapSerialized JSON string. The application dimension, application group dimension, application instance dimension, and service dimension are supported.

Dimension Required tagK field
Application appId
Application group appId and groupId
Application instance appId, groupId, and eccId
Service appId, groupId, and serviceName
Called application group appId、groupId、targetAppId、targetGroupId
Called service appId、groupId、targetAppId、targetGroupId、targetServiceName

Combinations supported by metric, tags, and aggregator

Metric Meaning Dimension Aggregator
system.cpu CPU usage Application, application group, and application instance min, max, and avg
system.load Load Application, application group, and application instance min, max, and avg
system.memory.total Total memory Application, application group, and application instance min, max, and avg
system.memory.used Used memory Application, application group, and application instance min, max, and avg
system.net.out Network speed Tx Application, application group, and application instance sum and avg
system.net.in Network speed Rx Application, application group, and application instance sum and avg
system.disk.total Total disk capacity Application, application group, and application instance min, max, and avg
system.disk.used Used disk capacity Application, application group, and application instance min, max, and avg
system.disk.io.out Disk read speed Application, application group, and application instance min, max, and avg
system.disk.io.in Disk write speed Application, application group, and application instance min, max, and avg
system.disk.count.out Number of disk read requests Application, application group, and application instance min, max, and avg
system.disk.count.in Number of disk write requests Application, application group, and application instance min, max, and avg
service.http.qps HTTP call QPS Application group and service sum
service.http.errorQps HTTP call error QPS Application group and service sum
service.http.rt HTTP call RT Application group and service avg
service.rpc.server.qps HSF provider call QPS Application group and service sum
service.rpc.server.errorQps HSF provider call error QPS Application group and service sum
service.rpc.server.rt HSF provider local RT Application group and service avg
service.rpc.client.qps HSF client call QPS Called application group and called service sum
service.rpc.client.errorQps HSF client call error QPS Called application group and called service sum
service.rpc.client.rt HSF client local RT Called application group and called service avg

Response parameters

Parameter Type Description
Code Integer Response code
Message String Response message
MonitorInfo Json Monitoring information, compliant with the open TSDB standard

Other instructions

  1. Rate throttling policy of this API: No more than 1,200 total calls per minute; No more than 20 total calls per user per minute.
  2. The query time span (end time minus start time) is up to seven days.
Thank you! We've received your feedback.