接口介绍
对订阅组进行创建操作。
接口约束
无。
URl
POST https://[endpoint]/v2/group/create
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | body | String | 实例ID |
brokerNameList | 是 | body | List<String> | Broker名字列表 |
subscriptionGroupConfig | 是 | body | SubscriptionGroupConfig | 订阅组配置 |
groupName | 是 | subscriptionGroupConfig | String | 订阅组名字 |
consumeEnable | 是 | subscriptionGroupConfig | boolean | 是否允许消费。默认是true |
firstConsumeMechanism | 是 | subscriptionGroupConfig | String | 首次消费位置 1：客户端指定 2：第一条 3：最新位置 |
pullMechanism | 是 | subscriptionGroupConfig | String | 消费机制，目前填“1” |
响应参数
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
请求示例
POST https://[endpoint]/v2/group/create
{
"subscriptionGroupConfig":{
"consumeEnable":true,
"firstConsumeMechanism":"1",
"groupName":"group2",
"pullMechanism":"1"
},
"brokerNameList":[
"mq_test_broker_1"
],
"prodInstId":"mq_test"
}
响应成功示例
{
"returnObj":{
},
"message":"success",
"statusCode":800
}响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}