更新时间:2025-07-23 GMT+08:00
分享

创建告警订阅

功能介绍

创建告警订阅。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/alarm-subs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

告警订阅名称。

取值范围

不涉及。

enable

Integer

参数解释

是否开启订阅。

取值范围

不涉及。

alarm_level

String

参数解释

告警级别。

取值范围

不涉及。

notification_target

String

参数解释

消息主题地址。

取值范围

不涉及。

notification_target_name

String

参数解释

消息主题名称。

取值范围

不涉及。

notification_target_type

String

参数解释

消息主题类型,支持SMN。

取值范围

不涉及。

time_zone

String

参数解释

时区。

取值范围

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

告警订阅ID。

取值范围

不涉及。

name

String

参数解释

告警订阅名称。

取值范围

不涉及。

enable

Integer

参数解释

是否开启订阅。

取值范围

不涉及。

alarm_level

String

参数解释

告警级别。

取值范围

不涉及。

project_id

String

参数解释

项目ID。

取值范围

不涉及。

name_space

String

参数解释

所属服务。

取值范围

不涉及。

notification_target

String

参数解释

消息主题地址。

取值范围

不涉及。

notification_target_name

String

参数解释

消息主题名称。

取值范围

不涉及。

notification_target_type

String

参数解释

消息主题类型。

取值范围

不涉及。

language

String

参数解释

语言。

取值范围

不涉及。

time_zone

String

参数解释

时区。

取值范围

不涉及。

请求示例

开启名为“zrf-test-12”的紧急、重要、次要告警订阅,并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”。

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs

{
  "alarm_level" : "urgent,important,minor",
  "enable" : 1,
  "name" : "zrf-test-12",
  "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
  "notification_target_name" : "dws-test-nodelete",
  "notification_target_type" : "SMN",
  "time_zone" : "GMT+08:00"
}

响应示例

状态码:200

创建告警订阅成功。

{
  "id" : "273ce506-dad8-411c-92f9-be5004739b40",
  "name" : "zrf-test-12",
  "enable" : 1,
  "language" : "zh-cn",
  "alarm_level" : "urgent,important,minor",
  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
  "name_space" : "dws",
  "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
  "notification_target_name" : "dws-test-nodelete",
  "notification_target_type" : "SMN",
  "time_zone" : "GMT+08:00"
}

SDK代码示例

SDK代码示例如下。

开启名为“zrf-test-12”的紧急、重要、次要告警订阅,并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”。

 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
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class CreateAlarmSubSolution {

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAlarmSubRequest request = new CreateAlarmSubRequest();
        AlarmSubRequest body = new AlarmSubRequest();
        body.withTimeZone("GMT+08:00");
        body.withNotificationTargetType("SMN");
        body.withNotificationTargetName("dws-test-nodelete");
        body.withNotificationTarget("urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete");
        body.withAlarmLevel("urgent,important,minor");
        body.withEnable(1);
        body.withName("zrf-test-12");
        request.withBody(body);
        try {
            CreateAlarmSubResponse response = client.createAlarmSub(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());
        }
    }
}

开启名为“zrf-test-12”的紧急、重要、次要告警订阅,并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.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 = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAlarmSubRequest()
        request.body = AlarmSubRequest(
            time_zone="GMT+08:00",
            notification_target_type="SMN",
            notification_target_name="dws-test-nodelete",
            notification_target="urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
            alarm_level="urgent,important,minor",
            enable=1,
            name="zrf-test-12"
        )
        response = client.create_alarm_sub(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

开启名为“zrf-test-12”的紧急、重要、次要告警订阅,并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”。

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

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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 := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAlarmSubRequest{}
	alarmLevelAlarmSubRequest:= "urgent,important,minor"
	enableAlarmSubRequest:= int32(1)
	request.Body = &model.AlarmSubRequest{
		TimeZone: "GMT+08:00",
		NotificationTargetType: "SMN",
		NotificationTargetName: "dws-test-nodelete",
		NotificationTarget: "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
		AlarmLevel: &alarmLevelAlarmSubRequest,
		Enable: &enableAlarmSubRequest,
		Name: "zrf-test-12",
	}
	response, err := client.CreateAlarmSub(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建告警订阅成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档