Job Router Operations - Get Queue Statistics

サービス:

Communication

API バージョン:

2023-11-01

キューの統計を取得します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	Communication リソースの URI
queueId	path	True	string	統計を取得するキューの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	RouterQueueStatistics	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

例

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
}

定義

名前	説明
Azure.Core.Foundations.Error	error オブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
RouterQueueStatistics	キューの統計。

Azure.Core.Foundations.Error

error オブジェクト。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	error オブジェクト。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

RouterQueueStatistics

キューの統計。

名前	型	説明
estimatedWaitTimeMinutes	object	このキューの推定待機時間は、ジョブの優先度別にグループ化された、最も近い分に切り上げられます。
length	integer	キューの長さ: エンキューされたジョブの合計数。
longestJobWaitTimeMinutes	number	このキューに最も長くエンキューされたジョブの待機時間。
queueId	string	これらの詳細が記載されているキューの ID。