tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateRocketMQTopic

Last updated: 2023-04-18 14:53:06

1. API Description

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

This API is used to create a RocketMQ topic.

A maximum of 20 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: CreateRocketMQTopic.
Version Yes String Common Params. The value used for this API: 2020-02-17.
Region No String Common Params. This parameter is not required for this API.
Topic Yes String Topic name, which can contain 3–64 letters, digits, hyphens, and underscores
Namespaces.N Yes Array of String Topic namespace. Currently, you can create topics only in one single namespace.
Type Yes String Topic type. Valid values: Normal, PartitionedOrder, Transaction, DelayScheduled.
ClusterId Yes String Cluster ID
Remark No String Topic remarks (up to 128 characters)
PartitionNum No Integer Number of partitions, which doesn't take effect for globally sequential messages

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a topic

This example shows you how to create a topic.

Input Example

https://tdmq.tencentcloudapi.com/?
Action=CreateRocketMQTopic
&Topic=example-topic
&Type=Normal
&Remark=example
&ClusterId=rocketmq-2p9vx3ax9jxg
&Namespaces.0=example
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "f844f173-93ed-4d89-979e-86e4e1d63b8a"
    }
}

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
FailedOperation Operation failed.
FailedOperation.CreateTopic Failed to create the topic.
InternalError Internal error.
InternalError.IllegalMessage Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.Partition Incorrect partition count.
LimitExceeded The quota limit is exceeded.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
ResourceNotFound.Cluster The cluster does not exist.
ResourceNotFound.Namespace The namespace does not exist.
ResourceUnavailable.FundRequired You must top up before proceeding.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy