1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
新增指定分区、类型的消息主题
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTopic。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EnvironmentId | 是 | String | 环境(命名空间)名称。 示例值:default |
TopicName | 是 | String | 主题名,不支持中字以及除了短线和下划线外的特殊字符且不超过64个字符。 示例值:test_topic |
Partitions | 是 | Integer | 入参为1,即是创建非分区topic,无分区;入参大于1,表示分区topic的分区数,最大不允许超过32。 示例值:2 |
ClusterId | 是 | String | Pulsar 集群的ID 示例值:pulsar-xxx |
Remark | 否 | String | 备注,128字符以内。 示例值:2个分区的普通消息队列 |
TopicType | 否 | Integer | 该入参将逐步弃用,可切换至PulsarTopicType参数 0: 普通消息; 1 :全局顺序消息; 2 :局部顺序消息; 3 :重试队列; 4 :死信队列。 示例值:TopicType 和 PulsarTopicType 两者不能同时为空,有一个必选 |
PulsarTopicType | 否 | Integer | Pulsar 主题类型 0: 非持久非分区 1: 非持久分区 2: 持久非分区 3: 持久分区 示例值:TopicType 和 PulsarTopicType 两者不能同时为空,有一个必选 |
MsgTTL | 否 | Integer | 未消费消息过期时间,单位:秒,取值范围:60秒~15天。 示例值:60 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EnvironmentId | String | 环境(命名空间)名称。 示例值:default |
TopicName | String | 主题名。 示例值:test_topic |
Partitions | Integer | 0或1:非分区topic,无分区;大于1:具体分区topic的分区数。(存量非分区主题返回0,增量非分区主题返回1) 示例值:2 |
Remark | String | 备注,128字符以内。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2个分区的普通消息队列 |
TopicType | Integer | 0: 普通消息; 1 :全局顺序消息; 2 :局部顺序消息; 3 :重试队列; 4 :死信队列; 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建主题
创建主题
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTopic
<公共请求参数>
{
"EnvironmentId": "abc",
"TopicName": "abc",
"Partitions": 1,
"Remark": "abc",
"TopicType": 1,
"ClusterId": "abc",
"PulsarTopicType": 0,
"MsgTTL": 1
}
输出示例
{
"Response": {
"EnvironmentId": "default",
"TopicName": "test_topic",
"Partitions": 2,
"TopicType": 0,
"Remark": "2个分区的普通消息队列",
"RequestId": "d9686bf9-8d7d-4e78-bb44-5140d70a1ffa"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | CAM鉴权不通过。 |
FailedOperation | 操作失败。 |
FailedOperation.CreateTopic | 主题创建失败。 |
InternalError.SystemError | 系统错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidParams | 参数值不在允许范围内。 |
LimitExceeded.Topics | 实例下主题数量超过限制。 |
MissingParameter.NeedMoreParams | 必要参数没有传递。 |
ResourceInUse | 资源被占用。 |
ResourceInUse.Topic | 重名,主题已存在。 |
ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |
ResourceNotFound.Environment | 环境不存在。 |
ResourceUnavailable.FundRequired | 需要充值才可继续操作。 |