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.
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 | ckafka cluster instance Id For reference: DescribeInstances |
| TopicName | Yes | String | Topic name |
| Note | No | String | Topic remark Input parameter limit: no more than 64 characters Default value: "" |
| EnableWhiteList | No | Integer | IP allowlist switch, 1: on; 0: off. |
| MinInsyncReplicas | No | Integer | Minimum sync replica count Default value: 1 Minimum value: 1 |
| UncleanLeaderElectionEnable | No | Integer | Whether to allow unsynchronized replicas to be elected as leader Enumeration value:
Default value: 0 |
| RetentionMs | No | Integer | Duration of Segment shard scrolling Unit: ms Default value: 86400000 Minimum value: 86400000ms (1 day) |
| MaxMessageBytes | No | Integer | Maximum topic messages Value ranges from 1024 to 12582912 Unit: Bytes |
| SegmentMs | No | Integer | Duration of Segment fragment scrolling Unit: ms Minimum value: 86400000ms (1 day) |
| CleanUpPolicy | No | String | Message deletion strategy: choose delete or compact |
| IpWhiteList.N | No | Array of String | Ip whitelist, Quota limit, essential when enableWhileList=1 |
| EnableAclRule | No | Integer | Preset ACL rule, 1: on 0: off, default is off |
| AclRuleName | No | String | ACL rule name |
| RetentionBytes | No | Integer | Option, retain file size Value ranges from [1073741824, 1099511627776] Unit: Bytes Default value: -1 Special value: -1 indicates unlimited |
| Tags.N | No | Array of Tag | Tag list |
| QuotaProducerByteRate | No | Integer | Production traffic throttling in MB/s. Set to -1 for unlimited production traffic throttling. |
| QuotaConsumerByteRate | No | Integer | Consumption throttling, unit MB/s; set to -1 for unlimited consumption throttling. |
| ReplicaNum | No | Integer | topic replica count Minimum value: 1, Maximum value: 3 |
| LogMsgTimestampType | No | String | Time type for message saving: CreateTime/LogAppendTime |
| 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. |
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"
}
{
"Response": {
"Result": {
"ReturnCode": "0",
"ReturnMessage": "ok",
"Data": {
"FlowId": 0,
"RouteDTO": {
"RouteId": 0
}
}
},
"RequestId": "fcfb7c89-3973-44f1-9a3e-a2811c67434e"
}
}
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 |
|---|---|
| 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. |
文档反馈