文档首页/ 应用运维管理 AOM/ API参考/ API/ 告警/ 新增告警行动规则
更新时间:2024-10-25 GMT+08:00
分享

新增告警行动规则

功能介绍

新增告警行动规则。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/alert/action-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

最小长度:1

最大长度:40960

Content-Type

String

指定类型为application/json。

枚举值:

  • application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_name

String

规则名称

只含有汉字数字、字母、下划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100

最小长度:1

最大长度:100

project_id

String

项目ID

最小长度:32

最大长度:32

user_name

String

子账号名称

最小长度:1

最大长度:100

desc

String

规则描述。规则描述长度为0到1024个字符,并且只能是数字、字母、特殊字符(_*)、空格和中文组成,不能以下划线开头和结尾。

最小长度:0

最大长度:1024

type

String

规则类型。"1":通知,"2":用户

最小长度:1

最大长度:1

枚举值:

  • 1

  • 2

notification_template

String

消息模板

最小长度:1

最大长度:100

create_time

Long

创建时间

最小值:0

最大值:9999999999999

update_time

Long

修改时间

最小值:0

最大值:9999999999999

time_zone

String

时区

最小长度:1

最大长度:100

smn_topics

Array of SmnTopics objects

SMN主题信息,不能大于5

数组长度:1 - 5

表4 SmnTopics

参数

是否必选

参数类型

描述

display_name

String

Topic的显示名,推送邮件消息时,作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。

最小长度:1

最大长度:64

name

String

创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符。

最小长度:1

最大长度:255

push_policy

Integer

SMN消息推送策略。取值为0或1

最小值:0

最大值:1

status

Integer

topic中订阅者的状态。0:主题已删除或主题下订阅列表为空。1:主题下的订阅列表存在状态为“已订阅”的订阅信息。2:主题下的订阅信息状态处于“未订阅”或“已取消”。

枚举值:

  • 0

  • 1

  • 2

topic_urn

String

Topic的唯一的资源标识。

最小长度:1

最大长度:100

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度:13

最大长度:13

error_msg

String

响应信息描述。

最小长度:1

最大长度:100

trace_id

String

响应id。

最小长度:12

最大长度:12

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:0

最大长度:1024

error_type

String

错误类型

最小长度:0

最大长度:128

trace_id

String

请求id

最小长度:32

最大长度:32

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:0

最大长度:1024

error_type

String

错误类型

最小长度:0

最大长度:128

trace_id

String

请求id

最小长度:32

最大长度:32

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

最小长度:13

最大长度:13

error_msg

String

响应信息描述。

最小长度:1

最大长度:100

trace_id

String

响应id。

最小长度:12

最大长度:12

请求示例

新增一条行动规则名称为"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" : null
}

状态码: 403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

状态码: 500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

{
  "error_code" : "APM.00000500",
  "error_msg" : "Internal Server Error",
  "trace_id" : ""
}

SDK代码示例

SDK代码示例如下。

新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。

 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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("<YOUR REGION>"))
                .build();
        AddActionRuleRequest request = new AddActionRuleRequest();
        ActionRule body = new ActionRule();
        List<SmnTopics> 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());
        }
    }
}

新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。

 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
50
# 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("<YOUR REGION>")) \
        .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)

新增一条行动规则名称为"66666"、用户名称为"kxxxxxxxt"、用户id为"21axxxxxxxxxxxxxxxxx47c"且采用"aom.built-in.template.zh"通知模板的告警行动规则。

 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
50
51
52
53
54
55
56
57
58
59
60
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK 添加成功

400

BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

401

Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

错误码

请参见错误码

相关文档