1. 接口描述
接口请求域名:ckafka.api.qcloud.com
本接口(SetTopicAttributes)用于在消息队列 CKafka 实例下修改主题属性。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
instanceId | 是 | String | 实例 ID。 |
topicName | 是 | String | 主题名称。 |
note | 否 | String | 主题备注,是一个不超过64个字符的字符串。 |
enableWhiteList | 否 | Int | IP 白名单开关,1:打开;0:关闭。 |
minInsyncReplicas | 否 | Int | 默认为1。 |
uncleanLeaderElectionEnable | 否 | Int | 默认为 0,0:false;1:true。 |
retentionMs | 否 | Int | 消息保留时间,单位:ms,当前最小值为60000ms。 |
segmentMs | 否 | Int | Segment 分片滚动的时长,单位:ms,当前最小为86400000ms。 |
maxMessageBytes | 否 | Int | 主题消息最大值,单位为 Byte,最大值为8388608Byte(即8MB)。 |
3. 示例
输入:
https://domain/v2/index.php?Action=SetTopicAttributes&instanceId=ckafka-xxxxxx&topicName=xxxxx&<公共请求参数>
输出:
{
"code": 0,
"codeDesc": "Success",
"message": "ok"
}