文档首页/ 消息通知服务 SMN/ API参考/ API/ 订阅用户/ 查询订阅用户列表 - ListSubscriptionUser
更新时间:2026-04-14 GMT+08:00

查询订阅用户列表 - ListSubscriptionUser

功能介绍

查询订阅用户列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    smn:subscriptionUser:list

    List

    subscription_user *

    -

    -

    -

URI

GET /v2/{domain_id}/subscription-users

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

租户账号ID。

表2 Query参数

参数

是否必选

参数类型

描述

name

String

订阅用户名称。

protocol

String

协议。

http:HTTP终端

https:HTTPS终端

sms:短信

email:邮件

callnotify: 语音

wechat: 企业微信机器人

dingding: 钉钉群机器人

feishu: 飞书群机器人

welink: WeLink群机器人

ding_talk_bot: 个人钉钉协议

status

String

订阅用户状态。

UNCONFIRMED:未确认

CONFIRMED:已确认

CANCELLED:已取消

group

String

订阅用户分组。该字段支持模糊查询。

offset

Integer

偏移量。偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。

limit

Integer

查询数量限制。取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

该接口属于全局API调用时需要进行全局授权,即X-Auth-Token需要传入domain级别的token。

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

count

Integer

订阅用户数量。

subscription_users

Array of ListSubscriptionUserResponseItemInfo objects

订阅用户信息列表。

ding_talk_bot

ListSubscriptionUserResponseDingTalkBotEndpointInfo object

钉钉个人消息协议订阅用户终端地址。

表5 ListSubscriptionUserResponseItemInfo

参数

参数类型

描述

id

String

订阅用户ID。

domain_id

String

租户账号ID。

name

String

订阅用户名称。

status

String

订阅用户状态。

UNCONFIRMED:未确认

CONFIRMED:已确认

CANCELLED:已取消

group

Array of strings

订阅用户分组。

create_time

String

创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

update_time

String

更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。

http

ListSubscriptionUserResponseHttpEndpointInfo object

http协议订阅用户终端地址。

https

ListSubscriptionUserResponseHttpsEndpointInfo object

https协议订阅用户终端地址。

sms

ListSubscriptionUserResponseSmsEndpointInfo object

sms协议订阅用户终端地址。

email

ListSubscriptionUserResponseEmailEndpointInfo object

email协议订阅用户终端地址。

callnotify

ListSubscriptionUserResponseCallnotifyEndpointInfo object

语音通知协议订阅用户终端地址。

wechat

ListSubscriptionUserResponseWechatEndpointInfo object

微信群机器人协议订阅用户终端地址。

dingding

ListSubscriptionUserResponseDingdingEndpointInfo object

钉钉群机器人协议订阅用户终端地址。

feishu

ListSubscriptionUserResponseFeishuEndpointInfo object

飞书群机器人协议订阅用户终端地址。

welink

ListSubscriptionUserResponseWelinkEndpointInfo object

WeLink群机器人协议订阅用户终端地址。

表6 ListSubscriptionUserResponseHttpEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

header

Map<String,String>

http协议订阅用户的自定义请求头。http协议订阅用户可以自定义请求头。

表7 ListSubscriptionUserResponseHttpsEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

header

Map<String,String>

https协议订阅用户的自定义请求头。https协议订阅用户可以自定义请求头。

表8 ListSubscriptionUserResponseSmsEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

表9 ListSubscriptionUserResponseEmailEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

表10 ListSubscriptionUserResponseCallnotifyEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

表11 ListSubscriptionUserResponseWechatEndpointInfo

参数

参数类型

描述

endpoint

String

隐去敏感信息的终端地址。

表12 ListSubscriptionUserResponseDingdingEndpointInfo

参数

参数类型

描述

endpoint

String

隐去敏感信息的终端地址。

keyword

String

dingding协议订阅用户的关键字。dingding协议订阅用户必须指定keyword和sign_secret二者之一。当用户在钉钉机器人端添加关键字校验的安全策略时,这里的关键字必须是钉钉端所填写的关键字之一。

sign_secret

String

dingding协议订阅用户的加签密钥字段。dingding协议订阅用户必须指定keyword和sign_secret二者之一。当用户在钉钉机器人端添加关键字校验的安全策略时,这里的关键字必须是钉钉端所填写的关键字之一。

表13 ListSubscriptionUserResponseFeishuEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

keyword

String

feishu协议订阅用户的关键字。feishu协议订阅用户必须指定keyword和sign_secret二者之一。当用户在飞书机器人端添加关键字校验的安全策略时,这里的关键字必须是飞书端所填写的关键字之一。

sign_secret

String

feishu协议订阅用户的加签密钥字段。feishu协议订阅用户必须指定keyword和sign_secret二者之一。当用户在飞书机器人端添加关键字校验的安全策略时,这里的关键字必须是飞书端所填写的关键字之一。

表14 ListSubscriptionUserResponseWelinkEndpointInfo

参数

参数类型

描述

endpoint

String

终端地址。

client_id

String

welink协议订阅用户的client_id,从Welink方获取。

表15 ListSubscriptionUserResponseDingTalkBotEndpointInfo

参数

参数类型

描述

endpoint

String

钉钉企业用户的userId。

robot_code

String

钉钉创建的机器人编码。

状态码:400

表16 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

状态码:403

表17 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

状态码:404

表18 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

状态码:500

表19 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

error_code

String

返回信息对应的代码。

error_msg

String

服务异常错误信息描述。

请求示例

查询订阅用户列表

GET https://{SMNGLOBAL_Endpoint}/v2/{domain_id}/subscription-users?name=test&protocol=email&status=UNCONFIRMED&group=test_group1&offset=0&limit=100

响应示例

状态码:200

OK

{
  "request_id" : "922a1e7af7ad49e5b3ad455306bbddef",
  "count" : 1,
  "subscription_users" : [ {
    "id" : "e08d1d82a57a4772b353d85445cefd7b",
    "domain_id" : "f7c690ceb6ef4846b897fde2af08befa",
    "name" : "test",
    "status" : "UNCONFIRMED",
    "group" : [ "test_group1" ],
    "create_time" : "2025-01-01T00:00:00Z",
    "update_time" : "2025-01-01T00:00:00Z",
    "email" : {
      "endpoint" : "xxx@example.com"
    }
  } ]
}

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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.smnglobal.v2.region.SmnglobalRegion;
import com.huaweicloud.sdk.smnglobal.v2.*;
import com.huaweicloud.sdk.smnglobal.v2.model.*;


public class ListSubscriptionUserSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmnglobalClient client = SmnglobalClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnglobalRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSubscriptionUserRequest request = new ListSubscriptionUserRequest();
        try {
            ListSubscriptionUserResponse response = client.listSubscriptionUser(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksmnglobal.v2.region.smnglobal_region import SmnglobalRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmnglobal.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"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = ListSubscriptionUserRequest()
        response = client.list_subscription_user(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    smnglobal "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := smnglobal.NewSmnglobalClient(
        smnglobal.SmnglobalClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSubscriptionUserRequest{}
	response, err := client.ListSubscriptionUser(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

错误码

请参见错误码