You need to enable JavaScript to run this app.
导航
ModifyInstanceParameters
最近更新时间:2023.09.27 10:17:49首次发布时间:2023.03.30 19:59:25

调用 ModifyInstanceParameters 接口修改对应实例的参数配置。

使用说明

该接口用于修改实例的配置参数,例如消息保留时长和最大消息大小等参数。

说明

修改某些配置会导致实例重启,请谨慎操作。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

kafka-cnngqkfgdudt****

实例 ID。

Parameters

String

{"MessageMaxByte":"11"}

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

Parameters 参数说明

参数

参数类型

是否必选

示例值

说明

MessageMaxByte

String

12

最大消息大小。
单位为 MB,取值范围为 1~12。默认为 10。

LogRetentionHours

String

2160

消息保留时长。
单位为小时,取值范围为 0~2160,即消息最久保留 90 天。默认为72。

OffsetRetentionMinutes

String

10080

消费位点保留时长。
单位为分钟,取值范围为 1~10080,即消费位点最久保留 7 天。默认为 4320。

MessageTimestampType

String

LogAppendTime

消息时间类型,支持设置为:

  • LogAppendTime:消息写入到服务端的时间。
  • CreateTime:(默认)Producer 创建消息的时间。

AutoDeleteGroup

String

false

是否自动删除 Group。默认为 false。

  • true:如果消费者组中的所有消费者处于 Empty 状态,超出消费位点保留时长后,后端服务会自动删除该消费者组。
  • false:消费进度的自动删除不影响消费组的状态,Empty 状态的 Group 不会被自动删除。

响应参数


示例

请求示例

POST /?Action=ModifyInstanceParameters&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-cnng5ysg5vv9****",
  "Parameters": "{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023022719011888DDE2072F6B0A7393B3",
        "Action": "ModifyInstanceParameters",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}