Modifying Topics of a Kafka Instance¶

Function¶

This API is used to modify topics of a Kafka instance.

URI¶

PUT /v2/{project_id}/instances/{instance_id}/topics

**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.
instance_id	Yes	String	Instance ID.

Request Parameters¶

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
topics	No	Array of topics objects	Topics that were modified.

**Table 3** topics¶
Parameter	Mandatory	Type	Description
id	Yes	String	Topic name, which cannot be modified.
retention_time	No	Integer	Aging time in hour.
sync_replication	No	Boolean	Whether synchronous replication is enabled.
sync_message_flush	No	Boolean	Whether synchronous flushing is enabled.
new_partition_numbers	No	Integer	Number of the partitions.
new_partition_brokers	No	Array of integers	Specifying brokers for new partitions.
topic_other_configs	No	Array of topic_other_configs objects	Topic configuration.
topic_desc	No	String	Topic description.

**Table 4** topic_other_configs¶
Parameter	Mandatory	Type	Description
name	No	String	Configuration name.
value	No	String	Configuration value.

Response Parameters¶

None

Example Requests¶

Modifying parameters of topic-1284340884. Specifically, change the aging time to 72 hours, the number of partitions to 6, timestamp to LogAppendTime, max. batch size to 10485760, specify new partitions on broker-1 and broker-2, and disable synchronous replication and flushing.

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics

{
  "topics" : [ {
    "id" : "test01",
    "retention_time" : 72,
    "sync_replication" : false,
    "sync_message_flush" : false,
    "new_partition_numbers" : 6,
    "new_partition_brokers" : [ 1, 2 ],
    "topic_other_configs" : [ {
      "name" : "message.timestamp.type",
      "value" : "LogAppendTime"
    }, {
      "name" : "max.message.bytes",
      "value" : 10485760
    } ],
    "topic_desc" : "This is a test topic"
  } ]
}

Example Responses¶

None

Status Codes¶

Status Code	Description
204	The modification is successful.

Error Codes¶

See Error Codes.

last updated: 2024-12-10 15:16 UTC - commit: ef506946dc65402760f4eb57bfda5ee36d4df62f