最近更新时间:2023.09.27 10:17:49
首次发布时间:2023.03.30 19:59:25
调用 ModifyInstanceParameters 接口修改对应实例的参数配置。
该接口用于修改实例的配置参数,例如消息保留时长和最大消息大小等参数。
说明
修改某些配置会导致实例重启,请谨慎操作。
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
InstanceId | String | 是 | kafka-cnngqkfgdudt**** | 实例 ID。 |
Parameters | String | 是 | {"MessageMaxByte":"11"} | Kafka 实例新的参数配置。 |
Parameters 参数说明
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
MessageMaxByte | String | 否 | 12 | 最大消息大小。 |
LogRetentionHours | String | 否 | 2160 | 消息保留时长。 |
OffsetRetentionMinutes | String | 否 | 10080 | 消费位点保留时长。 |
MessageTimestampType | String | 否 | LogAppendTime | 消息时间类型,支持设置为:
|
AutoDeleteGroup | String | 否 | false | 是否自动删除 Group。默认为 false。
|
无
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 }