启用告警规则
功能介绍
Enable alert rule
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/enable
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目 ID。Project ID. |
workspace_id |
是 |
String |
工作空间 ID。Workspace ID. |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api. |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of strings |
EnableAlertRuleRequestBody |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
fail_list |
Array of AlertRule objects |
Alert rule ID. |
success_list |
Array of AlertRule objects |
Alert rule ID. |
参数 |
参数类型 |
描述 |
---|---|---|
rule_id |
String |
告警规则 ID。Alert rule ID. |
pipe_id |
String |
数据管道 ID。Pipe ID. |
pipe_name |
String |
数据管道名称。Pipe name. |
create_by |
String |
创建人。Create by. |
create_time |
Long |
创建时间。Create time. |
update_by |
String |
更新人。Update by. |
update_time |
Long |
更新时间。Update time. |
delete_time |
Long |
删除时间。Delete time. |
rule_name |
String |
告警规则名称。Alert rule name. |
query |
String |
查询语句。Query. |
query_type |
String |
查询语法,SQL。Query type. SQL. |
status |
String |
启用状态,启用、停用。Status, enabled, disabled. |
severity |
String |
严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL |
custom_properties |
Map<String,String> |
自定义扩展信息。Custom properties. |
event_grouping |
Boolean |
告警分组。Event grouping. |
schedule |
Schedule object |
调度规则。Schedule Rule. |
triggers |
Array of AlertRuleTrigger objects |
告警触发规则。Alert triggers. |
参数 |
参数类型 |
描述 |
---|---|---|
frequency_interval |
Integer |
调度间隔。Frequency interval. |
frequency_unit |
String |
调度间隔单位,分钟、小时、天。Frequency unit. MINUTE, HOUR, DAY. |
period_interval |
Integer |
时间窗口间隔。Period interval. |
period_unit |
String |
时间窗口单位,分钟、小时、天。Period unit. MINUTE, HOUR, DAY. |
delay_interval |
Integer |
延迟间隔。Delay interval |
overtime_interval |
Integer |
超时间隔。Overtime interval |
参数 |
参数类型 |
描述 |
---|---|---|
mode |
String |
模式,数量。Mode. COUNT. |
operator |
String |
操作符,等于、不等于、大于、小于。 operator. EQ equal, NE not equal, GT greater than, LT less than. |
expression |
String |
expression |
severity |
String |
严重程度,提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL |
accumulated_times |
Integer |
accumulated_times |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
请求示例
启用告警规则,名称为123123
[ "123123" ]
响应示例
状态码: 200
请求成功
{ "fail_list" : [ ], "success_list" : [ ] }
SDK代码示例
SDK代码示例如下。
Java
启用告警规则,名称为123123
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 |
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 EnableAlertRuleSolution { 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(); EnableAlertRuleRequest request = new EnableAlertRuleRequest(); request.withWorkspaceId("{workspace_id}"); List<String> listbodyBody = new ArrayList<>(); listbodyBody.add("123123"); request.withBody(listbodyBody); try { EnableAlertRuleResponse response = client.enableAlertRule(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()); } } } |
Python
启用告警规则,名称为123123
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 |
# 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 = EnableAlertRuleRequest() request.workspace_id = "{workspace_id}" listBodybody = [ "123123" ] request.body = listBodybody response = client.enable_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) |
Go
启用告警规则,名称为123123
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 |
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.EnableAlertRuleRequest{} request.WorkspaceId = "{workspace_id}" var listBodybody = []string{ "123123", } request.Body = &listBodybody response, err := client.EnableAlertRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
错误码
请参见错误码。