Job Router Operations - Get Queue Statistics

Service:

Communication

Version d'API:

2023-11-01

Récupère les statistiques d’une file d’attente.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URI de votre ressource communication
queueId	path	True	string	ID de la file d’attente pour récupérer les statistiques.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	RouterQueueStatistics	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Exemples

Retrieves a queue's statistics

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics	Statistiques pour la file d’attente.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

RouterQueueStatistics

Statistiques pour la file d’attente.

Nom	Type	Description
estimatedWaitTimeMinutes	object	Temps d’attente estimé de cette file d’attente arrondi à la minute la plus proche, regroupé par priorité du travail.
length	integer	Longueur de la file d’attente : nombre total de travaux en file d’attente.
longestJobWaitTimeMinutes	number	Temps d’attente du travail qui a été mis en file d’attente dans cette file d’attente pendant la plus longue.
queueId	string	ID de la file d’attente concernant ces détails.