模拟告警规则
功能介绍
Simulate alert rule
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/simulation
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目 ID。Project ID. 最小长度:32 最大长度:36 |
workspace_id |
是 |
String |
工作空间 ID。Workspace ID. 最小长度:32 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api. 最小长度:1 最大长度:2097152 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipe_id |
是 |
String |
数据管道 ID。Pipe ID. 最小长度:36 最大长度:36 |
query |
是 |
String |
查询语句。Query. 最小长度:1 最大长度:1024 |
query_type |
否 |
String |
查询语法,SQL。Query type. SQL. 缺省值:SQL 最小长度:1 最大长度:255 枚举值:
|
from |
是 |
Long |
开始时间。Start time. 最小值:0 最大值:9223372036854775807 |
to |
是 |
Long |
结束时间。End time. 最小值:0 最大值:9223372036854775807 |
event_grouping |
否 |
Boolean |
告警分组。Event grouping. 缺省值:true |
triggers |
是 |
Array of AlertRuleTrigger objects |
告警触发规则。Alert triggers. 数组长度:1 - 5 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
mode |
否 |
String |
模式,数量。Mode. COUNT. 缺省值:COUNT 最小长度:1 最大长度:255 枚举值:
|
operator |
否 |
String |
操作符,等于、不等于、大于、小于。 operator. EQ equal, NE not equal, GT greater than, LT less than. 缺省值:GT 最小长度:1 最大长度:255 枚举值:
|
expression |
是 |
String |
expression 最小长度:1 最大长度:255 |
severity |
否 |
String |
严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL 最小长度:1 最大长度:255 枚举值:
|
accumulated_times |
否 |
Integer |
accumulated_times 最小值:1 最大值:1000 缺省值:1 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
alert_count |
Integer |
告警数量。Alert count. 最小值:0 最大值:100 |
severity |
String |
严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL 最小长度:1 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
请求示例
模拟一条告警规则,告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f,查询类型为SQL,严重程度为提示。
{ "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" } ] }
响应示例
状态码: 200
请求成功
{ "alert_count" : 100, "severity" : "TIPS" }
SDK代码示例
SDK代码示例如下。
模拟一条告警规则,告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f,查询类型为SQL,严重程度为提示。
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()); } } } |
模拟一条告警规则,告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f,查询类型为SQL,严重程度为提示。
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) |
模拟一条告警规则,告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f,查询类型为SQL,严重程度为提示。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
错误码
请参见错误码。