Pool - Enable Auto Scale

  • 參考
Service:
Batch Service
API Version:
2023-11-01.18.0

啟用集區的自動調整。
如果集區上的重設大小作業正在進行中，您無法在集區上啟用自動調整。 如果集區目前已停用自動調整，您必須在要求中指定有效的自動調整公式。 如果已啟用集區的自動調整，您可以指定新的自動調整公式和/或新的評估間隔。 您無法每隔 30 秒多次呼叫相同的集區此 API。

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.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 秒。

要求標頭

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
autoScaleEvaluationInterval

string

根據自動調整公式自動調整集區大小的時間間隔。
預設值為 15 分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會拒絕要求，並出現無效的屬性值錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。 如果您指定新的間隔，則會停止現有的自動調整評估排程，並啟動新的自動調整評估排程，其開始時間是發出此要求的時間。
autoScaleFormula

string

集區中所需計算節點數目的公式。
公式在套用至集區之前，會先檢查其有效性。 如果公式無效，Batch 服務會拒絕要求，並包含詳細的錯誤資訊。 如需指定此公式的詳細資訊，請參閱自動調整 Azure Batch 集區中的計算節點 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。

回應

名稱 類型 Description
200 OK

Batch 服務的要求成功。

Headers

  • 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 驗證碼流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱 Description
user_impersonation 模擬用戶帳戶

Authorization

Type: apiKey
In: header

範例

Pool enable autoscale

Sample Request

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2023-11-01.18.0



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Sample Response

Status code:
200

定義

名稱 Description
BatchError

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

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

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

在集區上啟用自動調整的選項。

BatchError

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

名稱 類型 Description
code

string

錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
message

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

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

名稱 類型 Description
key

string

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

string

錯誤回應中包含的其他資訊。

ErrorMessage

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

名稱 類型 Description
lang

string

錯誤訊息的語言代碼
value

string

訊息的文字。

PoolEnableAutoScaleParameter

在集區上啟用自動調整的選項。

名稱 類型 Description
autoScaleEvaluationInterval

string

根據自動調整公式自動調整集區大小的時間間隔。
預設值為 15 分鐘。 最小值和最大值分別為 5 分鐘和 168 小時。 如果您指定小於 5 分鐘或大於 168 小時的值，Batch 服務會拒絕要求，並出現無效的屬性值錯誤;如果您要直接呼叫 REST API，HTTP 狀態代碼為 400 (「不正確的要求」) 。 如果您指定新的間隔，則會停止現有的自動調整評估排程，並啟動新的自動調整評估排程，其開始時間是發出此要求的時間。
autoScaleFormula

string

集區中所需計算節點數目的公式。
公式在套用至集區之前，會先檢查其有效性。 如果公式無效，Batch 服務會拒絕要求，並包含詳細的錯誤資訊。 如需指定此公式的詳細資訊，請參閱自動調整 Azure Batch 集區中的計算節點 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。