Pool - Enable Auto Scale

  • Başvuru
Service:
Batch Service
API Version:
2023-11-01.18.0

Havuz için otomatik ölçeklendirmeyi etkinleştirir.
Havuz üzerinde yeniden boyutlandırma işlemi devam ederken Havuzda otomatik ölçeklendirmeyi etkinleştiremezsiniz. Havuzun otomatik ölçeklendirmesi şu anda devre dışıysa, isteğin bir parçası olarak geçerli bir otomatik ölçeklendirme formülü belirtmeniz gerekir. Havuzun otomatik ölçeklendirmesi zaten etkinse, yeni bir otomatik ölçeklendirme formülü ve/veya yeni bir değerlendirme aralığı belirtebilirsiniz. Aynı Havuz için bu API'yi 30 saniyede bir birden fazla çağıramazsınız.

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 Parametreleri

Name İçinde Gerekli Tür Description
batchUrl
 path True

string

Tüm Azure Batch hizmet isteklerinin temel URL'si.
poolId
 path True

string

Otomatik ölçeklendirmenin etkinleştirileceği Havuzun kimliği.
api-version
 query True

string

İstemci API Sürümü.
timeout
 query

integer

int32

Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir.

İstek Başlığı

Media Types: "application/json; odata=minimalmetadata"

Name Gerekli Tür Description
client-request-id

string

uuid

Çağıran tarafından oluşturulan istek kimliği, küme ayraçları gibi dekorasyonu olmayan bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Sunucunun yanıtta client-request-id döndürip döndürmeyeceği.
ocp-date

string

date-time-rfc1123

İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saatine ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın.
If-Match

string

İstemci tarafından bilinen kaynağın sürümüyle ilişkili bir ETag değeri. İşlem yalnızca kaynağın hizmetteki geçerli ETag değeri istemci tarafından belirtilen değerle tam olarak eşleşiyorsa gerçekleştirilir.
If-None-Match

string

İstemci tarafından bilinen kaynağın sürümüyle ilişkili bir ETag değeri. İşlem yalnızca kaynağın hizmetteki geçerli ETag'i istemci tarafından belirtilen değerle eşleşmiyorsa gerçekleştirilir.
If-Modified-Since

string

date-time-rfc1123

İstemci tarafından bilinen kaynağın son değiştirilme zamanını gösteren zaman damgası. İşlem yalnızca hizmet üzerindeki kaynak belirtilen süreden sonra değiştirilmişse gerçekleştirilir.
If-Unmodified-Since

string

date-time-rfc1123

İstemci tarafından bilinen kaynağın son değiştirilme zamanını gösteren zaman damgası. İşlem yalnızca hizmet üzerindeki kaynak belirtilen süreden sonra değiştirilmediyse gerçekleştirilir.

İstek Gövdesi

Media Types: "application/json; odata=minimalmetadata"

Name Tür Description
autoScaleEvaluationInterval

string

Havuz boyutunun otomatik ölçeklendirme formülüne göre otomatik olarak ayarlandığı zaman aralığı.
Varsayılan değer 15 dakikadır. En düşük ve en yüksek değer sırasıyla 5 dakika ve 168 saattir. 5 dakikadan kısa veya 168 saatten büyük bir değer belirtirseniz, Batch hizmeti isteği geçersiz özellik değeri hatasıyla reddeder; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400'dür (Hatalı İstek). Yeni bir aralık belirtirseniz, mevcut otomatik ölçeklendirme değerlendirme zamanlaması durdurulur ve yeni bir otomatik ölçeklendirme değerlendirme zamanlaması başlatılır ve başlangıç saati bu isteğin verildiği zamandır.
autoScaleFormula

string

Havuzdaki istenen İşlem Düğümü sayısı için formül.
Formül Havuza uygulanmadan önce geçerliliği denetlendi. Formül geçerli değilse Batch hizmeti ayrıntılı hata bilgileriyle isteği reddeder. Bu formülü belirtme hakkında daha fazla bilgi için bkz. Azure Batch Havuzunda İşlem Düğümlerini otomatik olarak ölçeklendirme (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Yanıtlar

Name Tür Description
200 OK

Batch hizmetine yapılan istek başarılı oldu.

Headers

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

BatchError

Batch hizmetinden gelen hata.

Güvenlik

azure_auth

OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra

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

Scopes

Name Description
user_impersonation Kullanıcı hesabınızın kimliğine bürünme

Authorization

Type: apiKey
In: header

Örnekler

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

Tanımlar

Name Description
BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.
PoolEnableAutoScaleParameter

Havuz üzerinde otomatik ölçeklendirmeyi etkinleştirme seçenekleri.

BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

Name Tür Description
code

string

Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
message

ErrorMessage

Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values

BatchErrorDetail[]

Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

Name Tür Description
key

string

Value özelliğinin anlamını belirten tanımlayıcı.
value

string

Hata yanıtına eklenen ek bilgiler.

ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.

Name Tür Description
lang

string

Hata iletisinin dil kodu
value

string

İletinin metni.

PoolEnableAutoScaleParameter

Havuz üzerinde otomatik ölçeklendirmeyi etkinleştirme seçenekleri.

Name Tür Description
autoScaleEvaluationInterval

string

Havuz boyutunun otomatik ölçeklendirme formülüne göre otomatik olarak ayarlandığı zaman aralığı.
Varsayılan değer 15 dakikadır. En düşük ve en yüksek değer sırasıyla 5 dakika ve 168 saattir. 5 dakikadan kısa veya 168 saatten büyük bir değer belirtirseniz, Batch hizmeti isteği geçersiz özellik değeri hatasıyla reddeder; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400'dür (Hatalı İstek). Yeni bir aralık belirtirseniz, mevcut otomatik ölçeklendirme değerlendirme zamanlaması durdurulur ve yeni bir otomatik ölçeklendirme değerlendirme zamanlaması başlatılır ve başlangıç saati bu isteğin verildiği zamandır.
autoScaleFormula

string

Havuzdaki istenen İşlem Düğümü sayısı için formül.
Formül Havuza uygulanmadan önce geçerliliği denetlendi. Formül geçerli değilse Batch hizmeti ayrıntılı hata bilgileriyle isteği reddeder. Bu formülü belirtme hakkında daha fazla bilgi için bkz. Azure Batch Havuzunda İşlem Düğümlerini otomatik olarak ölçeklendirme (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).