GetMessageDetail - 获取消息详情 - 云消息队列 RocketMQ 版

获取指定消息的详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:GetMessageDetail	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	无	无

请求语法

GET /instances/{instanceId}/topics/{topicName}/messages/{messageId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-lbj31fs790d
topicName	string	是	主题名称。	flink_test
messageId	string	是	消息 ID	0A792FDB001F7591083D30ADB1DA11D5

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	FAEBD71F-E839-52F9-BD7B-8F1290525841
success	boolean	是否成功	true
data	object	返回结果
regionId	string	区域 ID	cn-hangzhou
instanceId	string	实例 ID	rmq-cn-7e22ody****
topicName	string	主题名称	topic_test
messageId	string	消息 ID	01BE87E485F0C7808C04543CAF00000001
bornTime	string	生成时间	2023-03-22 12:17:08
storeTime	string	存储时间	2023-03-22 12:17:08
body	string	消息体	{}
bodySize	integer	消息体大小。	123
bornHost	string	消息来自哪里	xxx.xx.xxx.xx
storeHost	string	消息存储位置	xxx.xx.xxx.xx
messageType	string	消息类型	NORMAL
messageTag	string	标签列表	xx
messageGroup	string	以前的 shardingkey，顺序消息独有	xx
messageKeys	array	业务标识
messageKey	string	标识	xx
userProperties	object	用户属性
	string	用户属性	xxx
systemProperties	object	系统默认属性
	string	系统默认属性	xx
code	string	错误码	Topic.NotFound
message	string	错误信息	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "FAEBD71F-E839-52F9-BD7B-8F1290525841",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageId": "01BE87E485F0C7808C04543CAF00000001",
    "bornTime": "2023-03-22 12:17:08",
    "storeTime": "2023-03-22 12:17:08",
    "body": "{}",
    "bodySize": 123,
    "bornHost": "xxx.xx.xxx.xx",
    "storeHost": "xxx.xx.xxx.xx",
    "messageType": "NORMAL",
    "messageTag": "xx",
    "messageGroup": "xx",
    "messageKeys": [
      "xx"
    ],
    "userProperties": {
      "key": "xxx"
    },
    "systemProperties": {
      "key": "xx"
    }
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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