ModifyTopicAttributes

Last updated: 2025-11-21 20:32:22

ModifyTopicAttributes

Last updated: 2025-11-21 20:32:22

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to modify topic attributes.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyTopicAttributes.
Version	Yes	String	Common Params. The value used for this API: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	The ckafka cluster instance Id.
TopicName	Yes	String	Topic name
Note	No	String	Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`).
EnableWhiteList	No	Integer	IP allowlist switch. 1: enabled, 0: disabled.
MinInsyncReplicas	No	Integer	Default value: 1.
UncleanLeaderElectionEnable	No	Integer	0: false, 1: true. Default value: 0.
RetentionMs	No	Integer	Message retention period in ms. The current minimum value is 60,000 ms.
MaxMessageBytes	No	Integer	Max message size in bytes. Max value: 8,388,608 bytes (8 MB).
SegmentMs	No	Integer	Duration of Segment shard scrolling in milliseconds. current min value is 86400000 ms.
CleanUpPolicy	No	String	Message deletion policy. Valid values: delete, compact
IpWhiteList.N	No	Array of String	IP allowlist, which is required if the value of `enableWhileList` is 1.
EnableAclRule	No	Integer	Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.
AclRuleName	No	String	ACL rule name.
RetentionBytes	No	Integer	Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.
Tags.N	No	Array of Tag	Tag list.
QuotaProducerByteRate	No	Integer	Production traffic throttling in MB/s. set to -1 to disable throttling.
QuotaConsumerByteRate	No	Integer	Consumption traffic throttling in MB/s. set to -1 for unlimited consumption.
ReplicaNum	No	Integer	Number of topic replicas. valid values: 1, 3.
LogMsgTimestampType	No	String	Specifies the time type for message saving: CreateTime/LogAppendTime.

3. Output Parameters

Parameter Name	Type	Description
Result	JgwOperateResponse	Returned result.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Setting Topic Properties

Input Example

POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTopicAttributes
<Common request parameters>

{
    "InstanceId": "ckafka-test",
    "Note": "note",
    "TopicName": "topic-test"
}

Output Example

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "ok",
            "Data": {
                "FlowId": 0,
                "RouteDTO": {
                    "RouteId": 0
                }
            }
        },
        "RequestId": "fcfb7c89-3973-44f1-9a3e-a2811c67434e"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
InvalidParameterValue.RepetitionValue	The parameter already exists.
InvalidParameterValue.SubnetIdInvalid	Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone	The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid	Invalid VPC ID.
InvalidParameterValue.WrongAction	The value of the `Action` parameter is incorrect.
InvalidParameterValue.ZoneNotSupport	The zone is not supported.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
UnsupportedOperation.OssReject	Oss rejected the operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud