tencent cloud

Feedback

ModifyTopic

Last updated: 2022-05-06 10:30:26

1. API Description

Domain name for API request: tdmq.tencentcloudapi.com.

This API is used to modify the topic remarks and number of partitions.

A maximum of 50 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: ModifyTopic.
Version Yes String Common Params. The value used for this API: 2020-02-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
EnvironmentId Yes String Environment (namespace) name.
TopicName Yes String Topic name.
Partitions Yes Integer Number of partitions, which must be equal to or greater than the original number of partitions. To maintain the original number of partitions, enter the original number. Modifying the number of partitions will take effect only for non-globally sequential messages. There can be up to 128 partitions.
Remark No String Remarks (up to 128 characters).
ClusterId No String Pulsar cluster ID

3. Output Parameters

Parameter Name Type Description
Partitions Integer Number of partitions
Remark String Remarks (up to 128 characters).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying topic attributes

Input Example

https://tdmq.tencentcloudapi.com/?Action=ModifyTopic
&EnvironmentId=default
&TopicName=test_topic
&Partitions=3
&Remark=Change partition to 3
&<Common request parameters>

Output Example

{
  "Response": {
    "Partitions": 3,
    "Remark": "Change partition to 3",
    "RequestId": "c276a96f-1612-47ad-9562-da06d4fdf1ed"
  }
}

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

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
AuthFailure.UnauthorizedOperation CAM authentication failed.
FailedOperation Operation failed.
FailedOperation.GetTopicPartitionsFailed Failed to get the number of topic partitions.
FailedOperation.UpdateTopic Failed to update the topic.
InternalError.SystemError System error.
InvalidParameterValue.InvalidParams The parameter value is out of the value range.
MissingParameter.NeedMoreParams A required parameter is missing.
ResourceNotFound.Topic The topic does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support