Domain name for API request: ckafka.tencentcloudapi.com.
This API is used to modify topic attributes.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: ckafka.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: ModifyTopicAttributes. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | 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. |
| SegmentMs | No | Integer | Segment rolling duration in ms. The current minimum value is 86,400,000 ms. |
| MaxMessageBytes | No | Integer | Maximum topic message length in bytes. The maximum value is 8,388,608 bytes (i.e., 8 MB). |
| CleanUpPolicy | No | String | Message deletion policy. Valid values: delete, compact |
| Parameter Name | Type | Description |
|---|---|---|
| Result | JgwOperateResponse | Returned result set |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://ckafka.tencentcloudapi.com/?Action=ModifyTopicAttributes
&InstanceId=xxx
&TopicName=xxx
&Note=xxx
&<Common request parameters>
{
"Response": {
"Result": {
"ReturnCode": "0",
"ReturnMessage": "ok[apply success]"
},
"RequestId": "83d1142c-2754-46fb-99ca-46d9d87f5e3e"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| 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?