导出RocketMQ消息详情

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

我的收藏

1. 接口描述

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

导出RocketMQ消息详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ExportRocketMQMessageDetail。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群id 示例值：rocketmq-xxx
EnvironmentId	是	String	应用命名空间示例值：xxx
TopicName	是	String	Topic名称如果是死信消息 isDlqMsg=true 示例值：xxx
MsgId	是	String	消息id 示例值：xxx
IncludeMsgBody	是	Boolean	是否包含消息体示例值：false
DeadLetterMsg	否	Boolean	是否死信消息示例值：false

3. 输出参数

参数名称	类型	描述
MsgId	String	消息id 示例值：xxx
BornTimestamp	Integer	消息生成时间戳注意：此字段可能返回 null，表示取不到有效值。示例值：2021-11-23 21:21:26
StoreTimestamp	Integer	消息存储时间戳注意：此字段可能返回 null，表示取不到有效值。示例值：2021-11-23 21:21:26
BornHost	String	消息生产客户端地址注意：此字段可能返回 null，表示取不到有效值。
MsgTag	String	消息Tag 注意：此字段可能返回 null，表示取不到有效值。
MsgKey	String	消息Key 注意：此字段可能返回 null，表示取不到有效值。
Properties	String	消息属性注意：此字段可能返回 null，表示取不到有效值。示例值：{"xxx":"aaa"}
ReConsumeTimes	Integer	消息重试次数注意：此字段可能返回 null，表示取不到有效值。示例值：0
MsgBody	String	Base64编码格式字符串注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
MsgBodyCRC	Integer	消息内容的CRC32 Code 注意：此字段可能返回 null，表示取不到有效值。示例值：0
MsgBodySize	Integer	消息体大小（单位K）当大于2048时不返回消息示例值：1024
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 demo

导出消息详情

输入示例

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

{
    "ClusterId": "xx",
    "EnvironmentId": "xx",
    "TopicName": "xx",
    "MsgId": "xx",
    "DeadLetterMsg": true,
    "IncludeMsgBody": true
}

输出示例

{
    "Response": {
        "MsgId": "xx",
        "BornTimestamp": 0,
        "StoreTimestamp": 0,
        "BornHost": "xx",
        "MsgTag": "xx",
        "MsgKey": "xx",
        "Properties": "xx",
        "ReConsumeTimes": 1,
        "MsgBody": "xx",
        "MsgBodyCRC": 0,
        "MsgBodySize": 1,
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.FailedOperation	操作失败。
ResourceNotFound.Cluster	集群不存在。

下一篇: 更新历史