Pool - List Usage Metrics

サービス:

Batch Service

API バージョン:

2024-07-01.20.0

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

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0

省略可能なパラメーターを含む:

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
api-version	query	True	string	クライアント 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	応答で返される項目の最大数。 最大 1,000 件の結果が返されます。
starttime	query		string date-time	メトリックを含める最も早い時刻。 これは、現在の時刻の少なくとも 2 時間 30 分前である必要があります。 指定しない場合、これは既定で、現在使用可能な最後の集計間隔の開始時刻になります。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が 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	プールの使用状況の詳細の一覧を含む応答。 ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

セキュリティ

azure_auth

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

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

Authorization

型: apiKey
/: header

例

Pool list usage metrics

要求のサンプル

HTTP

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。