Job Router Operations - Get In Queue Position

Служба:

Communication

Версия API:

2023-11-01

Возвращает сведения о позиции задания.

GET {endpoint}/routing/jobs/{jobId}/position?api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Uri ресурса коммуникации
jobId	path	True	string	Идентификатор задания.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	RouterJobPositionDetails	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

AadOauth2Auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://communication.azure.com/.default

Примеры

Gets a job's position details

Образец запроса

HTTP

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/position?api-version=2023-11-01

Пример ответа

Код состояния:

200

{
  "jobId": "383541b3-5637-4af6-8aac-3391da8a578a",
  "position": 1,
  "queueId": "MainQueue",
  "queueLength": 3,
  "estimatedWaitTimeMinutes": 4
}

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails	Положение и предполагаемое время ожидания задания.

Azure.Core.Foundations.Error

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

RouterJobPositionDetails

Положение и предполагаемое время ожидания задания.

Имя	Тип	Описание
estimatedWaitTimeMinutes	number	Предполагаемое время ожидания задания округляется до ближайшей минуты.
jobId	string	Идентификатор задания, о чем они относятся.
position	integer	Положение задания в этой очереди.
queueId	string	Идентификатор очереди, в который выполняется задание.
queueLength	integer	Длина очереди: общее количество заклинированных заданий.