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

Obtaining the Alarm Overview

Function

This API is used to obtain the overview of alarm statistics.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

alarm_source_info

AlarmSourceInfo object

Alarm source statistics.

total_alarm

AlarmLevelInfo object

Alarm severity statistics.

turn_off_num

Integer

Number of disabled alarms.

turn_on_num

Integer

Number of enabled alarms.

untreated_alarm

AlarmLevelInfo object

Unhandled alarm severity statistics.
Table 3 AlarmSourceInfo

Parameter

Type

Description

api_num

Integer

Number of API instance alarms.

cbh_num

Integer

Number of CBH instance alarms.

database_encrypt_num

Integer

Number of database encryption instance alarms.

database_op_num

Integer

Number of database O&M instance alarms.

dbss_num

Integer

Number of database audit instance alarms.
Table 4 AlarmLevelInfo

Parameter

Type

Description

fatal_num

Integer

Number of critical alarms.

high_risk_num

Integer

Number of high-risk alarms.

low_risk_num

Integer

Number of low-risk alarms.

middle_risk_num

Integer

Number of medium-risk alarms.

notice_num

Integer

Number of warnings.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 404

Table 7 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