创建主题

最近更新时间:2019-05-09 16:53:03

接口描述

本接口 (CreateTopic) 用于在用户账户下创建一个新主题。

  • 外网接口请求域名:https://cmq-topic-{$region}.api.qcloud.com
  • 内网接口请求域名:http://cmq-topic-{$region}.api.tencentyun.com

上述域名中的{$region}需用具体地域替换:gz(广州),sh(上海),bj(北京),shjr(上海金融),szjr(深圳金融),hk(香港),cd(成都),ca(北美),usw(美西),sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。

注意:

任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 是否必选 类型 描述
topicName String 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
maxMsgSize Int 消息最大长度。取值范围1024 - 65536 Byte(即1 - 64K),默认值65536。
filterType Int 用于指定主题的消息匹配策略:
filterType =1 或为空, 表示该主题下所有订阅使用 filterTag 标签过滤;
filterType =2 表示用户使用 bindingKey 过滤。
注意:该参数设定之后不可更改。

输出参数

参数名称 类型 描述
code Int 0:表示成功,others:错误,详细错误见下表。
message String 错误提示信息。
requestId String 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。
topicId String 主题的唯一标识 ID。但是注意,云 API 接口都是通过名字而非 ID 去调用的。

错误码

请查看 公共错误码

示例

输入:

 https://domain/v2/index.php?Action=CreateTopic
 &topicName=test-topic-123
 &<公共请求参数>

输出:

{
"code" : 0,
"message" : "",
"requestId":"14534664555",
"topicId":"topic-ajksdfasdowe"
}