Help Center/ Web Application Firewall/ API Reference/ APIs/ Alarm Management/ This API is used to query configuration of alarm notifications.

Updated on 2024-04-25 GMT+08:00

View PDF

This API is used to query configuration of alarm notifications.

Function

Querying Alarm Notification Configuration

URI

GET /v2/{project_id}/waf/alerts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of configured alarm notifications
items	Array of AlertNoticeConfigResponse objects	Configured alarm notifications

**Table 5** AlertNoticeConfigResponse
Parameter	Type	Description
id	String	ID
name	String	Alarm notification name
enabled	Boolean	Whether to enable false: It is disabled for WAF. true: It is enabled.
topic_urn	String	Theme
sendfreq	Integer	Interval, in minute. When the notification type is event, an alarm notification is sent when the number of attacks within the given interval is greater than or equal to the threshold. The value can be 5, 15, 30, 60, 120, 360, 720, or 1440. When the notification type is certificate expiration, an alarm notification is sent once within the give interval. The supported values are 1440 and 10080 (unit: minute).
locale	String	Language
times	Integer	This parameter is mandatory when notification type is set to Event. A notification alarm is sent when the number of attacks reaches the configured threshold. Default: 1
threat	Array of strings	Event type
prefer_html	Boolean	This parameter is reserved and can be ignored. Default: false
notice_class	String	Notification type
nearly_expired_time	String	Advance notification days
is_all_enterprise_project	Boolean	Whether all enterprise projects are involved. Default: true
enterprise_project_id	String	Specifies the enterprise project ID.
update_time	Long	Update time.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

The following example shows how to query the alarm notifications in a project. The project ID is specified by project_id.

GET https://{Endpoint}/v2/{project_id}/waf/alerts?enterprise_project_id=0

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "items" : [ {
    "enabled" : true,
    "enterprise_project_id" : "0",
    "id" : "753231205d474fa78655760c8dbd9e6f",
    "is_all_enterprise_project" : true,
    "locale" : "zh-cn",
    "name" : "test-demo33",
    "nearly_expired_time" : 60,
    "notice_class" : "cert_alert_notice",
    "prefer_html" : false,
    "sendfreq" : 10080,
    "threat" : [ ],
    "times" : 1,
    "topic_urn" : "urn:smn:xx-xxxxx-x:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",
    "update_time" : 1664347553944
  } ]
}