创建订阅组
更新时间 2025-11-21 17:14:29
最近更新时间: 2025-11-21 17:14:29
接口功能介绍
创建消费组
接口约束
无
URI
POST /v3/group/create
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | mq_test | |
| brokerNameList | 是 | Array of Strings | Broker名称列表 | ["broker_1"] | |
| subscriptionGroupConfig | 是 | Object | 订阅组配置信息 | subscriptionGroupConfig | |
| 表 subscriptionGroupConfig |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| consumeEnable | 是 | Boolean | 是否允许消费 | true | |
| firstConsumeMechanism | 是 | String | 首次消费机制 | 1 | |
| groupName | 是 | String | 订阅组名称 | group2 | |
| pullMechanism | 是 | String | 拉取机制 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功："800"，失败："900"。 | 800 | |
| message | String | 描述状态。 | ||
| returnObj | Object | 返回对象。 | ||
| error | String | 错误码，描述错误信息。 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/group/create
请求头header
无
请求体body
{
"subscriptionGroupConfig": {
"firstConsumeMechanism": 1,
"groupName": "groupTest",
"consumeEnable": true,
"pullMechanism": 1
},
"prodInstId": "d7ed2dbad63843f4bcb3b9dc0955a617",
"brokerNameList": [
"broker_1"
]
}
响应示例
响应成功示例
{
"message": "success",
"returnObj": {},
"statusCode": 800
}
响应失败示例
{
"error": "ROCKETMQ_2002",
"message": "Subscription Group[groupTest] is existed in broker[broker_1]",
"returnObj": {},
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
