文档中心>消息队列 Pulsar 版

创建RocketMQ Router规则

最近更新时间:2026-05-09 09:53:13

我的收藏

1. 接口描述

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

创建RocketMQ Router规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRocketMQRouterRule。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
StartNow Boolean

true: 立即启动任务
false: 创建任务后不立即启动,可以在控制台操作启动


示例值:true
Rule RocketMQRouterRuleInfo

规则数据结构

SyncType String

数据同步类型。
Topic:按照topic维度同步


示例值:Topic

3. 输出参数

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

4. 示例

示例1 创建从MQTT到RocketMQ集群的Topic数据复制任务

创建从MQTT到RocketMQ集群的Topic数据复制任务

输入示例

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

{
    "StartNow": true,
    "Rule": {
        "SourceType": "TENCENT_MQTT",
        "TargetType": "TENCENT_ROCKETMQ",
        "RemarkName": "test-rmq-mqtt-sync",
        "TenRocketMQTarget": {
            "Topic": "true",
            "ClusterId": "rmq-16vjxq59j2",
            "TargetRegion": "ap-chengdu",
            "RoleName": "test_ben",
            "AccessKey": "testak16vcb04be9d04",
            "SecretKey": "testskca1f0368ee4"
        },
        "TenMQTTSource": {
            "ClusterId": "mqtt-embkr9ar",
            "Topic": "mqtt-topic-6",
            "SourceRegion": "ap-chengdu",
            "UserName": "dev-user",
            "Password": "123qweASD123",
            "Endpoint": "mqtt-embkr9ar-gz-internal.mqtt.tencenttdmq.com:1883"
        }
    },
    "SyncType": "Topic"
}

输出示例

{
    "Response": {
        "RequestId": "46d960fa-5761-41ae-b908-4d023c7d3511"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.RoleNoSyncPermission 角色权限不足。
FailedOperation.RouterRule 操作复制任务失败