Help Center/ Distributed Message Service for Kafka/ API Reference (Paris Region)/ APIs V2 (Recommended)/ Topic Management/ Batch Deleting Topics of a Kafka Instance
Updated on 2023-08-29 GMT+08:00
View PDF
Share

Batch Deleting Topics of a Kafka Instance

Function

This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.

URI

POST /v2/{project_id}/instances/{instance_id}/topics/delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

topics

No

Array of strings

List of topics to delete.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

topics

Array of topics objects

Topic list.
Table 4 topics

Parameter

Type

Description

id

String

Topic name.

success

Boolean

Whether the topics are deleted.

Example Requests

Batch deleting topics

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete

{
  "topics" : [ "topic01" ]
}

Example Responses

Status code: 200

The deletion is successful.

{
  "topics" : [ {
    "id" : "haha",
    "success" : true
  }, {
    "id" : "aabb",
    "success" : true
  } ]
}

Status Codes

Status Code

Description

200

The deletion is successful.

Error Codes

See Error Codes.

Parent topic: Topic Management