Job Router Operations - Get Queue Statistics

服務:

Communication

API 版本:

2023-11-01

擷取佇列的統計數據。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	通訊資源的 URI
queueId	path	True	string	要擷取統計數據的佇列標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	RouterQueueStatistics	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://communication.azure.com/.default

範例

Retrieves a queue's statistics

範例要求

HTTP

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
Azure.Core.Foundations.Error	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。
RouterQueueStatistics	佇列的統計數據。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

RouterQueueStatistics

佇列的統計數據。

名稱	類型	Description
estimatedWaitTimeMinutes	object	此佇列的預估等候時間會四捨五入到最接近的分鐘，並依作業優先順序分組。
length	integer	佇列的長度：加入佇列的作業總數。
longestJobWaitTimeMinutes	number	此佇列中已加入佇列的作業等候時間最長。
queueId	string	這些詳細數據的佇列標識碼。