Application Performance Management Plus
Application Performance Management Plus
Application Performance Management Plus
Document
What's new
product announcement
Product overview
Product billing
Getting Started
User guide
Server monitoring
Permission management
Component management
Integration guide
User guide
Best practices
FAQ
Client monitoring
App monitoring
FAQ
General app monitoring
Android-side monitoring
iOS-side monitoring
API references
Server monitoring API interface
Alert management
Query metrics
Trace analysis
Session analysis
Console API interfaces
Applications
Resource usage
Services
App API interface
Event
Log
Alert
Exceptions and crashes
Startup analytic
CPU monitoring
Network monitoring
Battery monitoring
WebPro API interface
General
Actions list
Alert
Blank screen monitoring
Custom monitor
Data explore
JavaScript error monitoring
Performance monitor
Version management
Request monitor
Resources monitor
Page list
Mini Pro API interface
JS error
Alert
Performance monitoring
Page list
PC APIs
Raw logs
Crashes
Alerts
FAQ
Product inquiries
- Documentation
Application Performance Management PlusAPI referencesWebPro API interfaceAlertGetAlarmDistribution
Copy page
Download PDFAlert
GetAlarmDistribution
Copy pageDownload PDFGetAlarmDistribution
Get the alert type distribution.
Request description
RUM is deployed across multiple regions worldwide to provide more stable and low-latency access. You can refer to the Service addresses topic to choose the most suitable access point based on your business location.
- Request method: POST
- Request URL: https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmDistribution&Version=2022-10-12
Request parameters
The following table lists only the request parameters specific to this API and some public parameters. For details, see Public parameters.
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Action | String | Yes | GetAlarmDistribution | The API name. The current API name is GetAlarmDistribution. |
Version | String | Yes | 2022-10-12 | The API version. The current API version is 2022-10-12. |
common | No | - | Common parameter. | |
time_filter | No | - | Time range. | |
name_list | Array of String | No | 111 | Alert task name list. Returns alert history for all names when left empty. Call the GetAlarmRuleList API to view available values. |
level_list | Array of String | No | warning | Alert level list. Returns all alert types when left empty.
|
category_list | Array of String | No | pageview | Alert type. If this parameter is not specified, the history alerts of all types are returned. Call the GetAlarmMeta API to view values. |
Common
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
aid | Long | No | 12345 | Application ID. |
os | String | No | webpro | Service type. |
TimeFilter
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
start_time | Integer | No | 1665849600 | Start time. |
granularity | Integer | No | 60 | Aggregation time granularity. Unit: s. |
end_time | Integer | No | 1666011403 | The end time. |
Sample request
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmDistribution&Version=2022-10-12
{
"common":{
"aid":12345,
"os":"webpro"
},
"time_filter":{
"start_time":1665849600,
"end_time":1666011403,
"granularity":3600
},
"page_size":10,
"page_num":1,
"category_list":[
"pageview"
],
"name_list":[
"111111111"
],
"level_list":[
"warning"
]
}
Response parameters
Parameters | Type | Sample value | Description |
Parameters | Type | Sample value | Description |
data | - | Returned data. | |
error_msg | String | "" | Error message. An empty string "" indicates success. |
error_no | Integer | 0 | Error code. 0 indicates success. |
Data
Parameters | Type | Sample value | Description |
Parameters | Type | Sample value | Description |
category | String | pageview | Alert task type. |
count | Long | 1407 | Alert count for this type. |
percent | Double | 1 | Proportion of alerts of this type in the total alerts. |
Sample response
{
"err_detail":"",
"data":"all-history_xxx-xxx.xlsx",
"error_msg":"",
"error_no":0
}
Error codes
No error codes are specific to this API. If the API call returns an error code, refer to Public error codes for troubleshooting.
Last updated: 2026.09.21 10:38:59
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
