Updated on 2025-09-03 GMT+08:00

Deleting Consumer Offset in a Specified Topic

Function

This API is used to delete consumer offset in a specified topic.

URI

POST /v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/delete-offset

Table 1 Path Parameters

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

topics

No

Array of strings

Topic list

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topics

Array of DeleteConsumerGroupOffsetsResponseEntity objects

Result list.

Table 4 DeleteConsumerGroupOffsetsResponseEntity

Parameter

Type

Description

name

String

Topic name

success

Boolean

Whether the consumer offset is deleted.

error_code

String

Error code.

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.