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

Obtaining the Alarm Information List

Function

This API is used to obtain the alarm information list by page. Multi-condition filtering is supported.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/sec-ops/alarms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

alarm_level

No

String

Alarm severity.

alarm_name

No

String

Alarm name.

alarm_status

No

String

Alarm handling status.

end_time

No

Long

End timestamp of the query.

limit

No

Integer

Number of records returned on each page.

offset

No

Integer

Offset of pagination query.

responsible_person

No

String

Alarm owner.

source_name

No

String

Alarm source name.

source_type

No

String

Alarm source type.

start_time

No

Long

Start timestamp of the query.

verification_status

No

String

Verification status.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

alarm_info_list

Array of AlarmInfoNew objects

Alarm information list.

total

Integer

Total number of alarms.
Table 4 AlarmInfoNew

Parameter

Type

Description

affected_asset

Array of strings

Affected assets.

alarm_level

String

Alarm severity.

alarm_name

String

Alarm name.

alarm_status

String

Alarm status.

alarm_type

String

Alarm type.

close_reason

String

Reason for disabling the alarm.

create_time

Long

Alarm creation time.

description

String

Alarm description.

disposal_suggestion

String

Handling suggestions.

domain_id

String

Account ID.

id

Long

Alarm ID.

occur_time

Long

Alarm generation time.

project_id

String

Tenant ID.

responsible_person

UserInfo object

Owner.

source_instance

InstanceInfo object

Alarm source instance.

source_module

String

Alarm source module.

source_sub_type

String

Alarm source subtype.

source_type

String

Alarm source type.

verification_status

String

Verification status.
Table 5 UserInfo

Parameter

Type

Description

user_id

String

User ID.

user_name

String

Username.
Table 6 InstanceInfo

Parameter

Type

Description

instance_id

String

Instance ID.

instance_name

String

Instance name.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error 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