Updated on 2025-09-12 GMT+08:00

Deleting Subscriptions in Batches

Function

This API is used to delete subscriptions in batches. The deletion result of each subscription endpoint is displayed in the response body.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/notifications/subscriptions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

subscription_urns

Yes

Array of BatchDeleteSubscriptionsRequestItemInfo objects

Subscriber information list.

Table 4 BatchDeleteSubscriptionsRequestItemInfo

Parameter

Mandatory

Type

Description

subscription_urn

Yes

String

Unique resource identifier of a subscriber.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

subscriptions_result

Array of BatchDeleteSubscriptionsResponseItemInfo objects

List of unsubscription results.

Table 6 BatchDeleteSubscriptionsResponseItemInfo

Parameter

Type

Description

request_id

String

Unique request ID.

http_code

Integer

Response code.

code

String

Service error code.

message

String

Service error description.

Status code: 400

Table 7 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 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: 404

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: 500

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.

Example Requests

Deleting multiple subscribers in batches

DELETE https://{SMN_Endpoint}/v2/{project_id}/notifications/subscriptions

{
  "subscription_urns" : [ {
    "subscription_urn" : "urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:15999ef53a56495da4a17a375f0935e2"
  }, {
    "subscription_urn" : "urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:8a48ab8d43e04c98a743de6f44ac5997"
  } ]
}

Example Responses

Status code: 200

OK

{
  "subscriptions_result" : [ {
    "request_id" : "2e1991b6d1f94db7a00b75aaa5e9684d",
    "http_code" : 200
  }, {
    "request_id" : "2e1991b6d1f94db7a00b75aaa5e9684d",
    "http_code" : 200
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Deleting multiple subscribers in batches

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

    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();
        BatchDeleteSubscriptionsRequest request = new BatchDeleteSubscriptionsRequest();
        BatchDeleteSubscriptionsRequestBody body = new BatchDeleteSubscriptionsRequestBody();
        List<BatchDeleteSubscriptionsRequestItemInfo> listbodySubscriptionUrns = new ArrayList<>();
        listbodySubscriptionUrns.add(
            new BatchDeleteSubscriptionsRequestItemInfo()
                .withSubscriptionUrn("urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:15999ef53a56495da4a17a375f0935e2")
        );
        listbodySubscriptionUrns.add(
            new BatchDeleteSubscriptionsRequestItemInfo()
                .withSubscriptionUrn("urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:8a48ab8d43e04c98a743de6f44ac5997")
        );
        body.withSubscriptionUrns(listbodySubscriptionUrns);
        request.withBody(body);
        try {
            BatchDeleteSubscriptionsResponse response = client.batchDeleteSubscriptions(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());
        }
    }
}

Deleting multiple subscribers in batches

 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

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 = BatchDeleteSubscriptionsRequest()
        listSubscriptionUrnsbody = [
            BatchDeleteSubscriptionsRequestItemInfo(
                subscription_urn="urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:15999ef53a56495da4a17a375f0935e2"
            ),
            BatchDeleteSubscriptionsRequestItemInfo(
                subscription_urn="urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:8a48ab8d43e04c98a743de6f44ac5997"
            )
        ]
        request.body = BatchDeleteSubscriptionsRequestBody(
            subscription_urns=listSubscriptionUrnsbody
        )
        response = client.batch_delete_subscriptions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Deleting multiple subscribers in batches

 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"
    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.BatchDeleteSubscriptionsRequest{}
	var listSubscriptionUrnsbody = []model.BatchDeleteSubscriptionsRequestItemInfo{
        {
            SubscriptionUrn: "urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:15999ef53a56495da4a17a375f0935e2",
        },
        {
            SubscriptionUrn: "urn:smn:regionId:240489644ad14ace8e022869d34411a4:test1:8a48ab8d43e04c98a743de6f44ac5997",
        },
    }
	request.Body = &model.BatchDeleteSubscriptionsRequestBody{
		SubscriptionUrns: listSubscriptionUrnsbody,
	}
	response, err := client.BatchDeleteSubscriptions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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.