Job Router Operations - Get Queue Statistics

Servicio:

Communication

Versión de la API:

2023-11-01

Recupera las estadísticas de una cola.

GET {endpoint}/routing/queues/{queueId}/statistics?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Uri del recurso de comunicación
queueId	path	True	string	Identificador de la cola para recuperar estadísticas.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	RouterQueueStatistics	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre	Description
https://communication.azure.com/.default

Ejemplos

Retrieves a queue's statistics

Solicitud de ejemplo

HTTP

GET https://contoso.westus.communications.azure.com/routing/queues/MainQueue/statistics?api-version=2023-11-01

Respuesta de muestra

status code:

200

{
  "queueId": "MainQueue",
  "length": 5
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics	Estadísticas de la cola.

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

RouterQueueStatistics

Object

Estadísticas de la cola.

Nombre	Tipo	Description
estimatedWaitTimeMinutes	object	El tiempo de espera estimado de esta cola se redondea al minuto más cercano, agrupado por prioridad de trabajo.
length	integer (int32)	Longitud de la cola: número total de trabajos en cola.
longestJobWaitTimeMinutes	number (double)	El tiempo de espera del trabajo que se ha puesto en cola durante más tiempo.
queueId	string	Identificador de la cola sobre estos detalles.