DeleteGroups - 批量删除消费组--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DeleteGroups - 批量删除消费组

最近更新时间：2024.11.18 10:27:32首次发布时间：2024.03.20 15:05:24

调用 DeleteGroups 接口，批量删除消费组（ConsumerGroup）。

使用说明

本接口会删除实例下的消费组，删除后不可恢复，请谨慎调用。

注意事项

请求频率：该接口请求频率限制为 10 次/秒；单用户请求频率限制为 2 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DeleteGroups	要执行的操作，取值：DeleteGroups。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GroupsId	Array of String	是	["GID_test1","GID_test2"]	待删除的消费组 ID。需要删除多个消费组时，使用英文逗号（,）分隔。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	待删除消费组所属的实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=DeleteGroups&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "GroupsId": ["GID_test1","GID_test2"]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240320142749F53941CE66639E4***",
        "Action": "DeleteGroups",
        "Version": "2023-01-01",
        "Service": "rocketmq",
        "Region": "cn-shanghai"
    },
    "Result": null
}

错误码

公共错误码请参见公共错误码文档。