API Introduction
Used to obtain the topic list information.
API Restrictions
None.
URl
GET https://[endpoint]/v2/topic/list
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
topicName | No | url | String | Topic Name |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Description of Return Value returnObj
Response Parameter | Parameter Type | Description |
total | Integer | Total Number of Topics |
rows | List | List of Messages |
Description of Return Value rows
Response Parameter | Parameter Type | Description |
topicName | String | Topic Name |
readQueueNums | Integer | Number of Read Queues |
writeQueueNums | Integer | Number of Write Queues |
perm | Integer | Permission |
topicSysFlag | Integer | Topic System Flag |
order | Boolean | Whether it is ordered. true: ordered; false: unordered |
clusterName | String | Instance ID |
brokerName | String | Broker name |
brokerId | Long | BrokerId |
Sample Request
GET https://[endpoint]/v2/topic/list?prodInstId=70687660456281088
Examples of a Successful Response
{
"returnObj":{
"total":1,
"rows":[
{
"topicName":"test",
"readQueueNums":4,
"writeQueueNums":4,
"perm":6,
"topicSysFlag":0,
"order":false,
"clusterName":"mq_test",
"brokerName":"mq_test_broker_1",
"brokerId":0
}
]
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}