Alert List

POST/alert/list

Request

search_after_ctx

string

Cursor pagination, defaults to first page if not set. Choose one between this and p parameter

optional

For detailed explanation, please refer to About Pagination

integer

Traditional pagination, starts from page 1 if not set, default value is 1. Choose one between this and search_after_ctx parameter

optional

When using traditional pagination, p*limit must not exceed 10000 when p parameter is set, otherwise returns parameter error. For detailed explanation, please refer to About Pagination

Default:

limit

integer

Items per page

optional

When p parameter is set, (p-1)*limit must not exceed 10000, otherwise returns parameter error. For detailed explanation, please refer to About Pagination

>= 0<= 100

Default:

asc

boolean

Ascending order

optional

Default sort by created_at in descending order

orderby

string

Sort field

optional

Supports created_at updated_at, default is created_at

title

string

Title filter

optional

Supports exact match, regex match and wildcard match. String with '/' prefix and suffix will be treated as regex. Example: specifying ('datacenter' IN ['bj01','sh-*','']) AND ('host' IN '/api-server-\d+/') will match alerts from data centers 'bj01' and 'sh-01','sh-02' with hostname matching regex 'api-server-\d+'

progress

string

Processing status

optional

Triggered,Closed
All (progress not provided)
Open (progress=Triggered)
Closed (progress=Closed)

alert_severity

string

Severity

optional

Critical, Info, Warning supports multiple values, comma separated

labels

object (Labels)

Label list

optional

^[a-zA-Z_][a-zA-Z0-9_]*$

string

(pattern property)

key can be any label name, value is string

optional

label format must match regex ^[a-zA-Z_][a-zA-Z0-9_]*$, value length must not exceed 512 bytes

<= 512 characters

channel_ids

array[integer]

Channel list

optional

data_source_ids

array[integer]

Integration source list

optional

alert_ids

array[string]

Alert ID list

required

ever_muted

boolean

Whether has been silenced/inhibited

optional

Not provided means query all, true means only return silenced or inhibited alerts, false means only return alerts never inhibited

start_time

integer

Start timestamp

required

This time is query's start_time, not related to alert's start_time. Actual search condition is: alert.start_time<=query.end_time and alert.last_time>=query.start_time

end_time

integer

End time

required

This time is query's end_time, not related to alert's end_time. Actual search condition is: alert.start_time<=query.end_time and alert.last_time>=query.start_time

{
  "search_after_ctx": "string",
  "p": 1,
  "limit": 20,
  "asc": true,
  "orderby": "string",
  "title": "string",
  "progress": "string",
  "alert_severity": "string",
  "labels": {},
  "channel_ids": [
    0
  ],
  "data_source_ids": [
    0
  ],
  "alert_ids": [
    "string"
  ],
  "ever_muted": true,
  "start_time": 0,
  "end_time": 0
}

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

error

object (DutyError)

optional

code

enum<string>

Error code

required

Allowed values:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

Error description

required

data

object

optional

items

array[object (Alert) {26}]

Alert entry

optional

search_after_ctx

string

Cursor pagination, presence indicates next page exists

optional

For detailed explanation, please refer to About Pagination

total

integer

Total matching entries

optional

Please note, total is only accurate when less than 1000, do not use this value to calculate pagination end. When total entries exceed 1000, system will only return total=1000, indicating 1000+ matches found. Please use has_next_page to determine if more data exists. For detailed explanation, please refer to About Pagination

has_next_page

boolean

Whether more unretreived data exists

optional

Not configured

Last modified: 2 个月前