更新时间:2024-04-18 GMT+08:00

创建订阅事件

功能介绍

该接口用于添加订阅的事件。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/event-subs
表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

事件订阅名称。

source_type

String

事件源类型支持:

  • cluster
  • backup
  • disaster-recovery

source_id

String

事件源ID。

category

String

事件类别支持:

  • management
  • monitor
  • security
  • system alarm

枚举值:多个枚举值使用 “, ”分隔。

severity

String

事件级别支持normal,warning。

tag

String

事件标签。

enable

Integer

是否开启订阅:

  • 1为开启。
  • 0为关闭。

notification_target

String

消息通知地址。

notification_target_name

String

消息主题名称。

notification_target_type

String

消息通知类型只支持SMN。

time_zone

String

时区。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

订阅ID。

name

String

订阅名称。

source_type

String

事件源类型。

source_id

String

事件源ID。

category

String

事件类别。

severity

String

事件级别。

tag

String

事件标签。

enable

Integer

是否开启订阅 :

  • 1为开启
  • 0为关闭

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-66的正常和警告事件订阅,并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”:

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

{
  "severity" : "normal,warning",
  "source_id" : "",
  "source_type" : "",
  "tag" : "",
  "category" : "",
  "enable" : 1,
  "name" : "zrf-test-66",
  "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" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b",
  "name" : "zrf-test-66",
  "category" : "",
  "severity" : "normal,warning",
  "tag" : "",
  "enable" : 1,
  "language" : "zh-cn",
  "source_type" : "",
  "source_id" : "",
  "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代码示例如下。

 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 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 CreateEventSubSolution {

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        CreateEventSubRequest request = new CreateEventSubRequest();
        EventSubRequest body = new EventSubRequest();
        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.withEnable(1);
        body.withTag("");
        body.withSeverity("normal,warning");
        body.withCategory("");
        body.withSourceId("");
        body.withSourceType("");
        body.withName("zrf-test-66");
        request.withBody(body);
        try {
            CreateEventSubResponse response = client.createEventSub(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());
        }
    }
}
 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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateEventSubRequest()
        request.body = EventSubRequest(
            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",
            enable=1,
            tag="",
            severity="normal,warning",
            category="",
            source_id="",
            source_type="",
            name="zrf-test-66"
        )
        response = client.create_event_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)
 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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateEventSubRequest{}
	timeZoneEventSubRequest:= "GMT+08:00"
	enableEventSubRequest:= int32(1)
	tagEventSubRequest:= ""
	severityEventSubRequest:= "normal,warning"
	categoryEventSubRequest:= ""
	sourceIdEventSubRequest:= ""
	sourceTypeEventSubRequest:= ""
	request.Body = &model.EventSubRequest{
		TimeZone: &timeZoneEventSubRequest,
		NotificationTargetType: "SMN",
		NotificationTargetName: "dws-test-nodelete",
		NotificationTarget: "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
		Enable: &enableEventSubRequest,
		Tag: &tagEventSubRequest,
		Severity: &severityEventSubRequest,
		Category: &categoryEventSubRequest,
		SourceId: &sourceIdEventSubRequest,
		SourceType: &sourceTypeEventSubRequest,
		Name: "zrf-test-66",
	}
	response, err := client.CreateEventSub(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

创建事件订阅成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。