Account - List Pool Node Counts

リファレンス

サービス:: Batch Service

API バージョン:: 2023-11-01.18.0

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

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

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

GET {batchUrl}/nodecounts?$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。
maxresults	query		integer int32	応答で返される項目の最大数。
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	PoolNodeCountsListResult	応答には、プール別にグループ化された各コンピューティングノード状態のコンピューティングノードの数が含まれます。ヘッダー client-request-id: string request-id: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

PoolNodeCountsListResult

応答には、プール別にグループ化された各コンピューティングノード状態のコンピューティングノードの数が含まれます。

ヘッダー

client-request-id: string
request-id: 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

例

NodeCountsPayload

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 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,
        "total": 0
      },
      "lowPriority": {
        "creating": 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,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 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,
        "total": 4
      },
      "lowPriority": {
        "creating": 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,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 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,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 11
      }
    }
  ]
}

定義

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

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

NodeCounts

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

名前	型	説明
creating	integer	作成中の状態のコンピューティングノードの数。
idle	integer	アイドル状態のコンピューティングノードの数。
leavingPool	integer	leavingPool 状態のコンピューティングノードの数。
offline	integer	オフライン状態のコンピューティングノードの数。
preempted	integer	割り込まれた状態のコンピューティングノードの数。
rebooting	integer	再起動状態のコンピューティングノードの数。
reimaging	integer	再イメージ化状態のコンピューティングノードの数。
running	integer	実行中の状態のコンピューティングノードの数。
startTaskFailed	integer	startTaskFailed 状態のコンピューティングノードの数。
starting	integer	開始状態のコンピューティングノードの数。
total	integer	コンピューティングノードの合計数。
unknown	integer	不明な状態のコンピューティングノードの数。
unusable	integer	使用できない状態のコンピューティングノードの数。
waitingForStartTask	integer	waitingForStartTask 状態のコンピューティングノードの数。

PoolNodeCounts

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

名前	型	説明
dedicated	NodeCounts	各状態の専用コンピューティングノードの数。
lowPriority	NodeCounts	各状態のスポット/低優先度コンピューティングノードの数。
poolId	string	プールの ID。

PoolNodeCountsListResult

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

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	PoolNodeCounts[]	プール別のコンピューティングノード数の一覧。

次の方法で共有

Account - List Pool Node Counts

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

スコープ

Authorization

例

NodeCountsPayload

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

その他のリソース