Deleting Consumer Offset in a Specified Topic
Function
This API is used to delete consumer offset in a specified topic.
Calling Method
For details, see Calling APIs.
URI
POST /v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/delete-offset
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
|
instance_id |
Yes |
String |
Instance ID. |
|
group |
Yes |
String |
Consumer group ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
topics |
No |
Array of strings |
Topic list |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
topics |
Array of DeleteConsumerGroupOffsetsResponseEntity objects |
Result list. |
Example Requests
/v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/delete-offset
{
"topics" : [ "topic-1", "topic-2" ]
}
Example Responses
Status code: 200
Deleted.
{
"topics" : [ {
"name" : "topic-1",
"success" : true
}, {
"name" : "topic-2",
"success" : true
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Deleted. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.