取得指定訊息的詳細資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rocketmq:GetMessageDetail |
get |
*Topic
|
無 | 無 |
請求文法
GET /instances/{instanceId}/topics/{topicName}/messages/{messageId} HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| instanceId |
string |
是 |
執行個體 ID。 |
rmq-cn-lbj31fs790d |
| topicName |
string |
是 |
主題名稱。 |
flink_test |
| messageId |
string |
是 |
訊息 ID。 |
0A792FDB001F7591083D30ADB1DA11D5 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
當前API無需請求參數
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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 |
業務識別碼。 |
|
|
string |
識別碼。 |
xx |
|
| userProperties |
object |
使用者屬性。 |
|
|
string |
使用者屬性。 |
xxx |
|
| systemProperties |
object |
系統預設屬性。 |
|
|
string |
系統預設屬性。 |
xx |
|
| liteTopicName |
string |
輕量主題名稱。 |
abc |
| priority |
integer |
優先順序。 |
7 |
| 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"
},
"liteTopicName": "abc",
"priority": 7
},
"code": "Topic.NotFound",
"message": "Parameter instanceId is mandatory for this action .",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。