Creating an Alert Rule
Function
This API is used to create an 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. |
|
workspace_id |
Yes |
String |
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
accumulated_times |
No |
Integer |
Executions. |
|
alert_description |
No |
String |
Alert description. |
|
alert_name |
Yes |
String |
Alert name. |
|
alert_remediation |
No |
String |
Handling suggestions. |
|
alert_type |
No |
Map<String,String> |
Alert type, which is obtained through the API for querying the data class list. |
|
custom_properties |
No |
Map<String,String> |
Custom extension information. |
|
description |
No |
String |
Description. |
|
event_grouping |
No |
Boolean |
Alert group. |
|
pipe_id |
Yes |
String |
Data pipeline ID. |
|
pipe_name |
Yes |
String |
Pipeline name. |
|
query |
Yes |
String |
Query statement. |
|
query_type |
No |
String |
Definition Query syntax type. Constraints N/A Range Default Value SQL |
|
rule_name |
Yes |
String |
Alert rule name. |
|
schedule |
Yes |
Schedule object |
Schedule of an alert rule. |
|
severity |
No |
String |
Definition Alert severity. Constraints N/A Range Default Value N/A |
|
simulation |
No |
Boolean |
Simulated alerts. |
|
status |
No |
String |
Definition Status. Constraints N/A Range Default Value N/A |
|
suppression |
No |
Boolean |
Alert suppression. |
|
triggers |
Yes |
Array of AlertRuleTrigger objects |
Alert triggering rules. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
delay_interval |
No |
Integer |
Delay interval. |
|
frequency_interval |
Yes |
Integer |
Scheduling interval. |
|
frequency_unit |
Yes |
String |
Definition Scheduling interval unit. Constraints N/A Range Default Value N/A |
|
overtime_interval |
No |
Integer |
Timeout Interval. |
|
period_interval |
Yes |
Integer |
Time window interval. |
|
period_unit |
Yes |
String |
Definition Time window unit. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
accumulated_times |
No |
Integer |
Accumulated times. |
|
expression |
Yes |
String |
Expression. |
|
mode |
No |
String |
Definition Metric mode. Constraints N/A Range Default Value N/A |
|
operator |
No |
String |
Definition Operator type. Constraints N/A Range Default Value N/A |
|
severity |
No |
String |
Definition Alert severity. Constraints N/A Range Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Task trace request ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_by |
String |
Creator. |
|
create_time |
Long |
Creation time. |
|
custom_properties |
Map<String,String> |
Custom extension information. |
|
delete_time |
Long |
Deletion time. |
|
event_grouping |
Boolean |
Alert group. |
|
pipe_id |
String |
Data pipeline ID. |
|
pipe_name |
String |
Data pipeline name. |
|
query |
String |
Query statement. |
|
query_type |
String |
Definition Query syntax type. Constraints N/A Range Default Value SQL |
|
rule_id |
String |
Alert rule ID. |
|
rule_name |
String |
Alert rule name. |
|
schedule |
Schedule object |
Scheduling rule. |
|
severity |
String |
Definition Status. Constraints N/A Range Default Value |
|
status |
String |
Definition Status. Constraints N/A Range Default Value N/A |
|
triggers |
Array of AlertRuleTrigger objects |
Alert triggering rules. |
|
update_by |
String |
Updater. |
|
update_time |
Long |
Update time. |
|
Parameter |
Type |
Description |
|---|---|---|
|
delay_interval |
Integer |
Delay interval. |
|
frequency_interval |
Integer |
Scheduling interval. |
|
frequency_unit |
String |
Definition Scheduling interval unit. Constraints N/A Range Default Value N/A |
|
overtime_interval |
Integer |
Timeout Interval. |
|
period_interval |
Integer |
Time window interval. |
|
period_unit |
String |
Definition Time window unit. Constraints N/A Range Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
accumulated_times |
Integer |
Accumulated times. |
|
expression |
String |
Expression. |
|
mode |
String |
Definition Metric mode. Constraints N/A Range Default Value N/A |
|
operator |
String |
Definition Operator type. Constraints N/A Range Default Value N/A |
|
severity |
String |
Definition Alert severity. Constraints N/A Range Default Value N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Task trace request ID. |
Example Requests
Create an alert rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.
{
"accumulated_times" : 1,
"alert_name" : "test",
"custom_properties" : {
"maintainer" : "isap",
"references" : "https://localhost/references"
},
"description" : "An alert rule",
"event_grouping" : false,
"pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889",
"pipe_name" : "sec-hss-alarm",
"query" : "* | select status, count(*) as count group by status",
"query_type" : "SQL",
"rule_name" : "Alert rule",
"schedule" : {
"delay_interval" : 2,
"frequency_interval" : 5,
"frequency_unit" : "MINUTE",
"overtime_interval" : 10,
"period_interval" : 5,
"period_unit" : "MINUTE"
},
"severity" : "TIPS",
"simulation" : false,
"status" : "ENABLED",
"suppression" : false,
"triggers" : [ {
"accumulated_times" : 1,
"expression" : 10,
"mode" : "COUNT",
"operator" : "GT",
"severity" : "TIPS"
} ]
}
Example Responses
Status code: 200
Request succeeded.
{
"create_by" : "582dd19dd99d4505a1d7929dc943b169",
"create_time" : 1665221214,
"custom_properties" : {
"maintainer" : "isap",
"references" : "https://localhost/references"
},
"delete_time" : 0,
"event_grouping" : true,
"pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889",
"query" : "* | select status, count(*) as count group by status",
"query_type" : "SQL",
"rule_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950",
"rule_name" : "Alert rule",
"schedule" : {
"delay_interval" : 2,
"frequency_interval" : 5,
"frequency_unit" : "MINUTE",
"overtime_interval" : 10,
"period_interval" : 5,
"period_unit" : "MINUTE"
},
"severity" : "TIPS",
"status" : "ENABLED",
"triggers" : [ {
"expression" : 10,
"mode" : "COUNT",
"operator" : "GT",
"severity" : "TIPS"
} ],
"update_by" : "582dd19dd99d4505a1d7929dc943b169",
"update_time" : 1665221214
}
SDK Sample Code
The SDK sample code is as follows.
Create an alert rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.
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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.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() .withAccumulatedTimes(1) .withExpression("10") .withMode(AlertRuleTrigger.ModeEnum.fromValue("COUNT")) .withOperator(AlertRuleTrigger.OperatorEnum.fromValue("GT")) .withSeverity(AlertRuleTrigger.SeverityEnum.fromValue("TIPS")) ); Schedule schedulebody = new Schedule(); schedulebody.withDelayInterval(2) .withFrequencyInterval(5) .withFrequencyUnit(Schedule.FrequencyUnitEnum.fromValue("MINUTE")) .withOvertimeInterval(10) .withPeriodInterval(5) .withPeriodUnit(Schedule.PeriodUnitEnum.fromValue("MINUTE")); Map<String, String> listbodyCustomProperties = new HashMap<>(); listbodyCustomProperties.put("maintainer", "isap"); listbodyCustomProperties.put("references", "https://localhost/references"); body.withTriggers(listbodyTriggers); body.withSuppression(false); body.withStatus(CreateAlertRuleRequestBody.StatusEnum.fromValue("ENABLED")); body.withSimulation(false); body.withSeverity(CreateAlertRuleRequestBody.SeverityEnum.fromValue("TIPS")); body.withSchedule(schedulebody); body.withRuleName("Alert rule"); body.withQueryType(CreateAlertRuleRequestBody.QueryTypeEnum.fromValue("SQL")); body.withQuery("* | select status, count(*) as count group by status"); body.withPipeName("sec-hss-alarm"); body.withPipeId("772fb35b-83bc-46c9-a0b1-ebe31070a889"); body.withEventGrouping(false); body.withDescription("An alert rule"); body.withCustomProperties(listbodyCustomProperties); body.withAlertName("test"); body.withAccumulatedTimes(1); 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 alert rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.
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.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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( accumulated_times=1, expression="10", mode="COUNT", operator="GT", severity="TIPS" ) ] schedulebody = Schedule( delay_interval=2, frequency_interval=5, frequency_unit="MINUTE", overtime_interval=10, period_interval=5, period_unit="MINUTE" ) listCustomPropertiesbody = { "maintainer": "isap", "references": "https://localhost/references" } request.body = CreateAlertRuleRequestBody( triggers=listTriggersbody, suppression=False, status="ENABLED", simulation=False, severity="TIPS", schedule=schedulebody, rule_name="Alert rule", query_type="SQL", query="* | select status, count(*) as count group by status", pipe_name="sec-hss-alarm", pipe_id="772fb35b-83bc-46c9-a0b1-ebe31070a889", event_grouping=False, description="An alert rule", custom_properties=listCustomPropertiesbody, alert_name="test", accumulated_times=1 ) 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 alert rule whose ID is 772fb35b-83bc-46c9-a0b1-ebe31070a889, Name is Alert rule, Query type is SQL, and Status is Enabled.
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/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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}" accumulatedTimesTriggers:= int32(1) modeTriggers:= model.GetAlertRuleTriggerModeEnum().COUNT operatorTriggers:= model.GetAlertRuleTriggerOperatorEnum().GT severityTriggers:= model.GetAlertRuleTriggerSeverityEnum().TIPS var listTriggersbody = []model.AlertRuleTrigger{ { AccumulatedTimes: &accumulatedTimesTriggers, Expression: "10", Mode: &modeTriggers, Operator: &operatorTriggers, Severity: &severityTriggers, }, } delayIntervalSchedule:= int32(2) overtimeIntervalSchedule:= int32(10) schedulebody := &model.Schedule{ DelayInterval: &delayIntervalSchedule, FrequencyInterval: int32(5), FrequencyUnit: model.GetScheduleFrequencyUnitEnum().MINUTE, OvertimeInterval: &overtimeIntervalSchedule, PeriodInterval: int32(5), PeriodUnit: model.GetSchedulePeriodUnitEnum().MINUTE, } var listCustomPropertiesbody = map[string]string{ "maintainer": "isap", "references": "https://localhost/references", } suppressionCreateAlertRuleRequestBody:= false statusCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodyStatusEnum().ENABLED simulationCreateAlertRuleRequestBody:= false severityCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodySeverityEnum().TIPS queryTypeCreateAlertRuleRequestBody:= model.GetCreateAlertRuleRequestBodyQueryTypeEnum().SQL eventGroupingCreateAlertRuleRequestBody:= false descriptionCreateAlertRuleRequestBody:= "An alert rule" accumulatedTimesCreateAlertRuleRequestBody:= int32(1) request.Body = &model.CreateAlertRuleRequestBody{ Triggers: listTriggersbody, Suppression: &suppressionCreateAlertRuleRequestBody, Status: &statusCreateAlertRuleRequestBody, Simulation: &simulationCreateAlertRuleRequestBody, Severity: &severityCreateAlertRuleRequestBody, Schedule: schedulebody, RuleName: "Alert rule", QueryType: &queryTypeCreateAlertRuleRequestBody, Query: "* | select status, count(*) as count group by status", PipeName: "sec-hss-alarm", PipeId: "772fb35b-83bc-46c9-a0b1-ebe31070a889", EventGrouping: &eventGroupingCreateAlertRuleRequestBody, Description: &descriptionCreateAlertRuleRequestBody, CustomProperties: listCustomPropertiesbody, AlertName: "test", AccumulatedTimes: &accumulatedTimesCreateAlertRuleRequestBody, } 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 |
Request succeeded. |
|
400 |
Request failed. |
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