Pool - List Usage Metrics

Service:

Batch Service

API Version:

2023-11-01.18.0

指定されたアカウントの個々の時間間隔にわたってプールによって集計された使用状況メトリックを一覧表示します。
poolId を含む$filter句を指定しない場合、応答には、返される集計間隔の時間範囲内の Account に存在するすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは既定で、現在使用可能な最後の集計間隔の開始時刻と終了時刻になります。つまり、最後の集計間隔のみが返されます。

GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべてのAzure Batchサービス要求のベース URL。
api-version	query	True	string	クライアント API のバージョン。
$filter	query		string	OData $filter 句。 このフィルターの構築の詳細については、「」を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics。
endtime	query		string date-time	メトリックを含める最新時刻。 これは、現在の時刻の少なくとも 2 時間前である必要があります。 指定しない場合、これは既定で、現在使用可能な最後の集計間隔の終了時刻になります。
maxresults	query		integer int32	応答で返される項目の最大数。 最大 1,000 件の結果が返されます。
starttime	query		string date-time	メトリックを含める最も早い時刻。 これは、現在の時刻の少なくとも 2 時間 30 分前である必要があります。 指定しない場合、これは既定で、現在使用可能な最後の集計間隔の開始時刻になります。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

名前	必須	型	説明
client-request-id		string uuid	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 など)。
return-client-request-id		boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date		string date-time-rfc1123	要求が発行された時刻。 クライアント ライブラリは通常、これを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	PoolListUsageMetricsResult	プールの使用状況の詳細の一覧を含む応答。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

例

Pool list usage metrics

Sample Request

HTTP

GET account.region.batch.azure.com/poolusagemetrics?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "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
    }
  ]
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batchエラー応答で受信したエラー メッセージ。
PoolListUsageMetricsResult	アカウントの使用状況メトリックを一覧表示した結果。
PoolUsageMetrics	集計間隔全体のプールの使用状況メトリック。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

ErrorMessage

Azure Batchエラー応答で受信したエラー メッセージ。

名前	型	説明
lang	string	エラー メッセージの言語コード
value	string	メッセージのテキストです。

PoolListUsageMetricsResult

アカウントの使用状況メトリックを一覧表示した結果。

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	PoolUsageMetrics[]	プールの使用状況メトリック データ。

PoolUsageMetrics

集計間隔全体のプールの使用状況メトリック。

名前	型	説明
endTime	string	このエントリの対象となる集計間隔の終了時刻。
poolId	string	このエントリでメトリックが集計されるプールの ID。
startTime	string	このエントリの対象となる集計間隔の開始時刻。
totalCoreHours	number	この集計間隔中にプールで使用されたコア時間の合計。
vmSize	string	プール内の仮想マシンのサイズ。 プール内のすべての VM のサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プール内のコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。