Retrieves a list of alert rules from a specified project.
Try it now
Test
RAM authorization
Request syntax
GET /alerts HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| offset |
integer |
No |
The project name. |
0 |
| size |
integer |
No |
The line from which to start the query. The default value is 0. |
10 |
| logstore |
string |
No |
The number of rows to return per page for a paged query. The maximum value is 200, and the default value is 10. |
ali-test-logstore |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| total |
integer |
The total number of alerts in the project. |
80 |
| count |
integer |
The number of alerts returned in the current response. |
10 |
| results |
array |
The list of alert configurations. |
|
| Alert |
The alert configuration. |
Examples
Success response
JSON format
{
"total": 80,
"count": 10,
"results": [
{
"name": "alert-123456",
"displayName": "alertNameExample",
"description": "Alert Desc",
"configuration": {
"muteUntil": 1698907508,
"version": "2.0",
"type": "default",
"templateConfiguration": {
"id": "sls.app.ack.ip.not_enough",
"type": "sys",
"version": "1",
"lang": "cn",
"tokens": {
"test": "test",
"test2": 1
},
"aonotations": {
"test": "test",
"test2": 1
}
},
"dashboard": "dasnboardExample",
"threshold": 1,
"noDataFire": false,
"noDataSeverity": 6,
"sendResolved": false,
"queryList": [
{
"chartTitle": "chartExmaple",
"query": "* | select *",
"timeSpanType": "Relative",
"start": "-5m",
"end": "now",
"storeType": "log",
"project": "projectExample",
"store": "store Example",
"region": "cn-hangzhou",
"roleArn": "",
"dashboardId": "dashboardExample",
"powerSqlMode": "auto",
"ui": ""
}
],
"annotations": [
{
"key": "title",
"value": "example value"
}
],
"labels": [
{
"key": "title",
"value": "example value"
}
],
"conditionConfiguration": {
"condition": "cnt > 100",
"countCondition": "__count__ > 5"
},
"severityConfigurations": [
{
"severity": 8,
"evalCondition": {
"condition": "cnt > 100",
"countCondition": "__count__ > 5"
}
}
],
"joinConfigurations": [
{
"type": "left_join",
"condition": "$0.id == $1.id"
}
],
"groupConfiguration": {
"type": "custom",
"fields": [
"id"
]
},
"policyConfiguration": {
"alertPolicyId": "sls.builtin.dynamic",
"actionPolicyId": "example_action_policy",
"repeatInterval": "10m"
},
"autoAnnotation": false,
"sinkEventStore": {
"enabled": true,
"endpoint": "cn-shanghai-intranet.log.aliyuncs.com",
"project": "exampleProject",
"eventStore": "exampleStore",
"roleArn": "acs:ram::123456789:role/aliyunlogetlrole"
},
"sinkCms": {
"enabled": true
},
"sinkAlerthub": {
"enabled": true
},
"tags": [
"host"
]
},
"schedule": {
"type": "Cron",
"cronExpression": "0/5 * * * *",
"runImmediately": false,
"timeZone": "\"+0800\"",
"delay": 4,
"interval": "1m/1h"
},
"createTime": 0,
"lastModifiedTime": 0,
"status": "ENABLED/DISABLED"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.