Job Router Operations - Get Queue Statistics

Dienst:

Communication

API-Version:

2023-11-01

Ruft die Statistiken einer Warteschlange ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	URI Ihrer Kommunikationsressource
queueId	path	True	string	ID der Warteschlange zum Abrufen von Statistiken.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	RouterQueueStatistics	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://communication.azure.com/.default

Beispiele

Retrieves a queue's statistics

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics	Statistiken für die Warteschlange.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

RouterQueueStatistics

Statistiken für die Warteschlange.

Name	Typ	Beschreibung
estimatedWaitTimeMinutes	object	Die geschätzte Wartezeit dieser Warteschlange wurde auf die nächste Minute aufgerundet, gruppiert nach Auftragspriorität.
length	integer	Länge der Warteschlange: Gesamtanzahl der enqueuierten Aufträge.
longestJobWaitTimeMinutes	number	Die Wartezeit des Auftrags, der in dieser Warteschlange für die längste Warteschlange enqueuiert wurde.
queueId	string	Die ID der Warteschlange, zu der diese Details gehören.