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

文档中心

立即注册

导航

DeleteGroups - 批量删除消费组

最近更新时间：2025.03.27 14:43:19首次发布时间：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
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidGroup.NotFound	The specified group does not exist.	Group不存在。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。