文档首页> > API参考> API> 订阅操作> 查询订阅者列表

查询订阅者列表

分享
更新时间: 2019-02-19 16:17

功能介绍

  • 接口名称

    ListSubscriptions

  • 功能描述

    分页返回请求者的所有的订阅列表,订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果订阅者不存在,返回空列表。

URI

  • URI格式

    GET /v2/{project_id}/notifications/subscriptions?offset=0&limit=2

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

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

    offset

    int

    分页列表的起始页,默认值为0。

    offset的值大于等于0。

    limit

    int

    一次返回列表的最大条目,默认值为100。

    limit的值大于0且不大于100。

请求

请求样例
GET /v2/{project_id}/notifications/subscriptions?offset=0&limit=2

响应

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标示ID。

    subscription_count

    int

    订阅者个数。

    subscriptions

    Subscription结构体数组

    Subscription结构体

  • 响应样例
    {
        "request_id": "4650b14bf221492fb819c231d167e6fe", 
        "subscription_count": 2, 
        "subscriptions": [
            {
                "topic_urn": "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1", 
                "protocol": "sms", 
                "subscription_urn": "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837", 
                "owner": "762bdb3251034f268af0e395c53ea09b", 
                "endpoint": "xxxxxxxxxxx", 
                "remark": "", 
                "status": 0
            }, 
            {
                "topic_urn": "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1", 
                "protocol": "email", 
                "subscription_urn": "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:a2d52a9f5c3b47f48c3fafb177a58796", 
                "owner": "762bdb3251034f268af0e395c53ea09b", 
                "endpoint": "xx@xx.com", 
                "remark": "", 
                "status": 0
            }
    ] 
    }

返回值

请参考返回值

错误码

请参考错误码说明

如果您喜欢这篇文档,您还可以:

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区