Creating an Alert Rule
Function
Create alert rule
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Project ID. |
workspace_id |
Yes |
String |
Workspace ID. Workspace ID. |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pipe_id |
Yes |
String |
Pipeline ID.Pipe ID. |
rule_name |
Yes |
String |
Alert rule name. Alert rule name. |
description |
No |
String |
Link description.Description. |
query |
Yes |
String |
Query statement. Query. |
query_type |
No |
String |
SQL query syntax. Query type. SQL. |
status |
No |
String |
Status. The options are as follows - Enabled - Disabled |
severity |
No |
String |
Severity. The options are as follows - Tips - Low - Medium - High - FATAL. |
custom_properties |
No |
Map<String,String> |
Custom extension information. Custom properties. |
alert_type |
No |
Map<String,String> |
Alert type. Alert type. |
event_grouping |
No |
Boolean |
Alert group. Alert group. |
suspression |
No |
Boolean |
Alert containment. Suppression. |
simulation |
No |
Boolean |
Simulated alerts. Simulation. |
schedule |
Yes |
Schedule object |
|
triggers |
Yes |
Array of AlertRuleTrigger objects |
Alert triggering rules. Alert triggers. |
pipe_name |
Yes |
String |
pipe name |
alert_name |
Yes |
String |
alert name |
alert_description |
No |
String |
alert description |
alert_remediation |
No |
String |
alert remediation |
accumulated_times |
No |
Integer |
accumulated times |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
frequency_interval |
Yes |
Integer |
Scheduling interval. Frequency interval. |
frequency_unit |
Yes |
String |
The unit of the scheduling interval. The value can be minute, hour, or day. Frequency unit. MINUTE, HOUR, DAY. |
period_interval |
Yes |
Integer |
Time window interval. Period interval. |
period_unit |
Yes |
String |
Time Window unit. The value can be minute, hour, or day. Period unit. MINUTE, HOUR, DAY. |
delay_interval |
No |
Integer |
The delay interval. Delay interval |
overtime_interval |
No |
Integer |
Timeout interval. Overtime interval |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
mode |
No |
String |
Number of modes. Mode. COUNT. |
operator |
No |
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. |
expression |
Yes |
String |
expression |
severity |
No |
String |
Severity. The options are as follows - Tips - Low - Medium - High - FATAL. |
accumulated_times |
No |
Integer |
accumulated_times |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
rule_id |
String |
Alert rule ID. |
pipe_id |
String |
Pipeline ID.Pipe ID. |
pipe_name |
String |
Data pipeline name.Pipe name. |
create_by |
String |
Created by. Created by. |
create_time |
Long |
Creation time. Create time. |
update_by |
String |
Updated by. Update by. |
update_time |
Long |
Update time. Update time. |
delete_time |
Long |
The deletion time. Delete time. |
rule_name |
String |
Alert rule name. |
query |
String |
Query. |
query_type |
String |
SQL query syntax. Query type. SQL. |
status |
String |
Status. The options are as follows - Enabled - Disabled |
severity |
String |
Severity. The options are as follows - Tips - Low - Medium - High - FATAL. |
custom_properties |
Map<String,String> |
Custom extension information. Custom properties. |
event_grouping |
Boolean |
Alert group. Alert group. |
schedule |
Schedule object |
Schedule Rule. |
triggers |
Array of AlertRuleTrigger objects |
Alert triggering rules. Alert triggers. |
Parameter |
Type |
Description |
---|---|---|
frequency_interval |
Integer |
Scheduling interval. Frequency interval. |
frequency_unit |
String |
The unit of the scheduling interval. The value can be minute, hour, or day. Frequency unit. MINUTE, HOUR, DAY. |
period_interval |
Integer |
Time window interval. Period interval. |
period_unit |
String |
Time Window unit. The value can be minute, hour, or day. Period unit. MINUTE, HOUR, DAY. |
delay_interval |
Integer |
The delay interval. Delay interval |
overtime_interval |
Integer |
Timeout interval. Overtime interval |
Parameter |
Type |
Description |
---|---|---|
mode |
String |
Number of modes. Mode. 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. |
expression |
String |
expression |
severity |
String |
Severity. The options are as follows - Tips - Low - Medium - High - FATAL. |
accumulated_times |
Integer |
accumulated_times |
Status code: 400
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
Create an alarm rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.D331
{ "pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889", "pipe_name" : "sec-hss-alarm", "rule_name" : "Alert rule", "description" : "An alert rule", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "status" : "ENABLED", "severity" : "TIPS", "alert_name" : "test", "custom_properties" : { "references" : "https://localhost/references", "maintainer" : "isap" }, "event_grouping" : false, "suspression" : false, "simulation" : false, "accumulated_times" : 1, "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", "accumulated_times" : 1 } ] }
Example Responses
Status code: 200
Success
{ "rule_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950", "pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889", "create_by" : "582dd19dd99d4505a1d7929dc943b169", "create_time" : 1665221214, "update_by" : "582dd19dd99d4505a1d7929dc943b169", "update_time" : 1665221214, "delete_time" : 0, "rule_name" : "Alert rule", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "status" : "ENABLED", "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.
Create an alarm rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.D331
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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
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; import java.util.Map; import java.util.HashMap; public class CreateAlertRuleSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); CreateAlertRuleRequest request = new CreateAlertRuleRequest(); request.withWorkspaceId("{workspace_id}"); CreateAlertRuleRequestBody body = new CreateAlertRuleRequestBody(); List<AlertRuleTrigger> listbodyTriggers = new ArrayList<>(); listbodyTriggers.add( new AlertRuleTrigger() .withMode(AlertRuleTrigger.ModeEnum.fromValue("COUNT")) .withOperator(AlertRuleTrigger.OperatorEnum.fromValue("GT")) .withExpression("10") .withSeverity(AlertRuleTrigger.SeverityEnum.fromValue("TIPS")) .withAccumulatedTimes(1) ); Schedule schedulebody = new Schedule(); schedulebody.withFrequencyInterval(5) .withFrequencyUnit(Schedule.FrequencyUnitEnum.fromValue("MINUTE")) .withPeriodInterval(5) .withPeriodUnit(Schedule.PeriodUnitEnum.fromValue("MINUTE")) .withDelayInterval(2) .withOvertimeInterval(10); Map<String, String> listbodyCustomProperties = new HashMap<>(); listbodyCustomProperties.put("references", "https://localhost/references"); listbodyCustomProperties.put("maintainer", "isap"); body.withAccumulatedTimes(1); body.withAlertName("test"); body.withPipeName("sec-hss-alarm"); body.withTriggers(listbodyTriggers); body.withSchedule(schedulebody); body.withSimulation(false); body.withSuspression(false); body.withEventGrouping(false); body.withCustomProperties(listbodyCustomProperties); body.withSeverity(CreateAlertRuleRequestBody.SeverityEnum.fromValue("TIPS")); body.withStatus(CreateAlertRuleRequestBody.StatusEnum.fromValue("ENABLED")); body.withQueryType(CreateAlertRuleRequestBody.QueryTypeEnum.fromValue("SQL")); body.withQuery("* | select status, count(*) as count group by status"); body.withDescription("An alert rule"); body.withRuleName("Alert rule"); body.withPipeId("772fb35b-83bc-46c9-a0b1-ebe31070a889"); request.withBody(body); try { CreateAlertRuleResponse response = client.createAlertRule(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()); } } } |
Create an alarm rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.D331
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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAlertRuleRequest() request.workspace_id = "{workspace_id}" listTriggersbody = [ AlertRuleTrigger( mode="COUNT", operator="GT", expression="10", severity="TIPS", accumulated_times=1 ) ] schedulebody = Schedule( frequency_interval=5, frequency_unit="MINUTE", period_interval=5, period_unit="MINUTE", delay_interval=2, overtime_interval=10 ) listCustomPropertiesbody = { "references": "https://localhost/references", "maintainer": "isap" } request.body = CreateAlertRuleRequestBody( accumulated_times=1, alert_name="test", pipe_name="sec-hss-alarm", triggers=listTriggersbody, schedule=schedulebody, simulation=False, suspression=False, event_grouping=False, custom_properties=listCustomPropertiesbody, severity="TIPS", status="ENABLED", query_type="SQL", query="* | select status, count(*) as count group by status", description="An alert rule", rule_name="Alert rule", pipe_id="772fb35b-83bc-46c9-a0b1-ebe31070a889" ) response = client.create_alert_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create an alarm rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.D331
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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateAlertRuleRequest{} request.WorkspaceId = "{workspace_id}" modeTriggers:= model.GetAlertRuleTriggerModeEnum().COUNT operatorTriggers:= model.GetAlertRuleTriggerOperatorEnum().GT severityTriggers:= model.GetAlertRuleTriggerSeverityEnum().TIPS accumulatedTimesTriggers:= int32(1) var listTriggersbody = []model.AlertRuleTrigger{ { Mode: &modeTriggers, Operator: &operatorTriggers, Expression: "10", Severity: &severityTriggers, AccumulatedTimes: &accumulatedTimesTriggers, }, } delayIntervalSchedule:= int32(2) overtimeIntervalSchedule:= int32(10) schedulebody := &model.Schedule{ FrequencyInterval: int32(5), FrequencyUnit: model.GetScheduleFrequencyUnitEnum().MINUTE, PeriodInterval: int32(5), PeriodUnit: model.GetSchedulePeriodUnitEnum().MINUTE, DelayInterval: &delayIntervalSchedule, OvertimeInterval: &overtimeIntervalSchedule, } var listCustomPropertiesbody = map[string]string{ "references": "https://localhost/references", "maintainer": "isap", } accumulatedTimesCreateAlertRuleRequestBody:= int32(1) simulationCreateAlertRuleRequestBody:= false suspressionCreateAlertRuleRequestBody:= false eventGroupingCreateAlertRuleRequestBody:= false severityCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodySeverityEnum().TIPS statusCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodyStatusEnum().ENABLED queryTypeCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodyQueryTypeEnum().SQL descriptionCreateAlertRuleRequestBody:= "An alert rule" request.Body = &model.CreateAlertRuleRequestBody{ AccumulatedTimes: &accumulatedTimesCreateAlertRuleRequestBody, AlertName: "test", PipeName: "sec-hss-alarm", Triggers: listTriggersbody, Schedule: schedulebody, Simulation: &simulationCreateAlertRuleRequestBody, Suspression: &suspressionCreateAlertRuleRequestBody, EventGrouping: &eventGroupingCreateAlertRuleRequestBody, CustomProperties: listCustomPropertiesbody, Severity: &severityCreateAlertRuleRequestBody, Status: &statusCreateAlertRuleRequestBody, QueryType: &queryTypeCreateAlertRuleRequestBody, Query: "* | select status, count(*) as count group by status", Description: &descriptionCreateAlertRuleRequestBody, RuleName: "Alert rule", PipeId: "772fb35b-83bc-46c9-a0b1-ebe31070a889", } response, err := client.CreateAlertRule(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot