ModifyTopic--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

消息队列 Kafka版

ModifyTopic

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.24 15:56:37

调用 ModifyTopic 接口修改 Topic 的配置。

使用说明

该接口用于调整 Topic 的分区数、最小同步副本数等配置，也可以修改消息保留时长等参数配置。

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****	Topic的实例 ID。
TopicName	String	必选	my_topic	Topic 的名称。Topic 创建后不支持修改 TopicName。
PartitionNumber	Integer	可选	12	Topic 的分区数。修改分区数时，只支持增加分区数，不支持减少分区数。
MinInsyncReplicaNumber	Integer	可选	2	Topic 的最小同步副本数。最小为 1，最大不超过副本数 -1。
RetentionHour	Integer	可选	144	消息的保留时长，取值范围为 0~2160，单位为小时。
MaxMessageMegabyte	Integer	可选	1	最大消息大小，取值范围为 1～12，单位为MiB。
Description	String	可选	new-describe	Topic 的描述信息。

响应参数

null

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ModifyTopic&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-****",
  "TopicName": "my_topic",
  "PartitionNumber": 12,
  "MinInsyncReplicaNumber": 2,
  "RetentionHour": 144,
  "MaxMessageMegabyte": 1,
  "Description": "new-describe"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "ModifyTopic",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": null
}