你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	作业的 ID。
api-version	query	True	string	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	RouterJobPositionDetails	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - 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

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - 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	这些详细信息所要介绍的作业 ID。
position	integer	该队列中有关作业的位置。
queueId	string	此作业排队的队列 ID。
queueLength	integer	队列的长度：排队作业的总数。