文档首页/ 安全云脑 SecMaster/ API参考/ API V3/ 告警规则模板管理/ 查看告警规则模板

更新时间：2025-08-30 GMT+08:00

在线调试

CLI示例

查看PDF

查看告警规则模板

功能介绍

查看告警规则模板

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates/{template_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制：不涉及取值范围：不涉及w 默认取值：不涉及
workspace_id	是	String	工作空间ID
template_id	是	String	告警规则模板Id

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
accumulated_times	Integer	累计次数
create_by	String	UUID
create_time	Integer	毫秒时间戳
cu_quota_amount	Number	Amount
description	String	告警规则模板描述
environment	String	参数解释: 环境类型 PROD 生产环境 TEST 测试环境约束限制不涉及取值范围: PROD TEST 默认值不涉及
job_mode	String	参数解释: 作业模式 STREAMING 流式处理 BATCH 批处理 SEARCH 检索约束限制不涉及取值范围: STREAMING BATCH SEARCH 默认值不涉及
job_mode_setting	IsapJobModeSettingVo object	作业模式设置
job_output_setting	IsapJobOutputSetting object	作业输出设置
process_error	String	参数解释: 处理错误 NONE 无约束限制不涉及取值范围: NONE 默认值不涉及
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_type	String	参数解释: 查询类型 SQL SQL查询 CBSL CBSL查询约束限制不涉及取值范围: SQL CBSL 默认值不涉及
script	String	Script 脚本
status	String	参数解释: 状态 ENABLED 启用 DISABLED 禁用约束限制不涉及取值范围: ENABLED DISABLED 默认值不涉及
table_name	String	表名称
template_id	String	UUID
template_name	String	Template Name
triggers	Array of Trigger objects	触发器数组
update_by	String	UUID
update_time	Integer	毫秒时间戳

表4 IsapJobModeSettingVo
参数	参数类型	描述
batch_overtime_interval	Integer	Time
batch_overtime_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
batch_frequency_interval	Integer	Time
batch_frequency_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
streaming_state_ttl_interval	Integer	Time
streaming_state_ttl_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
streaming_checkpoint_ttl_interval	Integer	Time
streaming_checkpoint_ttl_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
streaming_startup_mode	String	参数解释: 作业启动模式 UPGRADE 升级启动 REFRESH_NEW 全新启动约束限制不涉及取值范围: UPGRADE REFRESH_NEW 默认值不涉及
batch_overtime_strategy_interval	Integer	Time
batch_overtime_strategy_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
search_delay_interval	Integer	Time
search_delay_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
search_frequency_interval	Integer	Time
search_frequency_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
search_overtime_interval	Integer	Time
search_overtime_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
search_period_interval	Integer	Time
search_period_unit	String	参数解释: 时间单位 MINUTE 分钟 HOUR 小时 DAY 天 MONTH 月约束限制不涉及取值范围: MINUTE HOUR DAY MONTH 默认值不涉及
search_table_id	String	UUID
search_table_name	String	表名称

表5 IsapJobOutputSetting
参数	参数类型	描述
alert_custom_properties	Map<String,String>	Map<String,String>
alert_description	String	告警描述
alert_grouping	Boolean	分组标志
alert_mapping	Map<String,String>	Map<String,String>
alert_name	String	告警报名称
alert_remediation	String	告警修复建议
alert_severity	String	参数解释: 告警等级 TIPS 提示 LOW 低危 MEDIUM 中危 HIGH 高危 FATAL 致命约束限制不涉及取值范围: TIPS LOW MEDIUM HIGH FATAL 默认值不涉及
alert_suppression	Boolean	抑制标志
alert_type	Map<String,String>	Map<String,String>
entity_extraction	Map<String,String>	Map<String,String>
field_mapping	Map<String,String>	Map<String,String>

表6 Trigger
参数	参数类型	描述
accumulated_times	Integer	累计次数
expression	String	Expression
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 默认值不涉及

请求示例

无

响应示例

无

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 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

    
     
       
       
         # 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

    
     
       
       
         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	Success

错误码

请参见错误码。

父主题： 告警规则模板管理

上一篇：列出告警规则模板

下一篇：列出告警规则模板总览

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

查看告警规则模板

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

Java

Python

Go

更多

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？