Get basic or detailed queue information by queue name (POST)
Description
URL |
scheme://domain:port/platform/ws/queues/getbasicinfo scheme://domain:port/platform/ws/queues/getfullinfo |
|
Description |
Gets basic or detailed information for queues with the specified queue names. |
|
HTTP Method |
POST |
|
Parameters |
Name |
Description |
names |
Mandatory. Name of the queue for which to retrieve information. To specify multiple queue names, separate with a comma(,). For example: normal,priority. Use the keyword all to retrieve information for all queues in the cluster. |
Request
Request-Method |
POST |
|
Request-URI |
/platform/ws/queues/getbasicinfo /platform/ws/queues/getfullinfo |
|
Request-Header |
Name |
Value |
Accept |
application/xml or application/json |
|
Message-body |
names=%s |
Response
Response-Code |
|
|
Response-Header |
Name |
Value |
Content-Type |
application/xml or application/json |
|
Message-body |
Success Message for getfullinfo | If successful, returns detailed information about queues. For additional information, refer to the schema file ./schemas/queues/queues_detailed.xsd and./schemas/queues/queues_schema.xsd . |
|
||
Success Message for getbasicinfo | If successful, returns basic information about queues. For additional information, refer to the schema file ./schemas/queues/pseudoqueue.xsd and ./schemas/queues/queues_schema.xsd.
|
|
Failure Message | If not successful, returns an error message. For additional information, refer to the schema file ./schemas/queues/error.xsd.
|
Example: Get basic queue information for queues night and priority
# Request
POST /platform/ws/queues/getbasicinfo HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
names=night,priority
# Response
200 Successful
Content-Type: application/xml;
<queues total="2">
<pseudoQueue>
<atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/night"/>
...
</pseudoQueue>
<pseudoQueue>
<atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/priority"/>
...
</pseudoQueue>
</queues>
Example: Get detailed information for queues normal and idle
# Request
POST /platform/ws/queues/getfullinfo HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
names=normal,idle
# Response
200 Successful
Content-Type: application/xml;
<queues total = "2" >
<queue>
<atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/idle"/>
...
</queue>
<queue>
<atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/normal"/>
...
</queue>