向指定的消費者推送消息
更新時間 2025-09-25 18:19:56
最近更新時間: 2025-09-25 18:19:56
分享文章
接口功能介紹
向指定的消費者推送消息
接口約束
無
URI
POST /v3/message/push
路徑參數 無
Query參數 無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池編碼 | 100054c0416811e9a6690242ac110002 |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 實例ID | ||
| msgId | 是 | String | 消息的offsetMsgId | ||
| groupName | 是 | String | 訂閱組名字 | ||
| clientId | 是 | String | 客戶端ID |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 接口系統層面狀態碼。成功:800,失敗:900 | 800 | |
| message | String | 描述狀態 | ||
| returnObj | String | 返回對象。此參數所包含的參數請見“響應示例'里面的注釋 | ||
| error | String | 錯誤碼,只有非成功才有這個字段,方便快速定位問題 | 201 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{
"prodInstId":"mq_test",
"msgId":"C0A847BC000020E60000000000003FEE",
"groupName":"group",
"clientId":"5.5.148.141@test_instance"
}
響應示例
響應成功示例
{
"returnObj":{
},
"message":"success",
"statusCode":800
}
響應失敗示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
狀態碼
請參考
錯誤碼
請參考