Queries Application Monitoring or Browser Monitoring metrics with pagination.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| IntervalInSec |
integer |
No |
The time interval for querying metric data. Unit: milliseconds. Minimum value: 60000. |
100000 |
| StartTime |
integer |
Yes |
The start of the time range to query. Unit: milliseconds. |
1667287695000 |
| EndTime |
integer |
Yes |
The end of the time range to query. Unit: milliseconds. |
1667546895000 |
| OrderBy |
string |
No |
The sorting dimension. Valid values are listed in the metric tables below. |
pid |
| Metric |
string |
Yes |
The metric to query. Custom metrics are not supported. Valid values are listed in the metric tables below. |
appstat.host |
| Order |
string |
No |
The sort order. Valid values:
Note
If not specified, data is not sorted. |
ASC |
| CurrentPage |
integer |
No |
The page number. Default value: |
1 |
| PageSize |
integer |
No |
Deprecated. The number of entries per page. |
10 |
| Filters |
array<object> |
No |
The filter conditions. |
|
|
object |
No |
The information about the array object. |
||
| Key |
string |
No |
The filter key. Set to |
pid |
| Value |
string |
No |
The value of the |
xxx@74xxx |
| Dimensions |
array |
No |
The metric dimensions to query. |
["detector_browser","detector_device"] |
|
string |
No |
The metric dimensions to query. Maximum: 5. Valid values are listed in the metric tables below. |
pid |
|
| Measures |
array |
No |
The metric measures to query. |
pv |
|
string |
No |
The metric measures to query. Maximum: 5. Valid values are listed in the metric tables below. |
instanceCount |
|
| CustomFilters |
array |
No |
Custom filter conditions. |
|
|
string |
No |
Custom filter conditions. Separate multiple filter conditions with commas (,). |
["not rpcType:40","not rpcType:41"] |
Obtain the PID of an application
In the ARMS console, choose Application Monitoring > Application List or Browser Monitoring > Browser Monitoring, and then click the target application.
The URL contains the application PID in pid=xxx format, percent-encoded as xxx%40xxx. Replace %40 with @. For example, eb4zdose6v%409781be0f44d**** becomes eb4zdose6v@9781be0f44d****.
Application Monitoring metrics supporting query
Note Set the pid and regionId filters in the Filters parameter. Include all known filter conditions to narrow query results. If no filters are known, specify one or more dimensions from the table below.
| Metric | Description | Dimension | Measurement |
| appstat.vm | JVM monitoring metrics: GCs, heap memory, non-heap memory, and threads. | - pid- rootIp | GC metrics:- youngGcCount: the number of GCs in the young generation- oldGcCount: the number of full heap GCs (full GCs)- youngGcTime: the amount of time consumed by GCs in the young generation- oldGcTime: the amount of time consumed by full GCs- youngGcCountInstant: the instantaneous value of the number of GCs in the young generation- oldGcCountInstant: the instantaneous value of the number of full GCs- youngGcTimeInstant: the instantaneous value of the amount of time consumed by GCs in the young generation- oldGcTimeInstant: the instantaneous value of the amount of time consumed by full GCs |
| appstat.vm | JVM monitoring metrics: GCs, heap memory, non-heap memory, and threads. | - pid- rootIp | Heap memory and non-heap memory:- edenSpace: the eden space in the young generation- oldGen: the old generation- survivorSpace: the survivor space in the young generation- metaSpace: the metaspace- nonHeapCommitted: the non-heap memory- nonHeapInit: the initial value of the non-heap memory- nonHeapMax: the maximum value of the non-heap memory- nonHeapUsed: the usage of the non-heap memory- directUsed: the amount of used direct buffer in the off-heap memory- directCapacity: the total amount of direct buffer in the off-heap memory |
| appstat.vm | JVM monitoring metrics: GCs, heap memory, non-heap memory, and threads. | - pid- rootIp | Number of threads:- threadCount: the total number of threads- threadNewCount: the number of new threads- threadDeadlockCount: the number of deadlocked threads in the JVM- threadRunnableCount: the number of runnable threads in the JVM- threadTerminatedCount: the number of terminated threads- threadTimedWaitCount: the number of threads in the timed_waiting state- threadWaitCount: the number of threads in the waiting state- threadBlockedCount: the number of blocked threads |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | instanceCount: the number of instances |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | CPU:- systemCpuIdle: the percentage of idle CPU in the last 5 seconds, which is not displayed in the ARMS console- systemCpuSystem: the CPU utilization of the system in the last 5 seconds- systemCpuUser: the percentage of CPU occupied by users in the last 5 seconds- systemCpuIoWait: the percentage of CPU consumed for I/O waiting in the last 5 seconds |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | Physical memory:- systemMemFree: the amount of free memory (Unit: KB)- systemMemUsed: the amount of used memory (Unit: KB)- systemMemTotal: the total amount of memory, which is not displayed in the ARMS console (Unit: KB)- systemMemBuffers: the amount of memory in the buffer cache- systemMemCached: the amount of memory in the page cache |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | Disk:- systemDiskFree: the size of free disk space in bytes- systemDiskUsedRatio: the usage of the disk space- SystemDiskTotal: the total size of disk space in bytes, which is not displayed in the ARMS console |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | systemLoad: the load |
| appstat.host | A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets. | - pid- rootIp | Network:- systemNetInPackets: the average number of packets received over the network per second in the last 30 seconds- systemNetOutPackets: the average number of packets sent over the network per second in the last 30 seconds- systemNetInErrs: the average number of frame errors received over the network per second in the last 30 seconds- systemNetOutErrs: the average number of errors sent over the network per second in the last 30 seconds- systemNetInBytes: the average number of bytes received over the network per second in the last 30 seconds- systemNetOutBytes: the average number of bytes sent over the network per second in the last 30 seconds |
| appstat.database | A collection of metrics for database calls. | - pid- rpcType: the type of the call- endpoint: the database endpoint, which is localhost: 3306- destId: the database name, which is arms | - rt: the response time (Unit: milliseconds).- count: the number of requests.- error: the number of errors.- resultsize: This metric is available only for MySQL 5.x.- slowcount: the number of slow calls. |
| appstat.incall | A collection of metrics related to application details. | - pid- rpcType- rootIp- rpc- ppid | - rt: the response time (Unit: milliseconds)- count: the number of requests- error: the number of errors- errorrate: the error rate- qps: the number of queries per second |
| appstat.exception | A collection of metrics related to exceptions. | - pid- rpc- endpoint- excepType- excepInfo | - rt: the response time (Unit: milliseconds)- count: the number of requests- error: the number of errors |
| appstat.sql | A collection of metrics related to slow SQL queries. | - pid- rpc- endpoint- sqlId | - rt: the response time (Unit: milliseconds).- count: the number of requests.- error: the number of errors.- slowcount: the number of slow calls.- resultsize: This metric is available only for MySQL 5.x.Note: If the value of the slow metric is true, the filter conditions do not take effect. |
| appstat.mq.send | A collection of metrics related to message sending by using a message queue. | None | - rt: the response time (Unit: milliseconds)- count: the number of requests- error: error: the number of errors- delay: the scheduling delay (Unit: milliseconds) |
| appstat.mq.receive | A collection of metrics related to message receiving by using a message queue. | None | - rt: the response time (Unit: milliseconds)- count: the number of requests- error: error: the number of errors- delay: the scheduling delay (Unit: milliseconds) |
| appstat.schedulerx | A collection of metrics related to SchedulerX calls. | - pid- rpcType- rootIp- rpc | count: the number of requests |
| appstat.elasticsearch | A collection of metrics related to Elasticsearch calls. | - rpc- endpoint- opType: the type of the operation, such as index and search operations. This dimension is supported only when elasticsearch-rest-high-level-client is used. | count: the number of requests |
| appstat.redis | A collection of metrics related to ApsaraDB for Redis calls. | - pid- rpcType- endpoint- opType- rpc | count: the number of requests |
| appstat.status | The number of requests with specified status codes. Only HTTP requests are supported. | - pid- rootIp- rpc | - 200: the number of requests with the 200 status code (abnormal)- 2xx: the number of requests with 2XX status codes (abnormal)- 3xx: the number of requests with 3XX status codes- 4xx: the number of requests with 4XX status codes (client errors)- 5xx: the number of requests with 5XX status codes (server errors) |
Browser Monitoring metrics supporting query
The following Browser Monitoring metrics are available.
Note Set the pid and regionId filters in the Filters parameter. Include all known filter conditions to narrow query results. If no filters are known, specify one or more dimensions from the table below.
| Metric | Description | Dimension | Measurement |
| webstat.api | Success rate of API requests | - api: the URL of the API without request parameters- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution | - count: the number of requests- rate: the success rate of API requests- avg_time: the average response time |
| webstat.api.detail | API details | - api: the URL of the API without request parameters- ct: the network connection type- detector_browser: the browser- detector_browser_version: the version of the browser- detector_device: the device- detector_os: the operating system- detector_os_version: the version of the operating system- domain: the domain name- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- msg: the returned message- page: the URL of the page- sr: the screen resolution | - count: the number of requests- fail_count: the number of failed API requests- fail_time: the response time for failed API requests- fail_uv: the number of users affected by failures- success_count: the number of successful API requests- success_rate: the success rate- success_time: the response time for successful API requests |
| webstat.apicost | Response time for successful API requests | - api: the URL of the API without request parameters- code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution | - count: the number of successful API requests- avg_time: the average response time for successful API requests |
| webstat.apifailtime | Response time for failed API requests | - api: the URL of the API without request parameters- code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution | - count: the number of failed API requests- avg_time: the average response time for failed API requests |
| webstat.apimsg | Classification and aggregation of API response messages | - code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- msg: the error message- release: the version number- sr: the screen resolution- success: The value 1 indicates that the request is successful and the value 0 indicates that the request has failed. | count: the number of requests |
| webstat.avg | Custom statistics: average | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- key: the custom key- sr: the screen resolution | - count: the total number of occurrences- pv: the number of page views- uv: the number of unique visitors- avg_val: the average value |
| webstat.errcate | Error message ranking | - msg: the error message- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- detector_browser: the browser- detector_device: the device- detector_os: the operating system- sr: the screen resolution- release: the version number- environment: the environment- detector_app_version: the client version- detector_app: the client app | count: the number of errors |
| webstat.index | Page view overview | - ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution | - pv: the number of page views- uv: the number of unique visitors |
| webstat.msg.top | Frequent errors | - msg: the error message- page: the URL of the page | - count: the number of errors- error_uv: the number of affected users- Ratio of affected users: the ratio obtained by dividing affected users by total UVs |
| webstat.perf.bucket | Performance Sample Distribution section on the Page Speed page in the ARMS console | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution | - cfpt: the custom first paint time (FPT) of the page- ctti: the custom time to interact (TTI) of the page- dns: the amount of time consumed by DNS query- dom: the amount of time consumed by DOM parsing- fmp: the first meaningful paint (FMP) of the page- fpt: the FPT of the page- load: the amount of time consumed to completely load the page- ready: the time taken for the DOM to become ready- res: the amount of time consumed to load resources- ssl: the amount of time consumed to establish a Secure Sockets Layer (SSL) connection- t1\~t10: the custom performance metrics- tcp: the amount of time consumed to establish a Transmission Control Protocol (TCP) connection- trans: the amount of time consumed to transfer the content of the page- ttfb: the time to first byte (TTFB)- tti: the TTI of the page |
| webstat.perf.distribution | Performance Stacked Area Chart on the Page Speed page in the ARMS console | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution | - cfpt: the custom FPT of the page- ctti: the custom TTI of the page- dns: the amount of time consumed by DNS query- dom: the amount of time consumed by DOM parsing- fmp: the FMP of the page- fpt: the FPT of the page- load: the amount of time consumed to completely load the page- ready: the time taken for the DOM to become ready- res: the amount of time consumed to load resources- ssl: the amount of time consumed to establish an SSL connection- t1\~t10: the custom performance metrics- tcp: the amount of time consumed to establish a TCP connection- trans: the amount of time consumed to transfer the content of the page- ttfb: the TTFB- tti: the TTI of the page |
| webstat.resource | Resource error ranking | - ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- node_name: the error type- page: the URL of the page- sr: the screen resolution- src: the resource information | count: the number of resource errors |
| webstat.resource | Resource Error section on the Overview page in the ARMS console | - ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- node_name: the error type- page: the URL of the page- sr: the screen resolution- src: the resource information | count: the number of errors |
| webstat.satisfy | Satisfaction | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution | - bad: frustrated, indicating that the FPT is greater than 8,000- good: satisfied, indicating that the FPT is smaller than 2,000- neutral: tolerable, indicating that the FPT is between 2,000 and 8,000- satisfy: Application Performance Index (Apdex) |
| webstat.session | Slow loading tracking | None | - browser_version: the browser version- browser: the browser- date: the start time of the data query- dom: the amount of time consumed by DOM parsing- ip_country_id: the ID of the country or area- ip_country: the name of the country or area- ip_region_id: the ID of the region- ip_region: the name of the region- load: the amount of time consumed to completely load the page- page: the URL of the page- sid: the session ID |
| webstat.speed | Access speed | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution- page: the URL of the page- environment: the environment | - avg_cfpt: the custom FPT of the page- count: the number of samples- avg_ctti: the custom TTI of the page- avg_dns: the amount of time consumed by DNS query- avg_dom: the amount of time consumed by DOM parsing- avg_fmp: the FMP of the page- avg_fpt: the FPT of the page- avg_load: the amount of time consumed to completely load the page- avg_ready: the average time taken for the DOM to become ready- avg_res: the amount of time consumed to load resources- avg_ssl: the amount of time consumed to establish an SSL connection- avg_t1\~t10: the custom performance metrics- avg_tcp: the amount of time consumed to establish a TCP connection- avg_trans: the amount of time consumed to transfer the content of the page- avg_ttfb: the TTFB- avg_tti: the TTI of the page |
| webstat.stable | Error rate ranking | - page: the URL of the page- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- detector_browser: the browser- detector_device: the device- detector_os: the operating system- sr: the screen resolution- msg: the error message- release: the version number- environment: the environment- detector_app_version: the client version- detector_app: the client app | - count: the number of samples- error_pv: the number of JS errors- rate: the JS error rate |
| webstat.sum | Custom statistics: sum | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- key: the custom key- sr: the screen resolution | - count: the total number of occurrences of specified events- pv: the number of page views- sum_val: the total value- uv: the number of unique visitors |
| webstat.url | Access URL | - detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- sr: the screen resolution- uid- username: the username | - pv: the number of page views- uv: the number of unique visitors |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The information about the array object. |
||
| Code |
string |
The HTTP status code. Valid values:
|
200 |
| Message |
string |
The error message returned on failure. |
StartTime is mandatory for this action. |
| RequestId |
string |
The request ID. |
687F9CB7-4798-57BF-A6EE-E6CC76****** |
| Success |
boolean |
Whether the request succeeded. Valid values:
|
true |
| Data |
object |
The returned data object. |
|
| PageSize |
integer |
The number of entries returned per page. |
1 |
| Total |
integer |
The total number of entries returned. |
2 |
| Page |
integer |
The page number of the returned page. |
1 |
| Completed |
boolean |
Whether the paging query is complete.
|
false |
| Items |
array<object> |
The data entries returned. |
|
|
object |
The data entries returned. |
[] |
Sample response
{
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
"Data": {
"PageSize": 1,
"Total": 87,
"Page": 1,
"Items": [
{
"date": 1667287680000,
"instanceCount": 17,
"rule": "query1",
"pid": "null"
},
{
"date": 1667290680000,
"instanceCount": 17,
"rule": "query1",
"pid": "null"
}
]
},
"Code": 200,
"Success": true
}
Examples
Success response
JSON format
{
"Code": "200",
"Message": "StartTime is mandatory for this action.",
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
"Success": true,
"Data": {
"PageSize": 1,
"Total": 2,
"Page": 1,
"Completed": false,
"Items": [
[]
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 452 | OperationTimeOut | The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again. | The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again. |
| 400 | ParameterMetricIllegal | The specified metric is invalid. | The specified metric is invalid. |
| 400 | ParameterMeasuresIllegal | The specified Measures is invalid. | The specified Measures is invalid. |
| 400 | ParameterTimeStampIllegal | The specified timeStamp is invalid. | The specified timeStamp is invalid. |
| 400 | ParameterOrderIllegal | The specified order is invalid. | The specified order is invalid. |
| 400 | ParameterZeroStrategyIllegal | The specified zeroStrategy is invalid. | The specified zeroStrategy is invalid. |
| 400 | ParameterPageSizeIllegal | The specified PageSize is invalid. | The specified PageSize is invalid. |
| 400 | ParameterIntervalIllegal | The specified interval is invalid. | The specified interval is invalid. |
| 400 | ParameterMeasuresMissing | You must specify measures. | You must specify measures. |
| 400 | ParameterDimensionsIllegal | The specified dimensions is invalid. | The specified dimensions is invalid. |
| 400 | ParameterPidMissing | You must specify pid. | You must specify pid. |
| 400 | ParameterRegionIdIllegal | The specified RegionId is invalid. | The specified RegionId is invalid. |
| 400 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | |
| 400 | ParameterRegionIllegal | The specified region is invalid. | The specified region is invalid. |
| 403 | APINotAuthorize | The current user is not authorized to access the interface. | The current user is not authorized to access the interface. |
| 404 | AppNotExist | The application does not exist. | The application does not exist. |
| 404 | RunningTaskNotExist | Application data collection task does not exist or has been stopped. | Application data collection task does not exist or has been stopped |
| 429 | OperationIsThrottled | The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again. | The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.