查看告警规则模板 - ShowAlertRuleTemplate
功能介绍
查看告警规则模板
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates/{template_id}
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        String  | 
      
        项目 ID。Project ID.  | 
     
| 
        workspace_id  | 
      
        是  | 
      
        String  | 
      
        工作空间 ID。Workspace ID.  | 
     
| 
        template_id  | 
      
        是  | 
      
        String  | 
      
        告警规则模板 ID。Alert rule template ID.  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        用户Token,通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api.  | 
     
响应参数
状态码:200
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        X-request-id  | 
      
        String  | 
      
        This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        template_id  | 
      
        String  | 
      
        告警规则模板 ID。Alert rule template ID.  | 
     
| 
        update_time  | 
      
        Long  | 
      
        更新时间。Update time.  | 
     
| 
        template_name  | 
      
        String  | 
      
        告警规则模板名称。Alert rule template name.  | 
     
| 
        data_source  | 
      
        String  | 
      
        数据源。Data source.  | 
     
| 
        version  | 
      
        String  | 
      
        版本。Version  | 
     
| 
        query  | 
      
        String  | 
      
        查询语句。Query.  | 
     
| 
        query_type  | 
      
        String  | 
      
        参数解释: 查询语法类型 
 约束限制: 不涉及 取值范围: 默认值: SQL  | 
     
| 
        severity  | 
      
        String  | 
      
        参数解释: 告警等级 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        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  | 
      
        参数解释: 调度间隔单位 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        period_interval  | 
      
        Integer  | 
      
        时间窗口间隔。Period interval.  | 
     
| 
        period_unit  | 
      
        String  | 
      
        参数解释: 时间窗口单位 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        delay_interval  | 
      
        Integer  | 
      
        延迟间隔。Delay interval  | 
     
| 
        overtime_interval  | 
      
        Integer  | 
      
        超时间隔。Overtime interval  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        mode  | 
      
        String  | 
      
        参数解释: 指标模式 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        operator  | 
      
        String  | 
      
        参数解释: 操作符类型 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        expression  | 
      
        String  | 
      
        expression  | 
     
| 
        severity  | 
      
        String  | 
      
        参数解释: 告警等级 
 约束限制 不涉及 取值范围: 
 默认值 不涉及  | 
     
| 
        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.  | 
     
请求示例
无
响应示例
状态码:200
请求成功
{
  "template_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950",
  "update_time" : 1665221214,
  "template_name" : "Alert rule template",
  "data_source" : "sec_hss_vul",
  "version" : "1.0.0",
  "query" : "* | select status, count(*) as count group by status",
  "query_type" : "SQL",
  "severity" : "TIPS",
  "custom_properties" : {
    "references" : "https://localhost/references",
    "maintainer" : "isap"
  },
  "event_grouping" : true,
  "schedule" : {
    "frequency_interval" : 5,
    "frequency_unit" : "MINUTE",
    "period_interval" : 5,
    "period_unit" : "MINUTE",
    "delay_interval" : 2,
    "overtime_interval" : 10
  },
  "triggers" : [ {
    "mode" : "COUNT",
    "operator" : "GT",
    "expression" : 10,
    "severity" : "TIPS"
  } ]
}
 SDK代码示例
SDK代码示例如下。
Java
        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  | 
       
        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 ShowAlertRuleTemplateSolution { 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(); ShowAlertRuleTemplateRequest request = new ShowAlertRuleTemplateRequest(); request.withWorkspaceId("{workspace_id}"); request.withTemplateId("{template_id}"); try { ShowAlertRuleTemplateResponse response = client.showAlertRuleTemplate(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
        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  | 
       
        # 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 = ShowAlertRuleTemplateRequest() request.workspace_id = "{workspace_id}" request.template_id = "{template_id}" response = client.show_alert_rule_template(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
        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  | 
       
        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.ShowAlertRuleTemplateRequest{} request.WorkspaceId = "{workspace_id}" request.TemplateId = "{template_id}" response, err := client.ShowAlertRuleTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }  | 
      
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 
        状态码  | 
      
        描述  | 
     
|---|---|
| 
        200  | 
      
        请求成功  | 
     
| 
        400  | 
      
        请求失败  | 
     
错误码
请参见错误码。