DeleteConsumerGroup - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Deletes a specified consumer group.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

After you delete a consumer group, the consumer client associated with the consumer group cannot consume messages. Exercise caution when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:DeleteConsumerGroup	delete	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	none	none

Request syntax

DELETE /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance from which you want to delete the consumer group.	rmq-cn-7e22ody****
consumerGroupId	string	Yes	The ID of the consumer group.	CID-TEST

Response parameters

Parameter	Type	Description	Example
	object	The response object.
requestId	string	The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indicates whether the call is successful.	true
data	boolean	The result data that is returned.	true
code	string	The error code.	InvalidConsumerGroupId
message	string	The error message.	Parameter consumerGroupId is invalid.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	ConsumerGroupId
dynamicMessage	string	The dynamic error message.	consumerGroupId

Examples

Sample success responses

JSONformat

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history