查询订阅者列表

功能介绍

• 接口名称

  ListSubscriptions

• 功能描述

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

URI

• URI格式

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

• 参数说明

  名称	是否必选	参数类型	说明
  project_id	是	String	项目ID。 获取项目ID请参考获取项目ID。
  offset	否	Integer	偏移量。 偏移量为一个大于0小于资源总个数的整数，表示查询该偏移量后面的所有的资源数，默认值为0。
  limit	否	Integer	取值范围：1~100 取值一般为10，20，50 功能说明：每页返回的资源个数。 默认值为100。

请求消息

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

响应消息

• 要素说明

  名称	参数类型	说明
  request_id	String	请求的唯一标识ID。
  subscription_count	Integer	订阅者个数。
  subscriptions	Array of 表1 objects	Subscription结构体。

  表1 Subscription结构体

  名称	参数类型	说明
  topic_urn	String	Topic的唯一的资源标识。
  protocol	String	不同协议对应不同的endpoint（接受消息的接入点）。 目前支持的协议包括： “email”：邮件传输协议，endpoint为邮箱地址。 “sms”：短信传输协议，endpoint为手机号码。 “http”、“https”：HTTP/HTTPS传输协议，endpoint为URL。
  subscription_urn	String	订阅者的唯一资源标识。
  owner	String	Topic创建者的项目ID。
  endpoint	String	接受消息的接入点。
  remark	String	备注。
  status	Integer	订阅者状态。 0表示订阅还未确认 1表示已经确认 3表示已经取消确认

• 响应样例

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

返回值

请参考返回值。

错误码

请参考错误码。