- URL:
- https://<root>/info/queue
- Methods:
GET- Version Introduced:
- 12.0
Description
The queue resource outputs information regarding the queue store for ArcGIS Video Server. Messages about changes made to services are written to the queue store to allow webhooks to query the queue store for that information. Messages are deleted from the queue store after webhooks retrieve them. Queue stores are automatically configured alongside the server and require no additional setup.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The output format for this operation. The default value is Values: |
(Required) | Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation. |
Response properties
| Property | Details |
|---|---|
| Outputs the number of items currently stored in the queue store as an integer. |
| Outputs the number of available queue store listeners on ArcGIS Video Server as an integer. |
| The full name associated with this server's queue store. |
Example usage
The following is a sample request URL used to access the queue resource:
https://organization.example.com:21443/arcgis/admin/info/queue?f=pjsonJSON Response syntax
{
"queueLength": <integer>,
"numListeners": <integer>,
"name": "<name of queue store>"
}JSON Response example
{
"queueLength": 0,
"numListeners": 1,
"name": "c55a5964-6622-45a9-80e7-051439257129_VS_Processor_Queue"
}