Pools - List Pool Usage Metrics
指定されたアカウントについて、個々の時間間隔にわたってプール別に集計された使用状況メトリックを一覧表示します。
poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。
GET {endpoint}/poolusagemetrics?api-version=2025-06-01GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
$filter
|
query |
string |
OData $filter 句。 このフィルターの構築についての詳細は https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metricsを参照してください。 |
|
|
endtime
|
query |
string (date-time) |
指標を含めるための最新の時期。 これは現在の時刻より少なくとも2時間前でなければなりません。 指定がなければ、現在利用可能な最後の集計区間の終了時刻をデフォルトで適用します。 |
|
|
maxresults
|
query |
integer (int32) minimum: 1maximum: 1000 |
応答で返される項目の最大数。 最大1000件の申請書を返送できます。 |
|
|
start
|
query |
string (date-time) |
指標を含める最も早い時期。 これは現在の時刻より少なくとも2時間半前でなければなりません。 指定しない場合は、現在利用可能な最後の集計間隔の開始時刻がデフォルトとなります。 |
|
|
time
|
query |
integer (int32) |
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| client-request-id |
string |
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。 |
|
| return-client-request-id |
boolean |
サーバーが応答で client-request-id を返す必要があるかどうか。 |
|
| ocp-date |
string (date-time-rfc7231) |
要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 ヘッダー
|
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://batch.core.windows.net//.default |
例
Pool list usage metrics
要求のサンプル
GET {endpoint}/poolusagemetrics?api-version=2025-06-01
応答のサンプル
{
"value": [
{
"startTime": "2013-04-01T00:00:00Z",
"endTime": "2013-04-01T00:30:00Z",
"poolId": "p1",
"vmSize": "a1",
"totalCoreHours": 39.384838
},
{
"startTime": "2013-04-01T00:30:00Z",
"endTime": "2013-04-01T01:00:00Z",
"poolId": "p2",
"vmSize": "a8",
"totalCoreHours": 3039.384838
}
]
}定義
| 名前 | 説明 |
|---|---|
|
Batch |
Azure Batch サービスから受信したエラー応答。 |
|
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
|
Batch |
Azure Batch エラー応答で受信したエラー メッセージ。 |
|
Batch |
アカウントの使用状況メトリックを一覧表示した結果。 |
|
Batch |
集計間隔にわたるプールの使用状況メトリック。 |
BatchError
Azure Batch サービスから受信したエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
| values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
Value プロパティの意味を指定する識別子。 |
| value |
string |
エラー応答に含まれる追加情報。 |
BatchErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
| 名前 | 型 | 説明 |
|---|---|---|
| lang |
string |
エラーメッセージの言語コード。 |
| value |
string |
メッセージのテキスト。 |
BatchPoolListUsageMetricsResult
アカウントの使用状況メトリックを一覧表示した結果。
| 名前 | 型 | 説明 |
|---|---|---|
| odata.nextLink |
string (uri) |
次の結果セットを取得するための URL。 |
| value |
プール利用率の指標データです。 |
BatchPoolUsageMetrics
集計間隔にわたるプールの使用状況メトリック。
| 名前 | 型 | 説明 |
|---|---|---|
| endTime |
string (date-time) |
この項目でカバーされる集約区間の終了時間。 |
| poolId |
string |
このエントリーで集計された指標を持つプールのID。 |
| startTime |
string (date-time) |
この項目でカバーされている集約間隔の開始時刻。 |
| totalCoreHours |
number (float) |
この集計期間中にプールで使用された総コア時間。 |
| vmSize |
string |
プール内の仮想マシンのサイズ。 プール内のすべてのVMは同じサイズです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。 |