Pools - List Pool Node Counts

サービス:: Batch Service

API バージョン:: 2025-06-01

プールごとにグループ化された、各状態のコンピューティングノードの数を取得します。返される数値が常に最新であるとは限りません。正確なノード数が必要な場合は、リストクエリを使用します。

GET {endpoint}/nodecounts?api-version=2025-06-01

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

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$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-support-imagesを参照してください。
maxresults	query		integer (int32) minimum: 1 maximum: 1000	応答で返される項目の最大数。最大1000件の申請書を返送できます。
timeOut	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	BatchPoolNodeCountsListResult	要求は成功しました。ヘッダー ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

名前

型

説明

200 OK

BatchPoolNodeCountsListResult

要求は成功しました。

ヘッダー

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

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

スコープ

名前	説明
https://batch.core.windows.net//.default

例

NodeCountsPayload

要求のサンプル

HTTP

GET {endpoint}/nodecounts?api-version=2025-06-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
BatchNodeCounts	各コンピューティングノード状態のコンピューティングノードの数。
BatchPoolNodeCounts	プールの各状態のコンピューティングノードの数。
BatchPoolNodeCountsListResult	アカウントのコンピューティングノード数を一覧表示した結果。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

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

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

BatchNodeCounts

Object

各コンピューティングノード状態のコンピューティングノードの数。

名前	型	説明
creating	integer (int32)	作成中のComputeノードの数。
deallocated	integer (int32)	デロケーション状態にある計算ノードの数。
deallocating	integer (int32)	デロロケーション状態にある計算ノードの数。
idle	integer (int32)	アイドル状態にあるComputeノードの数。
leavingPool	integer (int32)	離脱プール状態にある計算ノードの数。
offline	integer (int32)	オフライン状態の計算ノード数。
preempted	integer (int32)	プリエンプト状態にあるComputeノードの数。
rebooting	integer (int32)	再起動中のComputeノードの数。
reimaging	integer (int32)	再イメージング状態にあるComputeノードの数。
running	integer (int32)	実行中のコンピュートノードの数。
startTaskFailed	integer (int32)	startTaskFailed状態にあるComputeノードの数。
starting	integer (int32)	開始時の状態にあるCompute Nodeの数。
total	integer (int32)	コンピュートノードの総数。
unknown	integer (int32)	未知の状態にあるComputeノードの数。
unusable	integer (int32)	使用不能状態にあるComputeノードの数。
upgradingOS	integer (int32)	upgradingOS状態にあるCompute Nodeの数。
waitingForStartTask	integer (int32)	waitingForStartTask状態にあるComputeノードの数。

BatchPoolNodeCounts

Object

プールの各状態のコンピューティングノードの数。

名前	型	説明
dedicated	BatchNodeCounts	各状態にある専用のコンピュートノードの数。
lowPriority	BatchNodeCounts	各状態にあるスポット/低優先度計算ノードの数。
poolId	string	プールのIDだ。

BatchPoolNodeCountsListResult

Object

アカウントのコンピューティングノード数を一覧表示した結果。

名前	型	説明
odata.nextLink	string (uri)	次の結果セットを取得するための URL。
value	BatchPoolNodeCounts[]	プールごとのコンピュートノード数のリストです。

次の方法で共有

Pools - List Pool Node Counts

URI パラメーター

要求ヘッダー

応答

セキュリティ

OAuth2Auth

スコープ

例

NodeCountsPayload

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult