Updated on 2024-06-28 GMT+08:00

Adding an Alarm Action Rule

Function

This API is used to add an alarm action rule.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Minimum: 32

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Minimum: 1

Maximum: 40960

Content-Type

Yes

String

Content type, which is application/json.

Enumeration values:

  • application/json

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

rule_name

Yes

String

Rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, and underscores (_) are allowed.

Minimum: 1

Maximum: 100

project_id

Yes

String

Project ID.

Minimum: 32

Maximum: 32

user_name

Yes

String

Member account name.

Minimum: 1

Maximum: 100

desc

No

String

Rule description. Enter a maximum of 1024 characters and do not start or end with an underscore (_). Only digits, letters, underscores (_), asterisk (*), and spaces are allowed.

Minimum: 0

Maximum: 1024

type

Yes

String

Action type. Default: Notification.

Minimum: 1

Maximum: 1

Enumeration values:

  • 1

  • 2

notification_template

Yes

String

Message template.

Minimum: 1

Maximum: 100

create_time

No

Long

Creation time.

Minimum: 0

Maximum: 9999999999999

update_time

No

Long

Modification time

Minimum: 0

Maximum: 9999999999999

time_zone

No

String

Time zone.

Minimum: 1

Maximum: 100

smn_topics

Yes

Array of SmnTopics objects

SMN topic. The total number of topics cannot exceed 5.

Array Length: 1 - 5

Table 4 SmnTopics

Parameter

Mandatory

Type

Description

display_name

No

String

Topic display name, which will be the name of an email sender. Max.: 192 bytes. This parameter is left blank by default.

Minimum: 1

Maximum: 64

name

Yes

String

Name of the topic. Enter 1 to 255 characters starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Minimum: 1

Maximum: 255

push_policy

Yes

Integer

SMN message push policy. Options: 0 and 1.

Minimum: 0

Maximum: 1

status

No

Integer

Status of the topic subscriber. 0: The topic has been deleted or the subscription list of this topic is empty. 1: The subscription object is in the subscribed state. 2: The subscription object is in the unsubscribed or canceled state.

Enumeration values:

  • 0

  • 1

  • 2

topic_urn

Yes

String

Unique resource identifier of the topic.

Minimum: 1

Maximum: 100

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 13

Maximum: 13

error_msg

String

Response message.

Minimum: 1

Maximum: 100

trace_id

String

Response ID.

Minimum: 12

Maximum: 12

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 13

Maximum: 13

error_msg

String

Response message.

Minimum: 1

Maximum: 100

trace_id

String

Response ID.

Minimum: 12

Maximum: 12

Example Requests

Add an alarm action rule whose name is "66666", username is "kxxxxxxxt", user ID is "21axxxxxxxxxxxxxxxxx47c", and notification template is "aom.built-in.template.en".

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

Example Responses

Status code: 400

Bad Request: Invalid request. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.08018012",
  "error_msg" : "actionRule already exists",
  "trace_id" : ""
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

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

Status code: 403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

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

Status code: 500

Internal Server Error: The server is able to receive the request but unable to understand the request.

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

SDK Sample Code

The SDK sample code is as follows.

Java

Add an alarm action rule whose name is "66666", username is "kxxxxxxxt", user ID is "21axxxxxxxxxxxxxxxxx47c", and notification template is "aom.built-in.template.en".

 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
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");

        ICredential auth = new BasicCredentials()
                .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());
        }
    }
}

Python

Add an alarm action rule whose name is "66666", username is "kxxxxxxxt", user ID is "21axxxxxxxxxxxxxxxxx47c", and notification template is "aom.built-in.template.en".

 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
# 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"]

    credentials = BasicCredentials(ak, sk)

    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)

Go

Add an alarm action rule whose name is "66666", username is "kxxxxxxxt", user ID is "21axxxxxxxxxxxxxxxxx47c", and notification template is "aom.built-in.template.en".

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

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: Operation successful.

400

Bad Request: Invalid request. The client should not repeat the request without modifications.

401

Unauthorized: The authentication information is incorrect or invalid.

403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.