文档中心>API 中心

查询Pulsar消息详情

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

我的收藏

1. 接口描述

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

消息详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMsg。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
EnvironmentId String 环境(命名空间)名称。
示例值:default
MsgId String 消息ID。
示例值:16836:8:-1
TopicName String 主题名。
示例值:msg_dev
ClusterId String Pulsar 集群的ID
示例值:test

3. 输出参数

参数名称 类型 描述
Properties String 消息属性。
示例值:test
Body String 消息体。
示例值:i just a10 testing!
BatchId String 批次ID。
示例值:1
ProduceTime String 生产时间。
示例值:2020-08-18 18:47:41
MsgId String 消息ID。
示例值:16836:8:-1
ProducerName String 生产者名称。
示例值:fisrtProducer
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取消息详情

输入示例

https://tdmq.tencentcloudapi.com/?Action=DescribeMsg
&EnvironmentId=default
&TopicName=msg_dev
&MsgId=16836:8:-1
&<公共请求参数>

输出示例

{
    "Response": {
        "Properties": "{\"publish-time\": \"1597747661679\", \"X-Pulsar-num-batch-message\": \"1\", \"MESSAGE_ID\": \"16836:8:-1\", \"X-Pulsar-producer-name\": \"fisrtProducer\", \"bookies-address\": \"9.139.220.16:3181#9.139.220.8:3181\"}",
        "Body": "i just a10 testing!",
        "BatchId": "1",
        "ProduceTime": "2020-08-18 18:47:41",
        "MsgId": "16836:8:-1",
        "ProducerName": "fisrtProducer",
        "RequestId": "msgs"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue.InvalidParams 参数值不在允许范围内。
MissingParameter.NeedMoreParams 必要参数没有传递。
ResourceNotFound.BrokerCluster 服务的集群不存在。
ResourceNotFound.Cluster 集群不存在。
ResourceNotFound.Environment 环境不存在。
ResourceNotFound.Msg 找不到指定消息。
ResourceNotFound.Topic 主题不存在。