ModifyTopicAttributes

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-18 17:38:15

Download PDF

1. API Description

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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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
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	Name of the preset ACL rule.
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.

3. Output Parameters

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.

4. Example

Example1 Setting topic attributes

Input Example

https://ckafka.tencentcloudapi.com/?Action=ModifyTopicAttributes
&InstanceId=xxx
&TopicName=xxx
&Note=xxx
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "ReturnMessage": "xx",
      "ReturnCode": "xx",
      "Data": {
        "FlowId": 0
      }
    },
    "RequestId": "xx"
  }
}

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
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.

Recent Pages