Simulating an Alert Rule
Function
Simulate alert rule
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/simulation
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 |
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. Minimum: 1 Maximum: 2097152 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pipe_id |
Yes |
String |
Pipeline ID.Pipe ID. Minimum: 36 Maximum: 36 |
query |
Yes |
String |
Query. Minimum: 1 Maximum: 1024 |
query_type |
No |
String |
SQL query syntax. Query type. SQL. Default: SQL Minimum: 1 Maximum: 255 Enumeration values:
|
from |
Yes |
Long |
Start time.Start time. Minimum: 0 Maximum: 9223372036854775807 |
to |
Yes |
Long |
End time.End time. Minimum: 0 Maximum: 9223372036854775807 |
event_grouping |
No |
Boolean |
Alert group. Incident group. Default: true |
triggers |
Yes |
Array of AlertRuleTrigger objects |
Alert triggering rules. Alert triggers. Array Length: 1 - 5 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
mode |
No |
String |
Number of modes. Mode. COUNT. Default: COUNT Minimum: 1 Maximum: 255 Enumeration values:
|
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. Default: GT Minimum: 1 Maximum: 255 Enumeration values:
|
expression |
Yes |
String |
expression Minimum: 1 Maximum: 255 |
severity |
No |
String |
Severity. The options are as follows - Tips - Low - Medium - High - Critical Severity. Minimum: 1 Maximum: 255 Enumeration values:
|
accumulated_times |
No |
Integer |
accumulated_times Minimum: 1 Maximum: 1000 Default: 1 |
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 |
---|---|---|
alert_count |
Integer |
Number of alarms. Alert count. Minimum: 0 Maximum: 100 |
severity |
String |
Severity. The options are as follows - Tips - Low - Medium - High - Critical Severity. Minimum: 1 Maximum: 64 |
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
Simulate an alarm rule. The ID of the pipe to which the alarm rule belongs is ead2769b-afb0-45dd-b9fa-a2953e6ac82f, the query type is SQL, and the severity is Warning.
{ "pipe_id" : "ead2769b-afb0-45dd-b9fa-a2953e6ac82f", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "event_grouping" : true, "from" : 1665221214000, "to" : 1665546370000, "triggers" : [ { "mode" : "COUNT", "operator" : "GT", "expression" : 10, "severity" : "TIPS" } ] }
Example Responses
Status code: 200
Success
{ "alert_count" : 100, "severity" : "TIPS" }
SDK Sample Code
The SDK sample code is as follows.
Simulate an alarm rule. The ID of the pipe to which the alarm rule belongs is ead2769b-afb0-45dd-b9fa-a2953e6ac82f, the query type is SQL, and the severity is Warning.
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 |
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 CreateAlertRuleSimulationSolution { 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(); CreateAlertRuleSimulationRequest request = new CreateAlertRuleSimulationRequest(); CreateAlertRuleSimulationRequestBody body = new CreateAlertRuleSimulationRequestBody(); 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")) ); body.withTriggers(listbodyTriggers); body.withEventGrouping(true); body.withTo(1665546370000L); body.withFrom(1665221214000L); body.withQueryType(CreateAlertRuleSimulationRequestBody.QueryTypeEnum.fromValue("SQL")); body.withQuery("* | select status, count(*) as count group by status"); body.withPipeId("ead2769b-afb0-45dd-b9fa-a2953e6ac82f"); request.withBody(body); try { CreateAlertRuleSimulationResponse response = client.createAlertRuleSimulation(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()); } } } |
Simulate an alarm rule. The ID of the pipe to which the alarm rule belongs is ead2769b-afb0-45dd-b9fa-a2953e6ac82f, the query type is SQL, and the severity is Warning.
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 |
# 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 = CreateAlertRuleSimulationRequest() listTriggersbody = [ AlertRuleTrigger( mode="COUNT", operator="GT", expression="10", severity="TIPS" ) ] request.body = CreateAlertRuleSimulationRequestBody( triggers=listTriggersbody, event_grouping=True, to=1665546370000, _from=1665221214000, query_type="SQL", query="* | select status, count(*) as count group by status", pipe_id="ead2769b-afb0-45dd-b9fa-a2953e6ac82f" ) response = client.create_alert_rule_simulation(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Simulate an alarm rule. The ID of the pipe to which the alarm rule belongs is ead2769b-afb0-45dd-b9fa-a2953e6ac82f, the query type is SQL, and the severity is Warning.
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 |
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.CreateAlertRuleSimulationRequest{} modeTriggers:= model.GetAlertRuleTriggerModeEnum().COUNT operatorTriggers:= model.GetAlertRuleTriggerOperatorEnum().GT severityTriggers:= model.GetAlertRuleTriggerSeverityEnum().TIPS var listTriggersbody = []model.AlertRuleTrigger{ { Mode: &modeTriggers, Operator: &operatorTriggers, Expression: "10", Severity: &severityTriggers, }, } eventGroupingCreateAlertRuleSimulationRequestBody:= true queryTypeCreateAlertRuleSimulationRequestBody:= model.GetCreateAlertRuleSimulationRequestBodyQueryTypeEnum().SQL request.Body = &model.CreateAlertRuleSimulationRequestBody{ Triggers: listTriggersbody, EventGrouping: &eventGroupingCreateAlertRuleSimulationRequestBody, To: int64(1665546370000), From: int64(1665221214000), QueryType: &queryTypeCreateAlertRuleSimulationRequestBody, Query: "* | select status, count(*) as count group by status", PipeId: "ead2769b-afb0-45dd-b9fa-a2953e6ac82f", } response, err := client.CreateAlertRuleSimulation(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