You can call this operation to delete a consumer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteConsumerGroup

The operation that you want to perform. Set the value to DeleteConsumerGroup.

ConsumerId String Yes CID-test

The name of the consumer group. The value of this parameter must meet the following requirements:

  • The name can only contain letters, digits, hyphens (-), and underscores (_).
  • The name must be 3 to 64 characters in length, and will be automatically truncated if it contains more characters.
  • The name cannot be modified after being created.
InstanceId String Yes alikafka_post-cn-v0h1fgs2****

The ID of the Message Queue for Apache Kafka instance where the consumer group is located.

RegionId String Yes cn-hangzhou

The region ID of the Message Queue for Apache Kafka instance where the consumer group is located.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned status code. If "200" is returned, the request is successful.

Message String operation success.

The returned message.

RequestId String 06084011-E093-46F3-A51F-4B19A8AD****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DeleteConsumerGroup
&ConsumerId=CID-test
&InstanceId=alikafka_post-cn-v0h1fgs2****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<Message>operation success. </Message>
<RequestId>06084011-E093-46F3-A51F-4B19A8AD7A94</RequestId>
<Success>true</Success>
<Code>200</Code>

JSON format

{
    "Message": "operation success.",
    "RequestId": "06084011-E093-46F3-A51F-4B19A8AD7A94",
    "Success": true,
    "Code": 200
}

Error codes

HTTP status code Error code Error message Description
500 InternalError An internal error occurred; please try again later. The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.