向指定的消费者推送消息
更新时间 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"
}
状态码
请参考 状态码
错误码
请参考 错误码