# 新增告警行动规则 - AddActionRule #### 功能介绍 新增告警行动规则。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aom/aom_04_0057.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-aom/aom_04_0031.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | aom:actionRule:create | Write | - | - | - | - | #### URI POST /v2/{project_id}/alert/action-rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。获取方式请参见：[获取Token](https://support.huaweicloud.com/api-aom/aom_04_0059.html)。 | | Content-Type | 是 | String | 消息体的类型（格式）。指定类型为"application/json"。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | rule_name | 是 | String | 告警通知规则名称。只含有中文，数字、字母、下划线，不能以下划线等特殊符号开头和结尾，长度范围为 1到100个字符。 | | project_id | 是 | String | 项目ID。 | | user_name | 是 | String | 子账号名称。 | | desc | 否 | String | 规则描述。长度范围为0到1024个字符，并且只能是数字、字母、特殊字符（_\*）、空格和中文组成，不能以下划线开头和结尾。 | | type | 是 | String | 规则类型： - "1"：prometheus监控。 - "3"：日志监控。 | | notification_template | 是 | String | 消息模板。 | | create_time | 否 | Long | 创建时间。仅支持UTC毫秒级时间戳。例如：2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳：1702759381000 | | update_time | 否 | Long | 修改时间。仅支持UTC毫秒级时间戳。例如：2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳：1702759381000 | | time_zone | 否 | String | 时区。 | | smn_topics | 是 | Array of [SmnTopics] objects | SMN主题信息，不能大于5。 | 表4SmnTopics | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | display_name | 否 | String | Topic的显示名，推送邮件消息时，作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。 | | name | 是 | String | 创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度为1到255个字符。 | | push_policy | 是 | Integer | SMN消息推送策略。取值为0或1。 | | status | 否 | Integer | topic中订阅者的状态。 - 0：主题已删除或主题下订阅列表为空。 - 1：主题下的订阅列表存在状态为"已订阅"的订阅信息。 - 2：主题下的订阅信息状态处于"未订阅"或"已取消"。 | | topic_urn | 是 | String | Topic的唯一的资源标识。 | #### 响应参数 **状态码：200** OK 添加成功。 **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 响应码。 | | error_msg | String | 响应信息描述。 | | trace_id | String | 响应id。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 非法请求错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | | error_type | String | **参数解释：** 错误类型。 **取值范围：** 不涉及。 | | trace_id | String | **参数解释：** 请求id。 **取值范围：** 不涉及。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 非法请求错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | | error_type | String | **参数解释：** 错误类型。 **取值范围：** 不涉及。 | | trace_id | String | **参数解释：** 请求id。 **取值范围：** 不涉及。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 响应码。 | | error_msg | String | 响应信息描述。 | | trace_id | String | 响应id。 | #### 请求示例 新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。 ``` https://{Endpoint}/v2/{project_id}/alert/action-rules { "desc" : "1111", "notification_template" : "aom.built-in.template.zh", "project_id" : "21axxxxxxxxxxxxxxxxx47c", "rule_name" : "66666", "smn_topics" : [ { "display_name" : "", "name" : "xiaohama", "push_policy" : 0, "status" : 0, "topic_urn" : "urn:smn:xxx:21axxxxxxxxxxxxxxxxx47c:xiaohama" } ], "type" : "1", "user_name" : "kxxxxxxxt", "time_zone" : "xxx" } ``` #### 响应示例 **状态码：400** BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 ``` { "error_code" : "AOM.08018012", "error_msg" : "actionRule already exists", "trace_id" : "" } ``` **状态码：401** Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 ``` { "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : "" } ``` **状态码：403** Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 ``` { "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : "" } ``` **状态码：500** InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 ``` { "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。 ``` 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.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; import java.util.List; import java.util.ArrayList; public class AddActionRuleSolution { 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); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("")) .build(); AddActionRuleRequest request = new AddActionRuleRequest(); ActionRule body = new ActionRule(); List listbodySmnTopics = new ArrayList<>(); listbodySmnTopics.add( new SmnTopics() .withDisplayName("") .withName("xiaohama") .withPushPolicy(0) .withStatus(SmnTopics.StatusEnum.NUMBER_0) .withTopicUrn("urn:smn:xxx:21axxxxxxxxxxxxxxxxx47c:xiaohama") ); body.withSmnTopics(listbodySmnTopics); body.withTimeZone("xxx"); body.withNotificationTemplate("aom.built-in.template.zh"); body.withType(ActionRule.TypeEnum.fromValue("1")); body.withDesc("1111"); body.withUserName("kxxxxxxxt"); body.withProjectId("21axxxxxxxxxxxxxxxxx47c"); body.withRuleName("66666"); request.withBody(body); try { AddActionRuleResponse response = client.addActionRule(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] 新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.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 = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("")) \ .build() try: request = AddActionRuleRequest() listSmnTopicsbody = [ SmnTopics( display_name="", name="xiaohama", push_policy=0, status=0, topic_urn="urn:smn:xxx:21axxxxxxxxxxxxxxxxx47c:xiaohama" ) ] request.body = ActionRule( smn_topics=listSmnTopicsbody, time_zone="xxx", notification_template="aom.built-in.template.zh", type="1", desc="1111", user_name="kxxxxxxxt", project_id="21axxxxxxxxxxxxxxxxx47c", rule_name="66666" ) response = client.add_action_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] 新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/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 := aom.AomClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aom.NewAomClient(hcClient) request := &model.AddActionRuleRequest{} displayNameSmnTopics:= "" statusSmnTopics:= model.GetSmnTopicsStatusEnum().E_0 var listSmnTopicsbody = []model.SmnTopics{ { DisplayName: &displayNameSmnTopics, Name: "xiaohama", PushPolicy: int32(0), Status: &statusSmnTopics, TopicUrn: "urn:smn:xxx:21axxxxxxxxxxxxxxxxx47c:xiaohama", }, } timeZoneActionRule:= "xxx" descActionRule:= "1111" request.Body = &model.ActionRule{ SmnTopics: listSmnTopicsbody, TimeZone: &timeZoneActionRule, NotificationTemplate: "aom.built-in.template.zh", Type: model.GetActionRuleTypeEnum().E_1, Desc: &descActionRule, UserName: "kxxxxxxxt", ProjectId: "21axxxxxxxxxxxxxxxxx47c", RuleName: "66666", } response, err := client.AddActionRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AOM/sdk?api=AddActionRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 添加成功。 | | 400 | BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 | | 401 | Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 | | 403 | Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 | | 500 | InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-aom/ErrorCode.html)。