# 查看告警规则 - ShowAlertRule #### 功能介绍 查看告警规则 #### 调用方法 请参见[如何调用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/{alert_rule_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | workspace_id | 是 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | alert_rule_id | 是 | String | 告警规则 ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alert_rule_id | String | UUID | | alert_rule_name | String | Alert rule name 告警规则名称 | | script | String | Job Script 作业脚本 | | status | String | **参数解释**： 作业状态 - ENABLED 启用 - DISABLED 禁用 **约束限制**： 不涉及 **取值范围**： - ENABLED - DISABLED **默认取值**： 不涉及 | | directory | String | directory 目录分组 | | description | String | Alert rule description 告警规则描述 | | job_mode | String | **参数解释**： 作业模式 - STREAMING 流式处理 - BATCH 批处理 - SEARCH 检索 **约束限制**： 不涉及 **取值范围**： - STREAMING - BATCH - SEARCH **默认取值**： 不涉及 | | job_mode_setting | [IsapJobModeSettingVo] object | 作业模式设置 | | job_output_setting | [AlertRuleJobSetting] object | 告警规则作业设置 | | 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 **默认取值**： 不涉及 | | process_error | String | **参数解释**： 告警规则处理错误 - NONE 无 **约束限制**： 不涉及 **取值范围**： - NONE **默认取值**： 不涉及 | | environment | String | **参数解释**： 环境类型 - PROD 生产环境 - TEST 测试环境 **约束限制**： 不涉及 **取值范围**： - PROD - TEST **默认取值**： 不涉及 | | output_table_id | String | UUID | | output_table_name | String | 表名称 | | output_table_ids | Array of strings | 输出表ID列表 | | output_table_names | Array of strings | 输出表名称列表 | | create_by | String | 创建者 | | create_time | Integer | 毫秒时间戳 | | update_by | String | 更新者 | | update_time | Integer | 毫秒时间戳 | | delete_time | Integer | 毫秒时间戳 | 表4IsapJobModeSettingVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | batch_overtime_interval | Integer | 整型间隔时长 | | batch_overtime_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | batch_frequency_interval | Integer | 整型间隔时长 | | batch_frequency_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | streaming_state_ttl_interval | Integer | 整型间隔时长 | | streaming_state_ttl_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | streaming_checkpoint_ttl_interval | Integer | 整型间隔时长 | | 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 | 整型间隔时长 | | batch_overtime_strategy_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | search_delay_interval | Integer | 整型间隔时长 | | search_delay_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | search_frequency_interval | Integer | 整型间隔时长 | | search_frequency_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | search_overtime_interval | Integer | 整型间隔时长 | | search_overtime_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | search_period_interval | Integer | 整型间隔时长 | | search_period_unit | String | **参数解释**： 时间单位 - MINUTE 分钟 - HOUR 小时 - DAY 天 - MONTH 月 **约束限制**： 不涉及 **取值范围**： - MINUTE - HOUR - DAY - MONTH **默认取值**： 不涉及 | | search_table_id | String | UUID | | search_table_name | String | 表名称 | | field_not_null_policy | String | **参数解释：** 作业表非空字段处理策略 LOOSE 宽松 STRICT 严格 **约束限制：** 不涉及 **取值范围：** LOOSE STRICT **默认取值：** LOOSE | 表5AlertRuleJobSetting | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alert_custom_properties | Map\ | 告警自定义属性 | | alert_description | String | 告警描述 | | alert_grouping | Boolean | 是否告警分组 | | alert_mapping | Map\ | 告警映射 | | 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\ | 告警类型 | | entity_extraction | Map\ | 提取的实体 | | field_mapping | Map\ | 字段映射 | | dict_mapping | Array of [DictMappingObject] objects | 字典映射表 | 表6DictMappingObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dest_field_name | String | 字典映射的目标字段 | | table_id | String | 字典映射对象的维表的ID | | dic_map_name | String | 字典映射名 | | src_field_name | String | 字典映射的原始字段 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功 ``` { "alert_rule_id" : "a75fc53c-88dd-4e0d-966a-dcee7f1b330d", "alert_rule_name" : "test_model", "create_by" : "31a71935020041eca4e5126652f2623e", "create_time" : 1729146003971, "delete_time" : 0, "description" : "test_description", "directory" : "", "environment" : "PROD", "job_mode" : "STREAMING", "job_mode_setting" : { "field_not_null_policy" : "LOOSE", "streaming_checkpoint_ttl_interval" : 3, "streaming_checkpoint_ttl_unit" : "MINUTE", "streaming_startup_mode" : "REFRESH_NEW", "streaming_state_ttl_interval" : 5, "streaming_state_ttl_unit" : "MINUTE" }, "job_output_setting" : { "alert_custom_properties" : { }, "alert_description" : "{{hostName}}", "alert_grouping" : true, "alert_mapping" : { }, "alert_name" : "{{hostName}}", "alert_remediation" : "", "alert_severity" : "MEDIUM", "alert_suppression" : false, "alert_type" : { "name" : "alert_type", "business_code" : "Public_Opinion", "id" : "ac93dbd6cfa1f62f699c70a01b0af669", "dataclass_id" : "7ac212d5-1733-3295-84e9-dea7a0d2dbb9", "category" : "other" }, "entity_extraction" : { "environment" : "{\"environment.domain_id\":\"{{hostName}}\"}" }, "field_mapping" : { "severity" : "MEDIUM", "description" : "{{hostName}}", "title" : "{{hostName}}" } }, "output_table_id" : "19b984a9-3088-4676-b308-c4c6cfd15648", "output_table_ids" : [ "19b984a9-3088-4676-b308-c4c6cfd15648" ], "output_table_name" : "security_alert", "output_table_names" : [ "security_alert" ], "process_error" : "NONE", "process_status" : "COMPLETED", "script" : "select * from s_sec_hss_alarm", "status" : "DISABLED", "update_by" : "31a71935020041eca4e5126652f2623e", "update_time" : 1767073080312 } ``` #### 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 ShowAlertRuleSolution { 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(); ShowAlertRuleRequest request = new ShowAlertRuleRequest(); request.withWorkspaceId("{workspace_id}"); request.withAlertRuleId("{alert_rule_id}"); try { ShowAlertRuleResponse response = client.showAlertRule(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 = ShowAlertRuleRequest() request.workspace_id = "{workspace_id}" request.alert_rule_id = "{alert_rule_id}" response = client.show_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] ``` 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.ShowAlertRuleRequest{} request.WorkspaceId = "{workspace_id}" request.AlertRuleId = "{alert_rule_id}" response, err := client.ShowAlertRule(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=ShowAlertRule&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。