文档

UpdateInstanceConfig - 修改实例的配置

更新时间:

实例部署后,允许修改实例是否开启ACL、SSL、消息保留时长及最大消息大小,本文介绍如何调用UpdateInstanceConfig修改实例配置。

接口说明

权限说明

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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:UpdateInstanceWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Configstring

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

{"kafka.log.retention.hours":"33"}
RegionIdstring

实例的地域 ID。

cn-hangzhou
InstanceIdstring

实例的 ID。

alikafka_post-cn-v0h1fgs2****

Config 参数说明

名称类型取值范围默认值描述
enable.vpc_sasl_sslString"true":开启。 "false":不开启。"false"是否开启 VPC 传输加密,如果要开启,必须同时开启 ACL。
enable.aclString"true":开启。 "false":不开启。"false"是否开启 ACL。
kafka.log.retention.hoursString当前仅支持选择[24,480]区间内的整数。"72"消息保留时长(小时)。
kafka.message.max.bytesString当前仅支持选择[1048576,10485760]区间内的整数。"1048576"最大消息大小(字节)。

返回参数

名称类型描述示例值
object
Codeinteger

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

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求 ID。

4B6D821D-7F67-4CAA-9E13-A5A997C35***
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "4B6D821D-7F67-4CAA-9E13-A5A997C35***",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈