You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

ModifyTopicParameters

最近更新时间：2023.08.09 16:02:16

首次发布时间：2023.03.30 19:59:25

我的收藏

调用 ModifyTopicParameters 接口修改 Topic 的参数配置。

使用说明

该接口用于调整指定 Topic 的分区数、最小同步副本个数等配置。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

Topic 的实例 ID。

TopicName

String

是

my_topic

Topic 的名称。Topic 创建后不支持修改 TopicName。

Parameters

String

是

{"MessageMaxByte":"11"}

Kafka 在 Topic 级别的参数配置。
当前支持的参数列表及参数默认值，请参考 CreateTopic。您也可以通过文档修改参数配置查看各参数的详细信息。
通过 Postman 等方式调用 API 时，应注意转义，例如{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MinInsyncReplicaNumber\":\"2\"}。

PartitionNumber

Integer

否

12

此 Topic 的分区数量。分区数量越大，消费的并发度越大。
该参数只能调大不能调小。最大可设置为 300，且不可超出 Kakfa 实例的剩余可用分区数。

ReplicaNumber

Integer

否

3

分区的副本个数，表示对应数量的副本上备份数据。当其中一个 Broker 故障时仍可保障数据可用性，副本数越大可靠性越高。

说明

  • 增加副本数会占用实例磁盘容量，请确保容量充足。增加副本时会占用实例带宽资源，建议在业务低峰期操作。
  • 减少副本数会降低数据可用性，请谨慎操作。
  • 1 副本 Topic 无法保障数据可靠性且实例升级期间无法进行读写操作，建议选择 2 副本或 3 副本。

响应参数

无

示例

请求示例

POST /?Action=ModifyTopicParameters&Version=2022-05-01 HTTP/1.1
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-cnngbnntswg1****",
    "TopicName": "123",
    "Parameters": "{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MinInsyncReplicaNumber\":\"2\"}",
    "PartitionNumber": 22
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023022720003326EC39DC5C89026AD3E1",
        "Action": "ModifyTopicParameters",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}