消息队列 Pulsar 版
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 消息队列 Pulsar 版

发送单条消息

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

我的收藏

本页目录：

1. 接口描述

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

发送单条消息
不支持持久topic

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SendMessages。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, na-toronto 。
Topic 是 String 消息要发送的topic的名字, 这里尽量需要使用topic的全路径，即：tenant/namespace/topic。如果不指定，默认使用的是：public/default
示例值：persistent://tenant/namespaces/my-topic
Payload 是 String 要发送的消息的内容
示例值：hello tdmq
StringToken 否 String Token 是用来做鉴权使用的，可以不填，系统会自动获取
示例值：abcdefghijklmnopqrstovwxyz
ProducerName 否 String 设置 producer 的名字，要求全局唯一。该参数建议用户无需手动配置，此时系统会随机生成，如果手动设置有可能会造成创建 Producer 失败进而导致消息发送失败。
该参数主要用于某些特定场景下，只允许特定的 Producer 生产消息时设置，用户的大部分场景使用不到该特性。
示例值：producer
SendTimeout 否 Integer 设置消息发送的超时时间，默认为30s
示例值：30
MaxPendingMessages 否 Integer 内存中缓存的最大的生产消息的数量，默认为1000条
示例值：1000

3. 输出参数

参数名称 类型 描述
MessageId String 消息的messageID, 是全局唯一的，用来标识消息的元数据信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Response":{"MessageId":"26365:1475:0"}}
ErrorMsg String 返回的错误消息，如果返回为 “”，说明没有错误
注意：此字段可能返回 null，表示取不到有效值。
示例值：""
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功发送单条消息

成功发送单条消息
不支持非持久化topic

输入示例

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

{
    "Topic": "tenant/namespace/topic",
    "Payload": "\"hello TDMQ\""
}

输出示例

{
    "Response": {
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23",
        "MessageId": "71:11:0:0",
        "ErrorMsg": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateProducerError 创建producer出错。
FailedOperation.CreatePulsarClientError 创建TDMQ client的出错。
FailedOperation.MaxMessageSizeError 最大消息超过1MB。
FailedOperation.MessageIDError 上传的msgID错误。
FailedOperation.ReceiveError 接收消息出错。
FailedOperation.ReceiveTimeout 接收消息超时，请重试。
FailedOperation.SendMessageTimeoutError 消息发送超时。
FailedOperation.TopicTypeError 请使用partition topic。
InvalidParameter.TenantNotFound 上传的 tenant name 错误。
InvalidParameter.TokenNotFound 没有获取到正确的 token。
InvalidParameterValue.TopicNotFound 上传的topic name错误。
中国站