更新时间:2024-09-06 GMT+08:00

批量更新订阅过滤策略

功能介绍

更新订阅者的消息过滤策略。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/notifications/subscriptions/filter_polices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取项目ID请参考 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

polices

Array of polices objects

批量处理订阅者策略列表。

表4 polices

参数

是否必选

参数类型

描述

subscription_urn

String

订阅者的唯一的资源标识,可通过查询订阅者列表获取该标识。

filter_polices

Array of SubscriptionsFilterPolicy objects

订阅者的过滤策略。策略name不能重复

表5 SubscriptionsFilterPolicy

参数

是否必选

参数类型

描述

name

String

过滤策略名称。

包含小写英文字母([a-z])、数字([0-9])、下划线(_),下划线不得开始、结尾或连续出现),长度限制{1,32},不能是smn_开头。

string_equals

Array of strings

字符串精确匹配数组。数组长度[1, 10],数组内容不能重复,值不能为null或者空字符串“ ”,长度限制[1,32],中英文、数字、下划线

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

batch_result

Array of BatchResult objects

批量结果

表7 BatchResult

参数

参数类型

描述

code

String

执行结果code

message

String

执行结果message

subscription_urn

String

订阅者urn

状态码: 400

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 404

表10 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

更新订阅消息过滤策略

PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/subscriptions/filter_polices

{
  "polices" : [ {
    "subscription_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837",
    "filter_polices" : [ {
      "name" : "alarm",
      "string_equals" : [ "os", "process" ]
    }, {
      "name" : "service",
      "string_equals" : [ "api", "db" ]
    } ]
  } ]
}

响应示例

状态码: 200

OK

{
  "request_id" : "be368401641b406d8c28a79915ba3589",
  "batch_result" : [ {
    "code" : "SMN.00011027",
    "message" : "Parameter: subscription_urn is invalid.",
    "subscription_urn" : "urn:smn:cn-north-4:98386b0630aa41d990d4729497fcd7ba:test:90b22be1efab4cd6924703c5b228e59f"
  }, {
    "code" : "SMN.00011027",
    "message" : "Parameter: subscription_urn is invalid.",
    "subscription_urn" : "urn:smn:cn-north-4:98386b0630aa41d990d4729497fcd7ba:test:c872b769e60d45f682f1da44eb4dbee3"
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

更新订阅消息过滤策略

 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
69
70
71
72
73
74
75
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.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchUpdateSubscriptionsFilterPolicesSolution {

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

        SmnClient client = SmnClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchUpdateSubscriptionsFilterPolicesRequest request = new BatchUpdateSubscriptionsFilterPolicesRequest();
        BatchSubscriptionsFilterPolicesRequestBody body = new BatchSubscriptionsFilterPolicesRequestBody();
        List<String> listFilterPolicesStringEquals = new ArrayList<>();
        listFilterPolicesStringEquals.add("api");
        listFilterPolicesStringEquals.add("db");
        List<String> listFilterPolicesStringEquals1 = new ArrayList<>();
        listFilterPolicesStringEquals1.add("os");
        listFilterPolicesStringEquals1.add("process");
        List<SubscriptionsFilterPolicy> listPolicesFilterPolices = new ArrayList<>();
        listPolicesFilterPolices.add(
            new SubscriptionsFilterPolicy()
                .withName("alarm")
                .withStringEquals(listFilterPolicesStringEquals1)
        );
        listPolicesFilterPolices.add(
            new SubscriptionsFilterPolicy()
                .withName("service")
                .withStringEquals(listFilterPolicesStringEquals)
        );
        List<BatchSubscriptionsFilterPolicesRequestBodyPolices> listbodyPolices = new ArrayList<>();
        listbodyPolices.add(
            new BatchSubscriptionsFilterPolicesRequestBodyPolices()
                .withSubscriptionUrn("urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837")
                .withFilterPolices(listPolicesFilterPolices)
        );
        body.withPolices(listbodyPolices);
        request.withBody(body);
        try {
            BatchUpdateSubscriptionsFilterPolicesResponse response = client.batchUpdateSubscriptionsFilterPolices(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

更新订阅消息过滤策略

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.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 = SmnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchUpdateSubscriptionsFilterPolicesRequest()
        listStringEqualsFilterPolices = [
            "api",
            "db"
        ]
        listStringEqualsFilterPolices1 = [
            "os",
            "process"
        ]
        listFilterPolicesPolices = [
            SubscriptionsFilterPolicy(
                name="alarm",
                string_equals=listStringEqualsFilterPolices1
            ),
            SubscriptionsFilterPolicy(
                name="service",
                string_equals=listStringEqualsFilterPolices
            )
        ]
        listPolicesbody = [
            BatchSubscriptionsFilterPolicesRequestBodyPolices(
                subscription_urn="urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837",
                filter_polices=listFilterPolicesPolices
            )
        ]
        request.body = BatchSubscriptionsFilterPolicesRequestBody(
            polices=listPolicesbody
        )
        response = client.batch_update_subscriptions_filter_polices(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

更新订阅消息过滤策略

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

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

    request := &model.BatchUpdateSubscriptionsFilterPolicesRequest{}
	var listStringEqualsFilterPolices = []string{
        "api",
	    "db",
    }
	var listStringEqualsFilterPolices1 = []string{
        "os",
	    "process",
    }
	var listFilterPolicesPolices = []model.SubscriptionsFilterPolicy{
        {
            Name: "alarm",
            StringEquals: listStringEqualsFilterPolices1,
        },
        {
            Name: "service",
            StringEquals: listStringEqualsFilterPolices,
        },
    }
	var listPolicesbody = []model.BatchSubscriptionsFilterPolicesRequestBodyPolices{
        {
            SubscriptionUrn: "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837",
            FilterPolices: listFilterPolicesPolices,
        },
    }
	request.Body = &model.BatchSubscriptionsFilterPolicesRequestBody{
		Polices: listPolicesbody,
	}
	response, err := client.BatchUpdateSubscriptionsFilterPolices(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码