tencent cloud



Last updated: 2023-08-09 14:43:24

1. API Description

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

This API is used to create a RocketMQ consumer group.

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: CreateRocketMQGroup.
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.
GroupId Yes String Group name (8–64 characters)
Namespaces.N Yes Array of String Namespace. Currently, only one namespace is supported
ReadEnable Yes Boolean Whether to enable consumption
BroadcastEnable Yes Boolean Whether to enable broadcast consumption
ClusterId Yes String Cluster ID
Remark No String Remarks (up to 128 characters)
GroupType No String Group type (TCP, HTTP)
RetryMaxTimes No Integer The maximum number of retries for a group

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 subscription group

Input Example

Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRocketMQGroup
<Common request parameters>

    "Remark": "example",
    "BroadcastEnable": "true",
    "ClusterId": "rocketmq-2p9vx3ax9jxg",
    "RetryMaxTimes": "16",
    "Namespaces": [
    "ReadEnable": "true",
    "GroupType": "TCP",
    "GroupId": "group-example"

Output Example

    "Response": {
        "RequestId": "0604a303-6d5f-40e6-9dfe-6c4ddd8fe2df"

5. Developer Resources


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.
InternalError Internal error.
InternalError.IllegalMessage Internal error.
InvalidParameter Incorrect parameter.
LimitExceeded The quota limit is exceeded.
ResourceInUse The resource is in use.
ResourceNotFound.Cluster The cluster 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