全部产品
Search
文档中心

消息队列Kafka版:UpdateInstanceConfig - 修改实例的配置

更新时间:Jan 16, 2023

调用UpdateInstanceConfig接口更新实例配置。

接口说明

权限说明

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

API Action Resource
UpdateInstanceConfig alikafka: UpdateInstance acs:alikafka:::{instanceId}

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
Config string

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

{"kafka.log.retention.hours":"33"}
RegionId string

实例的地域ID。

cn-hangzhou
InstanceId string

实例的ID。

alikafka_post-cn-v0h1fgs2****

Config参数说明

名称 类型 取值范围 默认值 描述
enable.vpc_sasl_ssl Boolean true/false false 是否开启VPC传输加密,如果要开启,必须同时开启ACL。
enable.acl Boolean true/false false 是否开启ACL。
kafka.log.retention.hours Integer 24~480 72 消息保留时长(小时)。
kafka.message.max.bytes Integer 1048576~10485760 1048576 最大消息大小(字节)。

返回参数

名称 类型 描述 示例值
object
Code integer

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

200
Message string

返回信息。

operation success.
RequestId string

请求ID。

4B6D821D-7F67-4CAA-9E13-A5A997C35***
Success boolean

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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