实例部署后，允许修改实例是否开启ACL、SSL、消息保留时长及最大消息大小，本文介绍如何调用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 | String | "true"：开启。 "false"：不开启。 | "false" | 是否开启 VPC 传输加密，如果要开启，必须同时开启 ACL。 |
| enable.acl | String | "true"：开启。 "false"：不开启。 | "false" | 是否开启 ACL。 |
| kafka.log.retention.hours | String | 当前仅支持选择[24,480]区间内的整数。 | "72" | 消息保留时长（小时）。 |
| kafka.message.max.bytes | String | 当前仅支持选择[1048576,10485760]区间内的整数。 | "1048576" | 最大消息大小（字节）。 |
| log.retention.hours | String | 当前仅支持选择[24,8760]区间内的整数。 | "72" | 消息保留时长（小时）。仅支持 v3 系列 serverless 实例。 |
| offsets.retention.minutes | String | 当前仅支持选择[1440,43200]区间内的整数。 | "10080" | 消费位点保留时长（小时）。仅支持 v3 系列 serverless 实例。 |
| message.max.bytes | String | 当前仅支持选择[1048576,10485760]区间内的整数。 | "1048576" | 最大消息大小（字节）。仅支持 v3 系列 serverless 实例。 |
| auto.create.topics.enable | String | "true"：开启。 "false"：不开启。 | "false" | 开启或关闭自动创建 Topic。仅支持 v3 系列 serverless 实例。 |
| num.partitions | String | 当前仅支持选择[1,800]区间内的整数。 | "3" | 自动创建 Topic 分区数。仅支持 v3 系列 serverless 实例。 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "operation success.",
"RequestId": "4B6D821D-7F67-4CAA-9E13-A5A997C35***",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The %s parameter is required. | 参数%s缺失 |
| 400 | Instance.StatusNotRunning | The instance is not running and cannot operate this function. Please try again later. | 实例不是运行中状态，无法操作该功能，请稍后重试。 |
| 400 | Instance.Change.NotAllowed | This instance does not allow deployment operations. | 该实例不允许变更操作 |
| 400 | InvalidParameter.Format | The %s format is invalid. | 参数%s格式校验不通过 |
| 400 | InvalidParameter.NotSupport | The %s parameter is not supported. | 参数%s当前不支持 |
| 400 | InvalidParameter | The %s parameter is invalid. | 参数%s校验不通过 |
| 400 | InvalidParameter.VersionNotSupport | Current version does not support the %s parameter. | 当前版本不支持参数%s |
| 404 | Instance.NotFound | The instance does not exist. Please verify the entry and try again. | 实例不存在，请核实入参后重试。 |
| 500 | InternalError | An internal error occurred. Please try again later. | 请求超时。请稍后重试。 |
| 500 | InternalError | A system exception occurred. Please submit a ticket. | 内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2024-03-20 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|