有奖:语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心

1. 接口描述

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

根据提供的 MessageID 确认指定 topic 中的消息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AcknowledgeMessage。
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 。
MessageId String 用作标识消息的唯一的ID(可从 receiveMessage 的返回值中获得)
示例值:5:7:-1
AckTopic String Topic 名字(可从 receiveMessage 的返回值中获得)这里尽量需要使用topic的全路径,即:tenant/namespace/topic。如果不指定,默认使用的是:public/default
示例值:persistent://tenant/namespace/my-topic
SubName String 订阅者的名字,可以从receiveMessage的返回值中获取到。这里尽量与receiveMessage中的订阅者保持一致,否则没办法正确ack 接收回来的消息。
示例值:my-sub

3. 输出参数

参数名称 类型 描述
ErrorMsg String 如果为“”,则说明没有错误返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:sssss
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 确认消息

输入示例

https://tdmq.tencentcloudapi.com/?Action=AcknowledgeMessage
&AckTopic=tenant/namespace/topic
&MessageId="71:12:0"
&SubName=“test-sub”
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23",
        "ErrorMsg": "xxx"
    }
}

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.TopicTypeError 请使用partition topic。
InvalidParameter.TenantNotFound 上传的 tenant name 错误。
InvalidParameter.TokenNotFound 没有获取到正确的 token。
InvalidParameterValue.TopicNotFound 上传的topic name错误。
http://www.vxiaotou.com