文档

OnsMessageDetail - 查询消息详细信息

更新时间:
一键部署

调用OnsMessageDetail查询某条消息的具体信息。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

云消息队列 RocketMQ 版实例 ID。

MQ_INST_184681981******_BXig0x6A
Topicstring

需查询的消息的 Topic 名称。

test-mq_topic
MsgIdstring

需查询的消息的 ID,即 Message ID。

1E0578FE110F18B4AAC235C0******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

EAE5BE23-37A1-4354-94D6-E44AE17E****
Dataobject

查询结果。

StoreSizeinteger

消息大小。单位:KB。

2
ReconsumeTimesinteger

消息重试消费的次数。

0
StoreTimestamplong

消息被服务端存储的时间戳。单位:毫秒。

1570761026708
Bodystring

消息体内容经过 Base 64 算法加密后的字符串。

aGVsbG8=
InstanceIdstring

云消息队列 RocketMQ 版实例 ID。

MQ_INST_184681981******_BXig0x6A
MsgIdstring

消息 ID,即 Message ID。

1E0578FE110F18B4AAC235C05F2*****
StoreHoststring

存储该消息的服务器实例。

11.220.***.***:10911
Topicstring

消息所属的 Topic。

test-mq_topic
PropertyListobject []

消息属性列表。

Valuestring

消息属性的取值。

MSG_REGION
Namestring

消息属性。取值说明如下:

  • TRACE_ON:是否有消息轨迹。
  • MSG_REGION:消息的 Topic 所属实例的地域 ID。
  • __MESSAGE_DECODED_TIME:消息被解码的时间。
  • __BORNHOST:消息生产者客户端的 IP 地址。
  • UNIQ_KEY:消息的唯一标识,即 Message ID。

更多概念信息请参见名词解释

cn-hangzhou
BornTimestamplong

消息生成的时间戳。单位:毫秒。

1570761026630
BodyCRCinteger

消息体 CRC 校验值。

907060870
BornHoststring

生成该消息的客户端实例。

42.120.**.**:64646
BodyStrstring

消息体内容。

hello

示例

正常返回示例

JSON格式

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "StoreSize": 2,
    "ReconsumeTimes": 0,
    "StoreTimestamp": 1570761026708,
    "Body": "aGVsbG8=",
    "InstanceId": "MQ_INST_184681981******_BXig0x6A",
    "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": [
      {
        "Value": "MSG_REGION",
        "Name": "cn-hangzhou"
      }
    ],
    "BornTimestamp": 1570761026630,
    "BodyCRC": 907060870,
    "BornHost": "42.120.**.**:64646",
    "BodyStr": "hello"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈