Help Center/ Anti-DDoS/ API Reference/ API/ Alarm Configuration Management/ Querying Alarm Configuration
Updated on 2025-10-09 GMT+08:00
View PDF

Querying Alarm Configuration

Function

You can query alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emails.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/warnalert/alertconfig/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Content-Type request header.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topic_urn

String

Unique ID of an alarm group.

display_name

String

Alarm group description.

warn_config

warn_config object

Alarm configuration information.
Table 4 warn_config

Parameter

Type

Description

antiDDoS

Boolean

DDoS attack.

back_doors

Boolean

Web shell.

high_privilege

Boolean

Excessive privileges assigned to a database process.

remote_login

Boolean

Alarms about remote logins.

send_frequency

Integer

Range

  • 0: once a day

  • 1: once every 30 minutes

Mandatory for the HID.

waf

Boolean

Reserved field.

weak_password

Boolean

Weak password (system and database).

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "warn_config" : {
    "antiDDoS" : false,
    "remote_login" : false,
    "weak_password" : false,
    "high_privilege" : false,
    "back_doors" : false,
    "waf" : false,
    "send_frequency" : 0
  },
  "topic_urn" : null,
  "display_name" : null
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.