首页 消息队列RocketMQ版 4.0系列实例文档 API参考指南 API目录 消息 OnsMessageDetail - 查询消息详细信息

OnsMessageDetail - 查询消息详细信息

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:QueryMessageDetailRead
  • Ons
    acs:mq:{#regionId}:{#accountId}:{#TopicName}
  • Ons
    acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
    无
无

请求参数

名称类型必填描述示例值
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
PropertyListarray

消息属性列表。

object
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"
  }
}

错误码

访问错误中心查看更多错误码。
阿里云首页 消息队列 MQ 相关技术圈