共用方式為

Pool - Remove Nodes

  • 參考
服務:
Batch Service
API 版本:
2024-07-01.20.0

從指定的集區中移除計算節點。
此作業只能在集區的配置狀態穩定時執行。 當此作業執行時，配置狀態會從穩定變更為重設大小。 每個要求最多可以移除100個節點。

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2024-07-01.20.0
含選擇性參數: 
POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱 位於 必要 類型 Description
batchUrl
 path True

string

所有 Azure Batch 服務要求的基底 URL。
poolId
 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
nodeList True

string[]

清單，其中包含要從指定集區移除之計算節點的標識碼。
每個要求最多可以移除100個節點。
nodeDeallocationOption

ComputeNodeDeallocationOption

決定在選取要解除分配的計算節點及其執行中工作之後，該怎麼做。
預設值為重新排入佇列。
resizeTimeout

string (duration)

將計算節點移除至集區的逾時。
預設值是 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。

回應

名稱 類型 Description
202 Accepted

Batch 服務的要求成功。

標題

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

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 remove nodes

範例要求

POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2024-07-01.20.0



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

範例回覆

狀態碼:
202

定義

名稱 Description
BatchError

從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。
ComputeNodeDeallocationOption

決定在選取要解除分配的計算節點及其執行中工作之後，該怎麼做。
ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。
NodeRemoveParameter

從集區移除計算節點的選項。

BatchError

Object

從 Azure Batch 服務收到的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message

ErrorMessage

描述錯誤的訊息，適用於在使用者介面中顯示。
values

BatchErrorDetail[]

索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Object

Azure Batch 錯誤回應中包含的其他信息專案。

名稱 類型 Description
key

string

指定 Value 屬性意義的識別碼。
value

string

錯誤回應隨附的其他資訊。

ComputeNodeDeallocationOption

列舉型別

決定在選取要解除分配的計算節點及其執行中工作之後，該怎麼做。

值 Description
requeue

終止執行中的工作進程並重新排入佇列。 當計算節點可用時，工作會再次執行。 一旦工作終止，請移除計算節點。
retaineddata

允許目前執行的工作完成，然後等候所有工作數據保留期間到期。 在等候時排程沒有新的工作。 當所有工作保留期間都過期時，請移除計算節點。
taskcompletion

允許目前正在執行的工作完成。 在等候時排程沒有新的工作。 當所有工作完成時，請移除計算節點。
terminate

終止執行中的工作。 工作將會以 failureInfo 完成，指出它們已終止，而且不會再次執行。 一旦工作終止，請移除計算節點。

ErrorMessage

Object

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱 類型 Description
lang

string

錯誤訊息的語言代碼
value

string

訊息的文字。

NodeRemoveParameter

Object

從集區移除計算節點的選項。

名稱 類型 Description
nodeDeallocationOption

ComputeNodeDeallocationOption

決定在選取要解除分配的計算節點及其執行中工作之後，該怎麼做。
預設值為重新排入佇列。
nodeList

string[]

清單，其中包含要從指定集區移除之計算節點的標識碼。
每個要求最多可以移除100個節點。
resizeTimeout

string (duration)

將計算節點移除至集區的逾時。
預設值是 15 分鐘。 最小值為 5 分鐘。 如果您指定小於 5 分鐘的值，Batch 服務會傳回錯誤;如果您直接呼叫 REST API，則 HTTP 狀態代碼為 400 （不正確的要求）。