ModifyInstanceParameters - 修改实例参数--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

ModifyInstanceParameters - 修改实例参数

最近更新时间：2024.09.26 15:55:17首次发布时间：2023.03.30 19:59:25

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

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyInstanceParameters	要执行的操作，取值：ModifyInstanceParameters。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnngqkfgdudt****	实例 ID。
Parameters	String	是	{"MessageMaxByte":"11"}	Kafka 实例新的参数配置。当前支持的参数列表及参数默认值，请参考下表 Parameters 参数说明。您也可以通过文档修改参数配置查看各参数的详细信息。通过 Postman 等方式调用API时，应注意转义，例如`{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}`。 Parameters 参数说明 `"MessageMaxByte":"10"`：最大消息大小。单位为MB，取值范围为1～12。默认为10。 `"LogRetentionHours":"72"`：消息保留时长。单位为小时，取值范围为0～2160，即消息最久保留90天。默认为72。 `"OffsetRetentionMinutes":"4320"`：消费位点保留时长。单位为分钟，取值范围为1～10080，即消费位点最久保留7天。默认为4320。 `"MessageTimestampType":"LogAppendTime"`：消息时间类型，支持设置为`LogAppendTime`和`CreateTime`。LogAppendTime 表示消息写入到服务端的时间；CreateTime 表示Producer 创建消息的时间。 `"AutoDeleteGroup":"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
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.NotModified	The resource was not changed.	未变更任何配置。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
500	AsynchronousProcessException	An error occured in the asynchronous process. Try again later.	异步流程中发生错误。请稍后重试。