Job Router Operations - Get Queue Statistics

Serviço:

Communication

Versão da API:

2023-11-01

Obtém as estatísticas de uma fila.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	URI do recurso de Comunicação
queueId	path	True	string	ID da fila para obter estatísticas.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	RouterQueueStatistics	O pedido foi efetuada com êxito.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Exemplos

Retrieves a queue's statistics

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes de erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueueStatistics	Estatísticas da fila.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

RouterQueueStatistics

Estatísticas da fila.

Name	Tipo	Description
estimatedWaitTimeMinutes	object	O tempo de espera estimado desta fila arredondado até ao minuto mais próximo, agrupado por prioridade de trabalho.
length	integer	Comprimento da fila: número total de tarefas em fila.
longestJobWaitTimeMinutes	number	O tempo de espera da tarefa que foi colocada em fila durante mais tempo.
queueId	string	ID da fila sobre o que se tratam estes detalhes.