Job Router Operations - Get Queue Statistics

Tjänst:

Communication

API-version:

2023-11-01

Hämtar en kös statistik.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Uri för din kommunikationsresurs
queueId	path	True	string	ID för kön för att hämta statistik.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	RouterQueueStatistics	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Retrieves a queue's statistics

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics	Statistik för kön.

Azure.Core.Foundations.Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

RouterQueueStatistics

Statistik för kön.

Name	Typ	Description
estimatedWaitTimeMinutes	object	Den uppskattade väntetiden för den här kön avrundades upp till närmaste minut, grupperad efter jobbprioritet.
length	integer	Köns längd: totalt antal köade jobb.
longestJobWaitTimeMinutes	number	Väntetiden för jobbet som har köats längst i den här kön.
queueId	string	Id för kön den här informationen handlar om.