查询主题列表

功能介绍

• 接口名称

  ListTopics

• 功能描述

  分页查询Topic列表，Topic列表按照Topic创建时间进行降序排列。分页查询可以指定offset以及limit。如果不存在Topic，则返回空列表。

URI

• URI格式

  GET /v2/{project_id}/notifications/topics?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/topics?offset=0&limit=100

响应消息

• 要素说明

  名称	参数类型	说明
  request_id	String	请求的唯一标识ID。
  topic_count	Integer	返回的Topic个数。 说明： 该参数不受offset和limit影响，即返回的是您账户下所有的Topic个数。
  topics	Array of 表1 objects	Topic结构体数组。

  表1 Topic结构体

  名称	参数类型	说明
  topic_urn	String	Topic的唯一的资源标识。
  name	String	创建topic的名称。
  display_name	String	Topic的显示名，推送邮件消息时，作为邮件发件人显示。
  push_policy	Integer	消息推送的策略，该属性目前不支持修改，后续将支持修改。 0表示发送失败，保留到失败队列。 1表示直接丢弃发送失败的消息。
  enterprise_project_id	String	企业项目ID。

• 响应样例

  {
      "request_id": "70bb40bef50e4a14b116a5a527fd7432", 
      "topic_count": 1, 
      "topics": [
          {
              "topic_urn": "urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic_v2", 
              "display_name": "testtest", 
              "name": "test_topic_v1", 
              "push_policy": 0,
              "enterprise_project_id" : "0"
          }
      ]
  }

返回值

请参考返回值。

错误码

请参考错误码。