文档

UpdateTopicConfig - 修改Topic配置

更新时间:

Topic创建后,允许修改Topic的消息保留时长以及最大消息大小,本文介绍如何调用接口来修改Topic的配置。

调试

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

授权信息

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

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

请求参数

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

实例的地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

alikafka_post-cn-v0h1fgs2****
Topicstring

Topic 名称。

dqc_test2
Configstring

Topic 配置字的 key。

  • 目前 V2 实例仅支持 Local 存储引擎的 Topic,云存储引擎的 Topic 不支持修改。

  • 支持 V3 实例修改 Topic 配置。

  • V2 实例的local topic支持的 key 为 retention.ms、retention.bytes、replications。

  • V3 实例支持的 key 为 retention.hours、max.message.bytes。

replications
Valuestring

Topic 配置字的 value。其中 V3 实例支持的配置如下:

  • retention.hours表示消息保留时长,取值类型为 String,取值限制为 24~8760。
  • max.message.bytes表示发送消息最大大小,取值类型为 String,取值限制为 1048576~10485760。
3

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

0178A3A7-E87B-5E50-A16F-3E62F534****
Successboolean

调用是否成功。

True
Codelong

状态码,正常返回 200。

200
Messagestring

返回信息。

operation success.
Datastring

返回结果。

[]

示例

正常返回示例

JSON格式

{
  "RequestId": "0178A3A7-E87B-5E50-A16F-3E62F534****",
  "Success": true,
  "Code": 200,
  "Message": "operation success.",
  "Data": "[]"
}

错误码

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

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