更新时间：2023-08-16 GMT+08:00
创建消费组或批量删除消费组
功能介绍
创建消费组或批量删除消费组。
URI
POST /v2/{project_id}/instances/{instance_id}/groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，获取方式请参见获取项目ID。 |
| instance_id | 是 | String | 实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| action | 否 | String | 批量删除消费组时使用，不配置则为创建接口。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| groups | 否 | Array of strings | 待删除的消费组列表。 |
| enabled | 否 | Boolean | 是否可以消费。 |
| broadcast | 否 | Boolean | 是否广播。 |
| brokers | 否 | Array of strings | 关联的代理列表。 |
| name | 否 | String | 消费组名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。 |
| retry_max_time | 否 | Number | 最大重试次数。 |
| from_beginning | 否 | Boolean | 是否重头消费。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 删除消费组的任务ID |
| name | String | 创建成功的消费组名称。 |
请求示例
-
创建一个消费组，关联的代理为broker-0，最大重试次数为16。
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups { "name" : "consumer-group-test", "brokers" : [ "broker-0" ], "from_beginning" : false, "broadcast" : false, "retry_max_time" : 16 } -
删除指定的消费组。
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?action=delete { "groups" : [ "consumer-group-test" ] }
响应示例
状态码： 200
创建消费组或批量删除消费组成功。
{
"name" : "consumer-group-test"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建消费组或批量删除消费组成功。 |
错误码
请参见错误码。
父主题： 消费组管理
