Updated on 2024-04-03 GMT+08:00

Creating Message Filter Policies for a Subscriber

Function

This API is used to create message filter policies for subscribers.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies a user token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

polices

Yes

Array of polices objects

Specifies subscriber policies to be processed in batches.

Array Length: 1 - 100

Table 4 polices

Parameter

Mandatory

Type

Description

subscription_urn

Yes

String

Specifies the resource identifier of the subscriber, which is unique. To obtain the resource identifier, see Querying Subscribers.

filter_polices

Yes

Array of SubscriptionsFilterPolicy objects

Specifies the message filter policies of a subscriber. The policy name must be unique.

Array Length: 1 - 5

Table 5 SubscriptionsFilterPolicy

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the filter policy name. name can contain 1 to 32 characters, including lowercase letters, digits, and underscores (). name cannot start or end with an underscore, nor contain consecutive underscores. name cannot start with **smn**.

Minimum: 1

Maximum: 32

string_equals

Yes

Array of strings

Specifies the string array for exact match. An array can contain 1 to 10 strings. The array content must be unique. The string cannot be null or an empty string "". A string can contain 1 to 32 characters, including letters, digits, and underscores (_).

Minimum: 1

Maximum: 32

Array Length: 1 - 10

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique request ID.

batch_result

Array of BatchResult objects

Specifies the batch processing result.

Table 7 BatchResult

Parameter

Type

Description

code

String

Specifies the returned code.

message

String

Specifies the code message.

subscription_urn

String

Specifies the subscriber URN.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Example Requests

Creating message filter policies for a subscriber

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

Example Responses

Status code: 200

OK

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

SDK Sample Code

The SDK sample code is as follows.

Java

Creating message filter policies for a subscriber

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

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

        SmnClient client = SmnClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreateSubscriptionsFilterPolicesRequest request = new BatchCreateSubscriptionsFilterPolicesRequest();
        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 {
            BatchCreateSubscriptionsFilterPolicesResponse response = client.batchCreateSubscriptionsFilterPolices(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

Creating message filter policies for a subscriber

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

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

    credentials = BasicCredentials(ak, sk) \

    client = SmnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchCreateSubscriptionsFilterPolicesRequest()
        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_create_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

Creating message filter policies for a subscriber

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

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

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreateSubscriptionsFilterPolicesRequest{}
	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.BatchCreateSubscriptionsFilterPolices(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

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.