# 列出告警规则模板 - ListAlertRuleTemplates #### 功能介绍 列出告警规则模板 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | workspace_id | 是 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | template_name | 否 | String | 模板名称 | | status | 否 | String | **参数解释**： 状态 - ENABLED 启用 - DISABLED 禁用 **约束限制**： 不涉及 **取值范围**： - ENABLED - DISABLED **默认取值**： 不涉及 | | severity | 否 | String | **参数解释**： 告警等级 - TIPS 提示 - LOW 低危 - MEDIUM 中危 - HIGH 高危 - FATAL 致命 **约束限制**： 不涉及 **取值范围**： - TIPS - LOW - MEDIUM - HIGH - FATAL **默认取值**： 不涉及 | | offset | 否 | Long | **参数解释**： 偏移量 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | limit | 否 | Long | **参数解释**： 查询数据限制 **取值范围**： 0-1000 **默认取值**： 不涉及 | | sort_key | 否 | String | 按照属性排序。 | | sort_dir | 否 | String | 排序顺序，支持 *ASC* 或 *DESC*。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 计数 | | records | Array of [AlertRuleTemplate] objects | 记录 | 表5AlertRuleTemplate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | accumulated_times | Integer | 累计次数 | | alert_description | String | 告警描述 | | alert_name | String | 告警名称 | | alert_remediation | String | 告警修复 | | alert_type | Map\ | Map\ | | create_by | String | Iam用户ID | | create_time | Integer | 毫秒时间戳 | | custom_properties | Map\ | Map\ | | description | String | 告警规则模板描述 | | event_grouping | Boolean | 告警组 | | job_mode | String | **参数解释**： 作业模式 - STREAMING 流式处理 - BATCH 批处理 - SEARCH 检索 **约束限制**： 不涉及 **取值范围**： - STREAMING - BATCH - SEARCH **默认取值**： 不涉及 | | process_status | String | **参数解释**： 处理状态 - COMPLETED 已完成 - CREATING 创建中 - UPDATING 更新中 - ENABLING 启用中 - DISABLING 停用中 - DELETING 删除中 - CREATE_FAILED 创建失败 - UPDATE_FAILED 更新失败 - ENABLE_FAILED 启用失败 - DISABLE_FAILED 停用失败 - DELETE_FAILED 删除失败 - RECOVERING 恢复中 **约束限制**： 不涉及 **取值范围**： - COMPLETED - CREATING - UPDATING - ENABLING - DISABLING - DELETING - CREATE_FAILED - UPDATE_FAILED - ENABLE_FAILED - DISABLE_FAILED - DELETE_FAILED - RECOVERING **默认取值**： 不涉及 | | query | String | 查询语句 | | query_type | String | **参数解释**： 查询类型 - SQL SQL查询 - CBSL CBSL查询 **约束限制**： 不涉及 **取值范围**： - SQL - CBSL **默认取值**： 不涉及 | | schedule | [AlertRuleSchedule] object | 告警规则时间表 | | severity | String | **参数解释**： 告警等级 - TIPS 提示 - LOW 低危 - MEDIUM 中危 - HIGH 高危 - FATAL 致命 **约束限制**： 不涉及 **取值范围**： - TIPS - LOW - MEDIUM - HIGH - FATAL **默认取值**： 不涉及 | | simulation | Boolean | 是否仿真 | | status | String | **参数解释**： 状态 - ENABLED 启用 - DISABLED 禁用 **约束限制**： 不涉及 **取值范围**： - ENABLED - DISABLED **默认取值**： 不涉及 | | suppresion | Boolean | 告警抑制 | | table_name | String | 表名称 | | template_id | String | UUID | | template_name | String | 模板名称 | | triggers | Array of [Trigger] objects | 触发器数组 | | update_by | String | Iam用户ID | | update_time | Integer | 毫秒时间戳 | | update_time_by_user | Integer | 毫秒时间戳 | 表6AlertRuleSchedule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | delay_interval | Integer | 整型时长 | | frequency_interval | Integer | 整型时长 | | frequency_unit | String | **参数解释**： 频率单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY **默认取值**： 不涉及 | | overtime_interval | Integer | 整型时长 | | period_interval | Integer | 整型时长 | | period_unit | String | **参数解释**： 频率单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY **默认取值**： 不涉及 | 表7Trigger | 参数 | 参数类型 | 描述 | |:---|:---|:---| | accumulated_times | Integer | 累计次数 | | expression | String | 表达式 | | job_id | String | UUID | | mode | String | **参数解释**： 模式 - COUNT 计数 **约束限制**： 不涉及 **取值范围**： - COUNT **默认取值**： 不涉及 | | operator | String | **参数解释**： 操作符类型 - GT 大于 - LT 小于 - EQ 等于 - NE 不等于 **约束限制**： 不涉及 **取值范围**： - GT - LT - EQ - NE **默认取值**： 不涉及 | | severity | String | **参数解释**： 告警等级 - TIPS 提示 - LOW 低危 - MEDIUM 中危 - HIGH 高危 - FATAL 致命 **约束限制**： 不涉及 **取值范围**： - TIPS - LOW - MEDIUM - HIGH - FATAL **默认取值**： 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功 ``` { "count" : 1, "records" : [ { "accumulated_times" : 1, "alert_description" : "all_count", "alert_name" : "all_count", "alert_remediation" : "all_count", "create_by" : "b40b54b1f27a4224aa0c95ede5b5a46a", "create_time" : 1676447085981, "description" : "all_count", "event_grouping" : false, "job_mode" : "SEARCH", "process_status" : "COMPLETED", "query" : "not response_code='200' | select *, count(distinct remote_ip.keyword) as ip_count,count(distinct url) as url_count,count(*) as all_count group by http_host having (ip_count > 100 and (url_count >1000 or all_count > 100000))", "query_type" : "SQL", "severity" : "MEDIUM", "simulation" : false, "status" : "ENABLED", "table_name" : "sec-waf-access", "template_id" : "83444427-b923-4fff-9022-f380a576bd20", "template_name" : "all_count", "update_by" : "b40b54b1f27a4224aa0c95ede5b5a46a", "update_time" : 1676447086162 } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.*; public class ListAlertRuleTemplatesSolution { 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("")) .build(); ListAlertRuleTemplatesRequest request = new ListAlertRuleTemplatesRequest(); request.withWorkspaceId("{workspace_id}"); try { ListAlertRuleTemplatesResponse response = client.listAlertRuleTemplates(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] ``` # 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("")) \ .build() try: request = ListAlertRuleTemplatesRequest() request.workspace_id = "{workspace_id}" response = client.list_alert_rule_templates(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] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListAlertRuleTemplatesRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListAlertRuleTemplates(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListAlertRuleTemplates&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。