根据 Topic 和 Key 查询 Message 列表 - QueryURocketMQMessageByKey
简介
根据 Topic 和 Key 查询消息列表
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 QueryURocketMQMessageByKey | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes |
| ProjectId | string | 项目ID。 请参考GetProjectList接口 | Yes |
| ServiceId | string | Service ID | Yes |
| Key | string | Message Key（向Topic发送消息时自定义的Key） | Yes |
| TopicName | string | Topic 名称 | Yes |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| MessageList | array[MessageBaseInfo] | message列表 | Yes |
数据模型
MessageBaseInfo
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Properties | MessageProperties | Message属性 | No |
| MsgId | string | MessageID | No |
| Topic | string | Topic名称 | No |
| StoreTimestamp | int | 保存时间戳 | No |
MessageProperties
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| TAGS | string | Message 的 Tag | Yes |
| KEYS | string | Message 的 Key | Yes |
示例
请求示例
https://api.an-link.com/?Action=QueryURocketMQMessageByKey
&Region=cn-zj
&ProjectId=yrOlxXJt
&ServiceId=diLaCmkF
&TopicId=Bqknnywq
&Key=wIafuUhk响应示例
{
"Action": "QueryURocketMQMessageByKeyResponse",
"Message": "hytmeMHy",
"MessageList": [
{
"MsgId": "srzxKsNQ",
"Properties": "tyTRrRcn",
"StoreTimestamp": 8,
"Topic": "JqggGOym"
}
],
"RetCode": 0
}