Help Center/ SecMaster/ API Reference/ API/ Alert Rule Management/ Listing Alert Rule Templates
Updated on 2024-07-25 GMT+08:00

Listing Alert Rule Templates

Function

List alert rule templates

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Project ID.

Minimum: 32

Maximum: 36

workspace_id

Yes

String

Workspace ID. Workspace ID.

Minimum: 32

Maximum: 36

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Long

The query offset. Offset.

Minimum: 0

Maximum: 9223372036854775807

limit

Yes

Long

Number of bucket groups Limit.

Minimum: 10

Maximum: 50

sort_key

No

String

Sorting field. Sort key

Minimum: 1

Maximum: 256

sort_dir

No

String

Sort direction, asc or desc.

Enumeration values:

  • asc
  • desc

severity

No

Array

Severity. The options are as follows - Tips - Low - Medium - High - Critical Severity.

Array Length: 1 - 5

Enumeration values:

  • TIPS
  • LOW
  • MEDIUM
  • HIGH
  • FATAL

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by calling the IAM API used to obtain a user token. Token of an IAM user. To obtain it, call the corresponding IAM API.

Minimum: 1

Maximum: 2097152

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

count

Long

Total number. Total count.

Minimum: 0

Maximum: 9223372036854775807

records

Array of AlertRuleTemplate objects

Alert rule template. Alert rule templates.

Array Length: 0 - 100

Table 6 AlertRuleTemplate

Parameter

Type

Description

template_id

String

Alert rule template ID. Alert rule template ID.

Minimum: 36

Maximum: 36

update_time

Long

Update time. Update time.

Minimum: 0

Maximum: 9223372036854775807

template_name

String

Alert rule template ID. Alert rule template ID.

Minimum: 1

Maximum: 255

data_source

String

Data source. Data source.

Minimum: 1

Maximum: 255

version

String

Version. Version

Minimum: 1

Maximum: 255

query

String

Query.

Minimum: 1

Maximum: 1024

query_type

String

SQL query syntax, SQL. Query type. SQL.

Default: SQL

Minimum: 1

Maximum: 255

Enumeration values:

  • SQL

severity

String

Severity. The options are as follows - Tips - Low - Medium - High - Critical Severity.

Default: TIPS

Minimum: 1

Maximum: 255

Enumeration values:

  • TIPS
  • LOW
  • MEDIUM
  • HIGH
  • FATAL

custom_properties

Map<String,String>

Custom extension information. Custom properties.

event_grouping

Boolean

Alert group. Alert group.

Default: true

schedule

Schedule object

  

triggers

Array of AlertRuleTrigger objects

Alert triggering rules. Alert triggers.

Array Length: 1 - 5

Table 7 Schedule

Parameter

Type

Description

frequency_interval

Integer

Scheduling interval. Frequency interval.

Minimum: 1

Maximum: 60

frequency_unit

String

The unit of the scheduling interval. The value can be minute, hour, or day. Frequency unit. MINUTE, HOUR, DAY.

Minimum: 1

Maximum: 255

Enumeration values:

  • MINUTE
  • HOUR
  • DAY

period_interval

Integer

Time window interval. Period interval.

Minimum: 1

Maximum: 60

period_unit

String

Time Window unit. The value can be minute, hour, or day. Period unit. MINUTE, HOUR, DAY.

Minimum: 1

Maximum: 255

Enumeration values:

  • MINUTE
  • HOUR
  • DAY

delay_interval

Integer

The delay interval. Delay interval

Minimum: 0

Maximum: 10

Default: 0

overtime_interval

Integer

Timeout interval. Overtime interval

Minimum: 0

Maximum: 10

Default: 10

Table 8 AlertRuleTrigger

Parameter

Type

Description

mode

String

Number of modes. Mode. COUNT.

Default: COUNT

Minimum: 1

Maximum: 255

Enumeration values:

  • COUNT

operator

String

Operator, which can be equal to, not equal to, greater than, or less than. operator. EQ equal, NE not equal, GT greater than, LT less than.

Default: GT

Minimum: 1

Maximum: 255

Enumeration values:

  • EQ
  • NE
  • GT
  • LT

expression

String

expression

Minimum: 1

Maximum: 255

severity

String

Severity. The options are as follows - Tips - Low - Medium - High - Critical Severity.

Minimum: 1

Maximum: 255

Enumeration values:

  • TIPS
  • LOW
  • MEDIUM
  • HIGH
  • FATAL

accumulated_times

Integer

accumulated_times

Minimum: 1

Maximum: 1000

Default: 1

Status code: 400

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

Example Requests

None

Example Responses

Status code: 200

Success

{
  "count" : 9223372036854776000,
  "records" : [ {
    "template_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950",
    "update_time" : 1665221214,
    "template_name" : "Alert rule template",
    "data_source" : "sec_hss_vul",
    "version" : "1.0.0",
    "query" : "* | select status, count(*) as count group by status",
    "query_type" : "SQL",
    "severity" : "TIPS",
    "custom_properties" : {
      "references" : "https://localhost/references",
      "maintainer" : "isap"
    },
    "event_grouping" : true,
    "schedule" : {
      "frequency_interval" : 5,
      "frequency_unit" : "MINUTE",
      "period_interval" : 5,
      "period_unit" : "MINUTE",
      "delay_interval" : 2,
      "overtime_interval" : 10
    },
    "triggers" : [ {
      "mode" : "COUNT",
      "operator" : "GT",
      "expression" : 10,
      "severity" : "TIPS"
    } ]
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListAlertRuleTemplatesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAlertRuleTemplatesRequest request = new ListAlertRuleTemplatesRequest();
        request.withOffset(<offset>L);
        request.withLimit(<limit>L);
        request.withSortKey("<sort_key>");
        request.withSortDir(ListAlertRuleTemplatesRequest.SortDirEnum.fromValue("<sort_dir>"));
        request.withSeverity();
        try {
            ListAlertRuleTemplatesResponse response = client.listAlertRuleTemplates(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAlertRuleTemplatesRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.severity = 
        response = client.list_alert_rule_templates(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAlertRuleTemplatesRequest{}
	request.Offset = int64(<offset>)
	request.Limit = int64(<limit>)
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListAlertRuleTemplatesRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	response, err := client.ListAlertRuleTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Success

400

Bad Request

Error Codes

See Error Codes.