有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: tdmq.tencentcloudapi.com 。

创建cmq主题

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCmqTopic。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
TopicName String 主题名字,在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
示例值:xxx
MaxMsgSize Integer 消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。
示例值:0
FilterType Integer 用于指定主题的消息匹配策略。1:表示标签匹配策略;2:表示路由匹配策略,默认值为标签匹配策略。
示例值:0
MsgRetentionSeconds Integer 消息保存时间。取值范围60 - 86400 s(即1分钟 - 1天),默认值86400。
示例值:0
Trace Boolean 是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。
示例值:false
Tags.N Array of Tag 标签数组

3. 输出参数

参数名称 类型 描述
TopicId String 主题id
示例值:topic-gzz05csc
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建主题

输入示例

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCmqTopic
<公共请求参数>

{
    "TopicName": "ConnTopic"
}

输出示例

{
    "Response": {
        "TopicId": "topic-gzz05csc",
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
    }
}

示例2 示例

输入示例

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCmqTopic
<公共请求参数>

{
    "TopicName": "testtopic"
}

输出示例

{
    "Response": {
        "RequestId": "ae412902-bb35-4237-955d-3e1f9901e0cc",
        "TopicId": "cmqt-7jwedr3jqb54"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.CreateCluster 创建集群失败。
FailedOperation.CreateTopic 主题创建失败。
FailedOperation.SetRetentionPolicy 设置消息保留策略失败。
FailedOperation.SetTTL 设置消息TTL失败。
InternalError.BrokerService Broker服务异常。
LimitExceeded.Topics 实例下主题数量超过限制。
ResourceInUse 资源被占用。
ResourceInUse.Topic 重名,主题已存在。
ResourceNotFound.Environment 环境不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.CreateFailed 发货异常。
ResourceUnavailable.FundRequired 需要充值才可继续操作。