更新时间:2025-01-07 GMT+08:00

创建主题

功能介绍

  • 接口名称

    CreateTopic

  • 功能描述

    创建Topic,单用户默认配额为3000。高并发场景下,可能会出现Topic数量超过3000仍创建成功的情况,此为正常现象。

    接口是幂等的,接口调用返回成功时,若已存在同名的Topic,返回的status code为200,否则返回的status code为201。

URI

  • URI格式

    POST /v2/{project_id}/notifications/topics

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

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

请求消息

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    name

    String

    创建topic的名字。

    Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符。

    display_name

    String

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

    显示名的长度为192byte或64个中文。

    默认值为空。

    enterprise_project_id

    String

    企业项目ID。非必选参数,当企业项目开关打开时需要传入该参数。

    缺省值:0

  • 请求样例
    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics
    {
        "name": "test_topic_v2",
        "display_name": "testtest"
    }

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    topic_urn

    String

    Topic的唯一的资源标识,可通过查询主题列表获取该标识。

  • 响应样例
    {
        "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",
        "topic_urn": "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2"
    }

返回值

请参考返回值

错误码

请参考错误码