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

Obtaining the Alarm Information

Function

This API is used to obtain the alarm list of devices in a project.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/devices/alarms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

offset

No

Integer

Pagination offset.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

alarm_infos

Array of AlarmInfo objects

array

total

Integer

Total number of alarms.
Table 4 AlarmInfo

Parameter

Type

Description

count

Integer

integer

create_time

Long

Creation time.

description

String

Description.

device_ip

String

Device IP address.

id

Long

Alarm ID.

module

String

Alarm module.

name

String

Alarm name.

severity

Integer

Severity. The value can be 1 (critical), 2 (major), 3 (minor), 4 (warning), 5 (indeterminate), or 6 (cleared).

status

String

Alarm status.

type

Integer

Device type.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Query result.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project does not exist.

Error Codes

See Error Codes.

Parent topic: Device Management