UpdateInstanceConfig
实例部署后，允许修改实例是否开启ACL、SSL、消息保留时长及最大消息大小，本文介绍如何调用UpdateInstanceConfig修改实例配置
服务地址：
华东1 金融云
输入参数
只看必填
Config需要更新的云消息队列 Kafka 版的配置
RegionId实例的地域ID
InstanceId实例的ID
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

权限说明

RAM 用户需要先获取授权，才能调用 UpdateInstanceConfig 接口。授权的详细信息，请参见 RAM 权限策略。

APIActionResource
UpdateInstanceConfigalikafka: UpdateInstanceacs:alikafka:::{instanceId}

请求参数

字段名称字段详情
Configstring

需要更新的云消息队列 Kafka 版的配置。配置信息必须是一个合法的 JSON 字符串。

示例值:{"kafka.log.retention.hours":"33"}
RegionIdstring

实例的地域 ID。

示例值:cn-hangzhou
InstanceIdstring

实例的 ID。

示例值:alikafka_post-cn-v0h1fgs2****参考取值来源:
    GetAllInstanceIdList
    CreatePrePayInstance

请求说明

Config 参数说明

名称类型取值范围默认值描述
enable.vpc_sasl_sslString"true"：开启。 "false"：不开启。"false"是否开启 VPC 传输加密，如果要开启，必须同时开启 ACL。
enable.aclString"true"：开启。 "false"：不开启。"false"是否开启 ACL。不支持 2.2.0 以下的实例版本，仅专业版、Serverless 版实例支持开启 ACL。
kafka.log.retention.hoursString当前仅支持选择[24,480]区间内的整数。"72"消息保留时长（小时）。
kafka.message.max.bytesString当前仅支持选择[1048576,10485760]区间内的整数。"1048576"最大消息大小（字节）。
log.retention.hoursString当前仅支持选择[24,8760]区间内的整数。"72"消息保留时长（小时）。仅支持 serverless 实例。
offsets.retention.minutesString当前仅支持选择[1440,43200]区间内的整数。"10080"消费位点保留时长（分钟）。仅支持 serverless 实例。
message.max.bytesString当前仅支持选择[1048576,10485760]区间内的整数。"1048576"最大消息大小（字节）。仅支持 serverless 实例。
auto.create.topics.enableString"true"：开启。 "false"：不开启。"false"开启或关闭自动创建 Topic。仅支持 serverless 实例。
num.partitionsString当前仅支持选择[1,800]区间内的整数。"3"自动创建 Topic 分区数。仅支持 serverless 实例。

返回参数

字段名称字段详情
Codeinteger<int32>

返回码。返回 200 代表成功。

示例值:200
Messagestring

返回信息。

示例值:operation success.
RequestIdstring

请求 ID。

示例值:4B6D821D-7F67-4CAA-9E13-A5A997C35***
Successboolean

调用是否成功。

示例值:true
变更历史
变更时间变更内容概要操作
2024-03-20
新增错误码400
新增错误码404
新增错误码500