tencent cloud



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

1. API Description

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

This API is used to query the list of the purchased TDMQ for RocketMQ exclusive instances.

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: DescribeRocketMQVipInstances.
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.
Filters.N No Array of Filter Query condition filter
Limit No Integer The maximum number of queried items, which defaults to 20.
Offset No Integer Start offset for query

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of unpaginated items
Instances Array of RocketMQVipInstance Instance information list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the instance list

Input Example

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

    "Limit": 1,
    "Filters": [
            "Values": [
            "Name": "xx"
    "Offset": 1

Output Example

    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "Instances": [
                "Status": 1,
                "PayMode": 1,
                "Remark": "xx",
                "AutoRenewFlag": 1,
                "InstanceId": "xx",
                "NodeCount": 1,
                "ExpireTime": 1,
                "InstanceVersion": "xx",
                "MaxStorage": 1,
                "MaxBandWidth": 1,
                "SpecName": "xx",
                "ConfigDisplay": "xx",
                "InstanceName": "xx",
                "MaxTps": 1

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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