创建主题
功能介绍
创建Topic，单用户默认配额为3000。高并发场景下，可能会出现Topic数量超过3000仍创建成功的情况，此为正常现象。 接口是幂等的，接口调用返回成功时，若已存在同名的Topic，返回的status code为200，否则返回的status code为201
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/notifications/topics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取项目ID请参考 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度为1到255个字符。 最小长度：1 最大长度：255 |
|
display_name |
是 |
String |
Topic的显示名，推送邮件消息时，作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。 最小长度：1 最大长度：192 |
|
enterprise_project_id |
否 |
String |
企业项目ID。非必选参数，当企业项目开关打开时需要传入该参数。 缺省值：0 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
topic_urn |
String |
Topic的唯一的资源标识，可通过查询主题列表获取该标识。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求的唯一标识ID。 |
|
code |
String |
服务异常错误信息编码。 |
|
message |
String |
服务异常错误信息描述。 |
请求示例
创建名称为test_topic_v2，且显示名为testtest的主题
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics
{
"name" : "test_topic_v2",
"display_name" : "testtest"
}
响应示例
状态码： 201
OK
{
"request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
"topic_urn" : "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
OK |
|
400 |
Bad Request |
|
403 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
