Condividi tramite

Job Router Operations - Get Queue Statistics

  • Riferimento
Servizio:
Communication
Versione API:
2023-11-01

Recupera le statistiche di una coda.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

URI della risorsa di comunicazione
queueId
 path True

string

ID della coda per recuperare le statistiche.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

RouterQueueStatistics

La richiesta ha avuto esito positivo.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome Descrizione
https://communication.azure.com/.default

Esempio

Retrieves a queue's statistics

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "queueId": "MainQueue",
  "length": 5
}

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics

Statistiche per la coda.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

RouterQueueStatistics

Statistiche per la coda.

Nome Tipo Descrizione
estimatedWaitTimeMinutes

object

Tempo di attesa stimato della coda arrotondato al minuto più vicino, raggruppato per priorità del processo.
length

integer

Lunghezza della coda: numero totale di processi accodati.
longestJobWaitTimeMinutes

number

Tempo di attesa del processo accodato in questa coda per il tempo più lungo.
queueId

string

ID della coda su cui si trovano questi dettagli.