Updated on 2024-10-11 GMT+08:00

Querying alert config

Function

Querying alert config

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

poject id

Minimum: 32

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Minimum: 32

Maximum: 2097152

Content-Type

Yes

String

Content-Type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topic_urn

String

ID of an alarm group

display_name

String

display name of alert config

warn_config

warn_config object

warn config

Table 4 warn_config

Parameter

Type

Description

antiDDoS

Boolean

DDoS attacks

back_doors

Boolean

Webshells

bruce_force

Boolean

Brute force cracking (system logins, FTP, and DB)

high_privilege

Boolean

Overly high rights of a database process

remote_login

Boolean

Alarms about remote logins

send_frequency

Integer

Possible values:0: indicates that alarms are sent once a day.1: indicates that alarms are sent once every half hour.This parameter is mandatory for the Host Intrusion Detection (HID) service.

waf

Boolean

Reserved

weak_password

Boolean

Weak passwords (system and database)

Example Requests

None

Example Responses

Status code: 200

OK

{
  "warn_config" : {
    "antiDDoS" : false,
    "bruce_force" : 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

OK

Error Codes

See Error Codes.