tencent cloud

CreateCmqTopic
Last updated: 2025-11-25 10:54:57
CreateCmqTopic
Last updated: 2025-11-25 10:54:57

1. API Description

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

This API is used to create a CMQ 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: CreateCmqTopic.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
TopicName Yes String Topic name, which must be unique under the same account in a single region. The name is a string of no more than 64 characters, starting with a letter, and the remaining part may include letters, numbers, and hyphens (-).
MaxMsgSize No Integer Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.
FilterType No Integer Used to specify the message match policy for the topic. 1: tag match policy (default value); 2: routing match policy.
MsgRetentionSeconds No Integer Message retention period. Value range: 60–86400 seconds (i.e., 1 minute–1 day). Default value: 86400.
Trace No Boolean Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled.
Tags.N No Array of Tag Tag array.

3. Output Parameters

Parameter Name Type Description
TopicId String Topic ID
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.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCmqTopic
<Common request parameters>

{
    "TopicName": "testtopic"
}

Output Example

{
    "Response": {
        "RequestId": "ae412902-bb35-4237-955d-3e1f9901e0cc",
        "TopicId": "cmqt-7jwedr3jqb54"
    }
}

Example2 Create topics.

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCmqTopic
<Common request parameters>

{
    "TopicName": "ConnTopic"
}

Output Example

{
    "Response": {
        "TopicId": "topic-gzz05csc",
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
    }
}

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.CreateCluster Failed to create the cluster.
FailedOperation.CreateTopic Failed to create the topic.
FailedOperation.SetRetentionPolicy Failed to set the message retention policy.
FailedOperation.SetTTL Failed to configure the message TTL.
InternalError.BrokerService The broker service is exceptional.
LimitExceeded.Topics The number of topics under the instance exceeds the limit.
ResourceInUse The resource is in use.
ResourceInUse.Topic A topic with the same name already exists.
ResourceNotFound.Environment The environment does not exist.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.CreateFailed Assignment exception.
ResourceUnavailable.FundRequired You must top up before proceeding.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback