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

文档中心

立即注册

导航

消息队列 Kafka版

ModifyInstanceParams

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

调用 ModifyInstanceParams 修改实例的配置参数。

使用说明

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

说明

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

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceID	String	必选	kafka-****	实例 ID。
Parameters	List	必选	-	Kafka 实例的相关参数。详细信息请参考 UpdateInstanceParamItem。

响应参数

null

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ModifyInstanceParams&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": "",
  "Parameters": [
    {
      "Name": "max_byte",
      "RunningValue": "1"
    }
  ]
}

响应示例

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