通过传入MessageID查询指定的死信消息
更新时间 2025-11-27 16:35:23
最近更新时间: 2025-11-27 16:35:23
接口功能介绍
通过传入MessageID查询指定的死信消息
接口约束
无
URI
GET /v3/dlq/getById
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| groupName | 是 | String | 订阅组名字 | ||
| msgId | 是 | String | 消息ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | String | 返回对象 | ||
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | ||
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| queueId | Integer | 队列ID | 0 | |
| storeSize | Integer | 存储大小,单位B | 280 | |
| queueOffset | Integer | 队列偏移量 | 0 | |
| sysFlag | Integer | 系统标记 | 0 | |
| bornTimestamp | Long | 消息生成时间戳 | 1661947215767 | |
| bornHost | String | 消息生成主机地址 | 192.168.71.1:64222 | |
| storeTimestamp | Long | 消息存储时间戳 | 1661947567107 | |
| storeHost | String | 消息存储主机地址 | 192.168.71.188:8422 | |
| msgId | String | 消息ID | C0A847BC000020E600000000000794D8 | |
| commitLogOffset | Long | 提交日志偏移量 | 496856 | |
| bodyCRC | Integer | 消息体CRC校验值 | 1335308324 | |
| reconsumeTimes | Integer | 重试次数 | 4 | |
| preparedTransactionOffset | Long | 预处理事务偏移量 | 0 | |
| topic | String | 主题名称 | %DLQ%group1 | |
| properties | Object | 消息属性 | properties | |
| messageBody | String | 消息体内容 | GZ2BfSrWuAinKs | |
| 表 properties |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| REAL_TOPIC | String | 真实主题名称 | %DLQ%group1 | |
| ORIGIN_MESSAGE_ID | String | 原始消息ID | C0A847BC000020E600000000000109F2 | |
| RETRY_TOPIC | String | 重试主题名称 | test1 | |
| UNIQ_KEY | String | 唯一标识键 | 0505948D1C9C18B4AAC29EC9A7950000 | |
| WAIT | String | 等待标记 | false | |
| DELAY | String | 延迟级别 | 5 | |
| REAL_QID | String | 真实队列ID | 0 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/dlq/getById? prodInstId=70687660456281088&groupName=group&msgId=C0A847BC000020E600000000000794D8
请求头header
无
请求体body
1
响应示例
响应成功示例
{
"returnObj":{
"data":{
"queueId":0,
"storeSize":280,
"queueOffset":0,
"sysFlag":0,
"bornTimestamp":1661947215767,
"bornHost":"192.168.71.1:64222",
"storeTimestamp":1661947567107,
"storeHost":"192.168.71.188:8422",
"msgId":"C0A847BC000020E600000000000794D8",
"commitLogOffset":496856,
"bodyCRC":1335308324,
"reconsumeTimes":4,
"preparedTransactionOffset":0,
"topic":"%DLQ%group1",
"properties":{
"REAL_TOPIC":"%DLQ%group1",
"ORIGIN_MESSAGE_ID":"C0A847BC000020E600000000000109F2",
"RETRY_TOPIC":"test1",
"UNIQ_KEY":"0505948D1C9C18B4AAC29EC9A7950000",
"WAIT":"false",
"DELAY":"5",
"REAL_QID":"0"
},
"messageBody":"GZ2BfSrWuAinKs"
}
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
