DescribePulsarProInstanceDetail

Download PDF

Last updated: 2025-11-25 10:54:13

DescribePulsarProInstanceDetail

Last updated: 2025-11-25 10:54:13

Download PDF

1. API Description

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

This API is used to obtain the information of a TDMQ for Pulsar pro cluster instance.

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: DescribePulsarProInstanceDetail.
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-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
ClusterId	Yes	String	Cluster ID

3. Output Parameters

Parameter Name	Type	Description
ClusterInfo	PulsarProClusterInfo	Cluster information
NetworkAccessPointInfos	Array of PulsarNetworkAccessPointInfo	Cluster network access point information Note: This field may return null, indicating that no valid values can be obtained.
ClusterSpecInfo	PulsarProClusterSpecInfo	Cluster specification information Note: This field may return null, indicating that no valid values can be obtained.
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 Retrieve Pulsar Pro Cluster Instance Details

Input Example

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

{
    "ClusterId": "pulsar-x4r939zkwmm2"
}

Output Example

{
    "Response": {
        "ClusterInfo": {
            "ClusterId": "pulsar-x4r939zkwmm2",
            "ClusterName": "devTest",
            "Remark": "devTest",
            "CreateTime": "2023-07-20 10:35:17",
            "Status": 0,
            "Version": "2.9.2",
            "NodeDistribution": [
                {
                    "ZoneName": "ap-beijing-4",
                    "ZoneId": "800004",
                    "NodeCount": 1
                }
            ],
            "MaxStorage": 1,
            "CanEditRoute": true,
            "BillingLabelVersion": "PULSAR.P1"
        },
        "NetworkAccessPointInfos": [
            {
                "VpcId": "vpc-8jjua83u",
                "SubnetId": "subnet-1iia83y2",
                "Endpoint": "http://pulsar-x4r939zkwmm2.tdmq.ap-bj.qcloud.tencenttdmq.com:8080",
                "InstanceId": "pulsar-x4r939zkwmm2",
                "RouteType": 1,
                "OperationType": 1,
                "AccessPointsType": null
            }
        ],
        "ClusterSpecInfo": {
            "SpecName": "PULSAR.P1.MINI2",
            "MaxTps": 1,
            "MaxBandWidth": 1,
            "MaxNamespaces": 1,
            "MaxTopics": 1,
            "ScalableTps": 1
        },
        "RequestId": "0799dd77-707b-40d7-a4b5-4140b11f6c97"
    }
}

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

Tencent Cloud CLI 3.0

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.CloudService	Third-Party cloud service exception. try again later.
FailedOperation.OperateLater	Task in progress. please try again later.
InternalError.IllegalMessage	Internal error.
InvalidParameter	Incorrect parameter.
ResourceNotFound	The resource does not exist.
ResourceNotFound.Cluster	The cluster does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud