消息队列 Pulsar 版
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 消息队列 Pulsar 版

创建cmq订阅接口

最近更新时间：2024-03-12 01:53:53

我的收藏

本页目录：

1. 接口描述

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

创建cmq订阅接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCmqSubscribe。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
TopicName 是 String 主题名字，在单个地域同一账号下唯一。主题名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线（-）。
示例值：ConnTopic
SubscriptionName 是 String 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
示例值：ConnSubQueue
Protocol 是 String 订阅的协议，目前支持两种协议：http、queue。使用http协议，用户需自己搭建接受消息的web server。使用queue，消息会自动推送到CMQ queue，用户可以并发地拉取消息。
示例值：queue
Endpoint 是 String 接收通知的Endpoint，根据协议Protocol区分：对于http，Endpoint必须以“http://”开头，host可以是域名或IP；对于Queue，则填QueueName。 请注意，目前推送服务不能推送到私有网络中，因此Endpoint填写为私有网络域名或地址将接收不到推送的消息，目前支持推送到公网和基础网络。
示例值：queue_sub
NotifyStrategy 否 String 向Endpoint推送消息出现错误时，CMQ推送服务器的重试策略。取值有：1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始1s，后面是2s，4s，8s...由于Topic消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是EXPONENTIAL_DECAY_RETRY。
示例值：xxx
FilterTag.N 否 Array of String 消息正文。消息标签（用于消息过滤)。标签数量不能超过5个，每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用，规则：1）如果FilterTag没有设置，则无论MsgTag是否有设置，订阅接收所有发布到Topic的消息；2）如果FilterTag数组有值，则只有数组中至少有一个值在MsgTag数组中也存在时（即FilterTag和MsgTag有交集），订阅才接收该发布到Topic的消息；3）如果FilterTag数组有值，但MsgTag没设置，则不接收任何发布到Topic的消息，可以认为是2）的一种特例，此时FilterTag和MsgTag没有交集。规则整体的设计思想是以订阅者的意愿为主。
BindingKey.N 否 Array of String BindingKey数量不超过5个， 每个BindingKey长度不超过64字节，该字段表示订阅接收消息的过滤策略，每个BindingKey最多含有15个“.”， 即最多16个词组。
NotifyContentFormat 否 String 推送内容的格式。取值：1）JSON；2）SIMPLIFIED，即raw格式。如果Protocol是queue，则取值必须为SIMPLIFIED。如果Protocol是http，两个值均可以，默认值是JSON。
示例值：xxx

3. 输出参数

参数名称 类型 描述
SubscriptionId String 订阅id
示例值：subsc-39gyuuhd
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建订阅接口

输入示例

https://tdmq.tencentcloudapi.com/?Action=CreateCmqSubscribe
&TopicName=ConnTopic
&SubscriptionName=ConnSubQueue
&Protocol=queue
&Endpoint=queue_sub
&<公共请求参数>

输出示例

{
    "Response": {
        "SubscriptionId": "subsc-39gyuuhd",
        "RequestId": "1620b635-6071-47c7-ac1e-975afe5104a7"
    }
}

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.CreateSubscription 创建订阅关系失败。
FailedOperation.CreateTopic 主题创建失败。
ResourceInUse 资源被占用。
ResourceInUse.Subscription 重名，订阅关系已存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.FundRequired 需要充值才可继续操作。
中国站