Chen, Junjie 7f68b84da4 DMS API-REF Initial Version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2022-12-08 00:34:44 +00:00

7.2 KiB

Raw Permalink Blame History

Batch Cleaning Up Topics of a Kafka Instance

Function

This API is used to clean up multiple topics of a Kafka instance in batches.

URI

POST /v2/kafka/{project_id}/instances/{instance_id}/topics/cleanup

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
topics	No	Array of strings	List of topics to be cleared up.

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 cleanup was successful.

Example Requests

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

{
  "topics" : [ "topic_1", "topic_2" ]
}

Example Responses

Status code: 200

The cleanup is successful.

{
  "topics" : [ {
    "id" : "topic_1",
    "success" : true
  }, {
    "id" : "topic_2",
    "success" : true
  } ]
}

Status Codes

Status Code	Description
200	The cleanup is successful.

Error Codes

See Error Codes.

Parent topic: Topic Management

7.2 KiB Raw Permalink Blame History