Aracılığıyla paylaş

Pools - List Pool Usage Metrics

Hizmet:
Batch Service
API Sürümü:
2025-06-01

Belirtilen Hesap için tek tek zaman aralıklarında Havuz tarafından toplanan kullanım ölçümlerini listeler.
poolId içeren bir $filter yan tümcesi belirtmezseniz, yanıt, döndürülen toplama aralıklarının zaman aralığında hesapta bulunan tüm Havuzları içerir. startTime veya endTime dahil olmak üzere bir $filter yan tümcesi belirtmezseniz, bu filtreler şu anda kullanılabilir olan son toplama aralığının başlangıç ve bitiş saatlerine varsayılan olarak atanır; yani, yalnızca son toplama aralığı döndürülür.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01
İsteğe bağlı parametrelerle: 
GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}

URI Parametreleri

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

string (uri)

Batch hesabı uç noktası (örneğin: https://batchaccount.eastus2.batch.azure.com).
api-version
 query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.
$filter
 query

string

OData $filter yan tümcesi. Bu filtrenin oluşturulması hakkında daha fazla bilgi için bkz.https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics
endtime
 query

string (date-time)

Metrikleri eklemek için en son zaman. Bu, mevcut saatten en az iki saat önce olmalı. Belirtilmediyse, varsayılan olarak mevcut son toplama aralığının bitiş zamanına dayanır.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

Yanıtta döndürülecek en fazla öğe sayısı. En fazla 1000 başvuru iade edilebilir.
startTime
 query

string (date-time)

Metriklerin dahil edilmesi için en erken zaman. Bu, mevcut saatten en az iki buçuk saat önce olmalı. Belirtilmediyse, varsayılan olarak mevcut son toplama aralığının başlangıç zamanına göre belirlenir.
timeOut
 query

integer (int32)

Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye cinsinden). Varsayılan değer 30 saniyedir. Değer 30'dan büyükse, varsayılan kullanılacaktır.".

İstek Başlığı

Name Gerekli Tür Description
client-request-id

string

Arayan tarafından oluşturulan istek kimliği, küme ayraçları gibi süslemesi olmayan bir GUID biçiminde, ö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-rfc7231)

İ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.

Yanıtlar

Name Tür Description
200 OK

BatchPoolListUsageMetricsResult

İstek başarılı oldu.

Üst Bilgiler

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

BatchError

Beklenmeyen bir hata yanıtı.

Güvenlik

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name Description
https://batch.core.windows.net//.default

Örnekler

Pool list usage metrics

Örnek isteği

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

Örnek yanıt

Durum kodu:
200 
{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

Tanımlar

Name Description
BatchError

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

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

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

Bir Hesabın kullanım ölçümlerini listelemenin sonucu.
BatchPoolUsageMetrics

Toplama aralığı boyunca havuz için kullanım ölçümleri.

BatchError

Nesne

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

BatchErrorMessage

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

BatchErrorDetail[]

Hata hakkında ek ayrıntılar içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Nesne

Azure Batch hata yanıtına dahil edilen 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.

BatchErrorMessage

Nesne

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

Name Tür Description
lang

string

Hata mesajının dil kodu.
value

string

İletinin metni.

BatchPoolListUsageMetricsResult

Nesne

Bir Hesabın kullanım ölçümlerini listelemenin sonucu.

Name Tür Description
odata.nextLink

string (uri)

Bir sonraki sonuç kümesini almak için URL.
value

BatchPoolUsageMetrics[]

Havuz kullanım metrikleri verileri.

BatchPoolUsageMetrics

Nesne

Toplama aralığı boyunca havuz için kullanım ölçümleri.

Name Tür Description
endTime

string (date-time)

Bu girişin kapsadığı toplama aralığının bitiş zamanı.
poolId

string

Bu girişte metrikleri toplanmış Havuzun kimliği.
startTime

string (date-time)

Bu girişin kapsadığı toplama aralığının başlangıç zamanı.
totalCoreHours

number (float)

Bu toplama aralığında havuzda kullanılan toplam çekirdek saatleri.
vmSize

string

Havuzdaki sanal makinelerin boyutu. Bir Havuzdaki tüm VM'ler aynı boyutta. Havuzlardaki sanal makinelerin kullanılabilir boyutları hakkında bilgi için bkzhttps://learn.microsoft.com/azure/batch/batch-pool-vm-sizes.