OnsMessageGetByKey
根据 Topic 和 Message Key 模糊查询消息信息列表
服务地址：
华东1 金融云
输入参数
只看必填
Topic需查询的消息的Topic
Key需查询的消息的Message Key
InstanceId需查询的消息所对应的实例ID
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

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

  • 使用本接口根据 Message Key 查询消息的方式属于模糊查询。由于业务方的 Key 可能不唯一，所以查询结果可能为多条。

  • 本接口用在业务方无法获取 Message ID 的场景，在该场景下的调用步骤如下所示：

    1. 调用本接口模糊查询得到 Message ID 列表。

    2. 调用 OnsMessageGetByMsgId 接口精确查询。OnsMessageGetByMsgId 接口的详细信息，请参见 OnsMessageGetByMsgId 。

请求参数

字段名称字段详情
Topicstring

需查询的消息的 Topic。

示例值:test-mq_topic参考取值来源:
    OnsTopicList
Keystring

需查询的消息的 Message Key。

示例值:messageKey1
InstanceIdstring

需查询的消息所对应的实例 ID。

示例值:MQ_INST_111111111111_DOxxxxxx参考取值来源:
    OnsInstanceBaseInfo

返回参数

字段名称字段详情
RequestIdstring

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

示例值:A07E3902-B92E-44A6-B6C5-6AA111111****
Dataobject
变更历史
暂无变更历史