Account - List Pool Node Counts
取得每個狀態的計算節點數目,依集區分組。 請注意,傳回的數位不一定是最新的。 如果您需要確切的節點計數,請使用清單查詢。
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 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
batch
|
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"
名稱 | 必要 | 類型 | Description |
---|---|---|---|
client-request-id |
string uuid |
呼叫端產生的要求身分識別,格式為不含大括弧的 GUID,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。 |
|
return-client-request-id |
boolean |
伺服器是否應該在回應中傳回 client-request-id。 |
|
ocp-date |
string date-time-rfc1123 |
發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您直接呼叫 REST API,請明確設定它。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
回應包含每個計算節點狀態的計算節點數目,依集區分組。 標題
|
|
Other Status Codes |
Batch 服務的錯誤。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 驗證碼流程
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬用戶帳戶 |
Authorization
類型:
apiKey
位於:
header
範例
NodeCountsPayload
範例要求
GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0
範例回覆
{
"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
}
}
]
}
定義
名稱 | Description |
---|---|
Batch |
從 Azure Batch 服務收到的錯誤回應。 |
Batch |
Azure Batch 錯誤回應中包含的其他信息專案。 |
Error |
在 Azure Batch 錯誤回應中收到的錯誤訊息。 |
Node |
每個計算節點狀態的計算節點數目。 |
Pool |
集區每個狀態的計算節點數目。 |
Pool |
列出帳戶中計算節點計數的結果。 |
BatchError
從 Azure Batch 服務收到的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程式碼不變,且要以程式設計方式使用。 |
message |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
|
values |
索引鍵/值組的集合,其中包含錯誤的其他詳細數據。 |
BatchErrorDetail
Azure Batch 錯誤回應中包含的其他信息專案。
名稱 | 類型 | Description |
---|---|---|
key |
string |
指定 Value 屬性意義的識別碼。 |
value |
string |
錯誤回應中包含的其他資訊。 |
ErrorMessage
在 Azure Batch 錯誤回應中收到的錯誤訊息。
名稱 | 類型 | Description |
---|---|---|
lang |
string |
錯誤訊息的語言代碼 |
value |
string |
訊息的文字。 |
NodeCounts
每個計算節點狀態的計算節點數目。
名稱 | 類型 | Description |
---|---|---|
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
集區每個狀態的計算節點數目。
名稱 | 類型 | Description |
---|---|---|
dedicated |
每個狀態的專用計算節點數目。 |
|
lowPriority |
每個狀態的現成/低優先順序計算節點數目。 |
|
poolId |
string |
集區的標識碼。 |
PoolNodeCountsListResult
列出帳戶中計算節點計數的結果。
名稱 | 類型 | Description |
---|---|---|
odata.nextLink |
string |
要取得下一組結果的URL。 |
value |
依集區計算節點計數的清單。 |