设置主题属性
最近更新时间: 2022-05-10 11:14:35
1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.cn。
本接口用于修改主题属性。
默认接口请求频率限制：100次/秒。
接口更新时间：2020-03-02 18:31:52。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyTopicAttributes |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | String | 实例 ID。 |
| TopicName | 是 | String | 主题名称。 |
| Note | 否 | String | 主题备注，是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线-。 |
| EnableWhiteList | 否 | Int64 | IP 白名单开关，1：打开；0：关闭。 |
| IpWhiteList | 否 | Array of String | Ip白名单列表，配额限制，enableWhileList=1时必选 |
| MinInsyncReplicas | 否 | Int64 | 默认为1。 |
| UncleanLeaderElectionEnable | 否 | Int64 | 默认为 0，0：false；1：true。 |
| RetentionMs | 否 | Int64 | 消息保留时间，单位：ms，当前最小值为60000ms。 |
| SegmentMs | 否 | Int64 | Segment 分片滚动的时长，单位：ms，当前最小为86400000ms。 |
| MaxMessageBytes | 否 | Int64 | 主题消息最大值，单位为 Byte，最大值为12582912Byte（即12MB）。 |
| CleanUpPolicy | 否 | String | 消息删除策略，可以选择delete 或者compact |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | JgwOperateResponse | 返回结果集 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id |
| InvalidParameterValue.ZoneNotSupport | zone不支持 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制 |
| InternalError | 内部错误。 |
| ResourceUnavailable | 资源不可用。 |