Pool - Resize
變更指派給集區的計算節點數目。
只有當集區配置狀態穩定時,您才能調整集區的大小。 如果集區已經重設大小,要求會失敗,狀態代碼為 409。 當您調整集區大小時,集區的配置狀態會從穩定變更為重設大小。 您無法調整針對自動調整設定的集區大小。 如果您嘗試這樣做,Batch 服務會傳回錯誤 409。 如果您向下調整集區的大小,Batch 服務會選擇要移除的計算節點。 若要移除特定的計算節點,請改用集區移除計算節點 API。
POST {batchUrl}/pools/{poolId}/resize?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2024-07-01.20.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
batch
|
path | True |
string |
所有 Azure Batch 服務要求的基底 URL。 |
pool
|
path | True |
string |
要重設大小的集區標識碼。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
timeout
|
query |
integer (int32) |
伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 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,請明確設定它。 |
|
If-Match |
string |
與用戶端已知的資源版本相關聯的ETag值。 只有在服務上的資源目前的 ETag 完全符合用戶端指定的值時,才會執行此作業。 |
|
If-None-Match |
string |
與用戶端已知的資源版本相關聯的ETag值。 只有在服務的目前 ETag 不符合用戶端指定的值時,才會執行作業。 |
|
If-Modified-Since |
string (date-time-rfc1123) |
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來已修改時,才會執行此作業。 |
|
If-Unmodified-Since |
string (date-time-rfc1123) |
時間戳,指出用戶端已知的資源上次修改時間。 只有在服務上的資源自指定時間以來尚未修改時,才會執行此作業。 |
要求本文
Media Types: "application/json; odata=minimalmetadata"
名稱 | 類型 | Description |
---|---|---|
nodeDeallocationOption |
判斷如果集區大小正在減少,則計算節點及其執行中工作要執行的作業。 |
|
resizeTimeout |
string (duration) |
將節點配置至集區或從集區移除計算節點的逾時。 |
targetDedicatedNodes |
integer (int32) |
集區中所需的專用計算節點數目。 |
targetLowPriorityNodes |
integer (int32) |
集區中所需的現成/低優先順序計算節點數目。 |
回應
名稱 | 類型 | Description |
---|---|---|
202 Accepted |
Batch 服務的要求成功。 標題
|
|
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
範例
Pool resize
範例要求
POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2024-07-01.20.0
{
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
範例回覆
定義
名稱 | Description |
---|---|
Batch |
從 Azure Batch 服務收到的錯誤回應。 |
Batch |
Azure Batch 錯誤回應中包含的其他信息專案。 |
Compute |
決定在選取要解除分配的計算節點及其執行中工作之後,該怎麼做。 |
Error |
Azure Batch 錯誤回應中收到的錯誤訊息。 |
Pool |
變更集區大小的選項。 |
BatchError
從 Azure Batch 服務收到的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程序代碼是不變的,而且是要以程序設計方式取用。 |
message |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
|
values |
索引鍵/值組的集合,其中包含錯誤的其他詳細數據。 |
BatchErrorDetail
Azure Batch 錯誤回應中包含的其他信息專案。
名稱 | 類型 | Description |
---|---|---|
key |
string |
指定 Value 屬性意義的識別碼。 |
value |
string |
錯誤回應隨附的其他資訊。 |
ComputeNodeDeallocationOption
決定在選取要解除分配的計算節點及其執行中工作之後,該怎麼做。
值 | Description |
---|---|
requeue |
終止執行中的工作進程並重新排入佇列。 當計算節點可用時,工作會再次執行。 一旦工作終止,請移除計算節點。 |
retaineddata |
允許目前執行的工作完成,然後等候所有工作數據保留期間到期。 在等候時排程沒有新的工作。 當所有工作保留期間都過期時,請移除計算節點。 |
taskcompletion |
允許目前正在執行的工作完成。 在等候時排程沒有新的工作。 當所有工作完成時,請移除計算節點。 |
terminate |
終止執行中的工作。 工作將會以 failureInfo 完成,指出它們已終止,而且不會再次執行。 一旦工作終止,請移除計算節點。 |
ErrorMessage
Azure Batch 錯誤回應中收到的錯誤訊息。
名稱 | 類型 | Description |
---|---|---|
lang |
string |
錯誤訊息的語言代碼 |
value |
string |
訊息的文字。 |
PoolResizeParameter
變更集區大小的選項。
名稱 | 類型 | Description |
---|---|---|
nodeDeallocationOption |
判斷如果集區大小正在減少,則計算節點及其執行中工作要執行的作業。 |
|
resizeTimeout |
string (duration) |
將節點配置至集區或從集區移除計算節點的逾時。 |
targetDedicatedNodes |
integer (int32) |
集區中所需的專用計算節點數目。 |
targetLowPriorityNodes |
integer (int32) |
集區中所需的現成/低優先順序計算節點數目。 |