消息队列 CKafka 版设置主题属性-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： ckafka.tencentcloudapi.com 。

本接口用于修改主题属性。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyTopicAttributes。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。示例值：xxx
TopicName	是	String	主题名称。示例值：xxx
Note	否	String	主题备注，是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线-。示例值：xxx
EnableWhiteList	否	Integer	IP 白名单开关，1：打开；0：关闭。示例值：0
MinInsyncReplicas	否	Integer	默认为1。示例值：1
UncleanLeaderElectionEnable	否	Integer	默认为 0，0：false；1：true。示例值：0
RetentionMs	否	Integer	消息保留时间，单位：ms，当前最小值为60000ms。示例值：1000
MaxMessageBytes	否	Integer	主题消息最大值，单位为 Byte，最大值为12582912Byte（即12MB）。示例值：1
SegmentMs	否	Integer	Segment 分片滚动的时长，单位：ms，当前最小为300000ms。示例值：86400000
CleanUpPolicy	否	String	消息删除策略，可以选择delete 或者compact 示例值：delete
IpWhiteList.N	否	Array of String	Ip白名单列表，配额限制，enableWhileList=1时必选示例值：["1.1.1.1","2.2.2.2"]
EnableAclRule	否	Integer	预设ACL规则, 1:打开 0:关闭，默认不打开示例值：0
AclRuleName	否	String	预设ACL规则的名称示例值：xxx
RetentionBytes	否	Integer	可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B 示例值：-1
Tags.N	否	Array of Tag	标签列表示例值：1
QuotaProducerByteRate	否	Integer	生产限流，单位 MB/s 示例值：30
QuotaConsumerByteRate	否	Integer	消费限流，单位 MB/s 示例值：30
ReplicaNum	否	Integer	调整topic副本数示例值：2

3. 输出参数

参数名称	类型	描述
Result	JgwOperateResponse	返回结果集
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置主题属性

输入示例

POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTopicAttributes
<公共请求参数>

{
    "InstanceId": "xxx",
    "Note": "xxx",
    "TopicName": "xxx"
}

输出示例

{
    "Response": {
        "Result": {
            "ReturnCode": "abc",
            "ReturnMessage": "abc",
            "Data": {
                "FlowId": 0,
                "RouteDTO": {
                    "RouteId": 0
                }
            }
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
InvalidParameterValue.RepetitionValue	已存在相同参数。
InvalidParameterValue.SubnetIdInvalid	无效的子网id。
InvalidParameterValue.SubnetNotBelongToZone	子网不属于zone。
InvalidParameterValue.VpcIdInvalid	无效的 Vpc Id。
InvalidParameterValue.WrongAction	Action参数取值错误。
InvalidParameterValue.ZoneNotSupport	zone不支持。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnsupportedOperation.BatchDelInstanceLimit	批量删除实例限制。
UnsupportedOperation.OssReject	Oss拒绝该操作。

设置主题属性

本页目录：