文档首页 > > API参考> API> Topic操作> 查询Topic列表

查询Topic列表

分享
更新时间: 2019/09/12 GMT+08:00

功能介绍

  • 接口名称

    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

    int

    偏移量

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

    limit

    int

    • 取值范围: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

    int

    返回的Topic个数。

    说明:

    该参数不受offset和limit影响,即返回的是您账户下所有的Topic个数。

    topics

    Topic结构体数组

    Topic详细信息。

    请参见表1

    表1 Topic结构体

    名称

    参数类型

    说明

    topic_urn

    String

    Topic的唯一的资源标识

    name

    String

    创建topi的名字

    display_name

    String

    Topic的显示名,推送邮件消息时,作为邮件发件人显示。

    push_policy

    Int

    消息推送的策略,该属性目前不支持修改,后续将支持修改。

    • 0表示发送失败,保留到失败队列
    • 1表示直接丢弃发送失败的消息
  • 响应样例
    {
        "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            
            }
        ]
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区