Release Notes
Announcements
Domain name for API request: trocket.intl.tencentcloudapi.com.
This API is used to query RocketMQ 5.x cluster information.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2023-03-08. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | TDMQ RocketMQ instance ID. It can be obtained from the API DescribeFusionInstanceList or the console. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceType | String | Instance type. Specifies the EXPERIMENT trial version. BASIC version. PRO edition. PLATINUM. platinum version. |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| TopicNum | Integer | Number of topics |
| TopicNumLimit | Integer | Maximum number of topics per instance |
| GroupNum | Integer | Number of consumer groups |
| GroupNumLimit | Integer | Maximum number of consumer groups per instance |
| MessageRetention | Integer | Message retention time, in hours |
| RetentionUpperLimit | Integer | Maximum adjustable message retention time, in hours |
| RetentionLowerLimit | Integer | Minimum adjustable message retention time, in hours |
| TpsLimit | Integer | TPS throttle value |
| ScaledTpsLimit | Integer | Elastic TPS throttle value |
| MaxMessageDelay | Integer | Maximum delayed message time, in hours |
| CreatedTime | Integer | Creation time. It is a Unix timestamp (ms). |
| SendReceiveRatio | Float | Message sending and receiving ratio |
| TagList | Array of Tag | Tag. Note: This field may return null, indicating that no valid values can be obtained. |
| EndpointList | Array of Endpoint | Access point list Note: This field may return null, indicating that no valid values can be obtained. |
| TopicQueueNumUpperLimit | Integer | Maximum number of topic queues |
| TopicQueueNumLowerLimit | Integer | Minimum queue count for topic |
| Remark | String | Remarks |
| InstanceStatus | String | Instance status. valid values are as follows:. - RUNNING: RUNNING. -ABNORMAL: indicates an abnormal status. -OVERDUE: isolated. -DESTROYED: specifies the terminated status. -CREATING: creating. -MODIFYING. -CREATE_FAILURE: creation failed. -MODIFY_FAILURE: configuration adjustment failure. -DELETING: deleting. |
| SkuCode | String | Instance specification. |
| PayMode | String | Billing mode. valid enumeration values are as follows:. - POSTPAID: POSTPAID pay-as-you-go billing. - PREPAID: PREPAID annual and monthly. |
| ScaledTpsEnabled | Boolean | Whether to enable elastic TPS. |
| RenewFlag | Integer | Specifies whether the prepaid cluster is automatically renewed. valid values are as follows:. - 0: no automatic renewal. - 1: specifies automatic renewal. |
| ExpiryTime | Integer | Expiration time. It is a Unix timestamp (ms). |
| RoleNumLimit | Integer | Specifies the limit on the number of roles. |
| AclEnabled | Boolean | Whether ACL is enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| TopicNumLowerLimit | Integer | Number of topics within the free quota. Note: This field may return null, indicating that no valid values can be obtained. |
| TopicNumUpperLimit | Integer | Maximum settable number of topics. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneIds | Array of Integer | AZ list. See ZoneInfo returned by the API DescribeZones in Data Type. |
| NodeCount | Integer | Number of proxy nodes. Note: This field may return null, indicating that no valid values can be obtained. |
| ZoneScheduledList | Array of ZoneScheduledItem | Proxy scheduling details. 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. |
This example shows you how to query cluster information successfully.
POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstance
<Common request parameters>
{
"InstanceId": "rmq-72mo3a9o"
}{
"Response": {
"ScaledTpsEnabled": false,
"InstanceType": "EXPERIMENT",
"InstanceId": "rmq-72mo3a9o",
"InstanceName": "test_instance",
"TopicNum": 2,
"TopicNumLimit": 50,
"GroupNum": 10,
"GroupNumLimit": 500,
"MessageRetention": 72,
"RetentionUpperLimit": 168,
"RetentionLowerLimit": 1,
"TpsLimit": 500,
"ScaledTpsLimit": 0,
"MaxMessageDelay": 168,
"CreatedTime": 1731920303801,
"SendReceiveRatio": 0.5,
"TagList": [
{
"TagKey": "test_tag_key",
"TagValue": "test_tag_value"
}
],
"EndpointList": [
{
"Type": "VPC",
"Status": "OPEN",
"PayMode": "PREPAID",
"EndpointUrl": "rmq-72mo3a9o.rocketmq.xx.qcloud.tencenttdmq.com:8080",
"VpcId": "vpc-be1tvrab",
"SubnetId": "subnet-i6fjswac",
"Bandwidth": 0,
"IpRules": []
}
],
"TopicQueueNumUpperLimit": 32,
"TopicQueueNumLowerLimit": 1,
"Remark": "Test cluster"
"InstanceStatus": "RUNNING",
"SkuCode": "experiment_500",
"PayMode": "PREPAID",
"RequestId": "32759095-0372-4ec0-ae3a-e5a2759fd0ff"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| ResourceNotFound.Instance | The instance does not exist. |
피드백