Help Center/ Data Security Center/ API Reference/ API Description/ Data Security Operations/ Viewing the Alarm List
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Viewing the Alarm List

Function

Query the alarm list by page. Alarms can be filtered by period and severity.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/alarms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

cycle

Yes

String

Query period.

level

No

String

Alarm severity.

limit

No

Integer

Number of records returned on each page.

offset

No

Integer

Offset of pagination query.

source_name

No

String

Data source name.

source_type

No

String

Data source type.

type

No

String

Alarm type.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

alarms

Array of AlarmInfo objects

Alarm information list.

total

Long

Total number of alarms.
Table 4 AlarmInfo

Parameter

Type

Description

id

Integer

Alarm ID.

project_id

String

Tenant ID.

domain_id

String

Account ID.

instance_id

String

Instance ID.

instance_name

String

Instance name.

source_type

String

Alarm source type.

type

String

Alarm type.

level

String

Alarm type.

alarm_time

Integer

Alarm generation time.

status

String

Alarm status.

alarm

String

Detailed alarm information.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Data Security Operations