Aracılığıyla paylaş

Pool - List Usage Metrics

  • Başvuru
Hizmet:
Batch Service
API Sürümü:
2024-07-01.20.0

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 {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
İsteğe bağlı parametrelerle: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI Parametreleri

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

string

Tüm Azure Batch hizmet isteklerinin temel URL'si.
api-version
 query True

string

İstemci API Sürümü.
$filter
 query

string

OData $filter yan tümcesi. Bu filtreyi oluşturma hakkında daha fazla bilgi için bkz. https://zcusa.951200.xyz/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

Ölçümlerin dahil olduğu en son saat. Bu, geçerli saatten en az iki saat önce olmalıdır. Belirtilmezse, bu varsayılan değer şu anda kullanılabilir olan son toplama aralığının bitiş saatidir.
maxresults
 query

integer

int32

Yanıtta döndürülecek en fazla öğe sayısı. En fazla 1000 sonuç döndürülür.
starttime
 query

string

date-time

Ölçümlerin eklendiği en erken zaman. Bu, geçerli saatten en az iki buçuk saat önce olmalıdır. Belirtilmezse, bu varsayılan değer şu anda kullanılabilir olan son toplama aralığının başlangıç zamanıdır.
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, bunun yerine varsayılan değer kullanılır.

İstek Başlığı

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

Name Gerekli Tür Description
client-request-id

string

uuid

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

Yanıtlar

Name Tür Description
200 OK

PoolListUsageMetricsResult

Havuz kullanımı ayrıntılarının listesini içeren yanıt.

Üst Bilgiler

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

BatchError

Batch hizmetinden gelen hata.

Güvenlik

azure_auth

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

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

Kapsamlar

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

Authorization

Tür: apiKey
İçinde: header

Örnekler

Pool list usage metrics

Örnek isteği

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

Ö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.
ErrorMessage

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

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

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

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[]

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

BatchErrorDetail

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.

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.

PoolListUsageMetricsResult

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

Name Tür Description
odata.nextLink

string

Sonraki sonuç kümesini almak için URL.
value

PoolUsageMetrics[]

Havuz kullanım ölçümleri verileri.

PoolUsageMetrics

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

Name Tür Description
endTime

string

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

string

Ölçümleri bu girişte toplanan Havuzun kimliği.
startTime

string

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

number

Bu toplama aralığı sırasında Havuz'da kullanılan toplam çekirdek saat sayısı.
vmSize

string

Havuzdaki sanal makinelerin boyutu. Havuzdaki tüm VM'ler aynı boyuttadır.
Havuzlardaki sanal makinelerin kullanılabilir boyutları hakkında bilgi için bkz. Azure Batch Havuzundaki İşlem Düğümleri için VM boyutu seçme (https://zcusa.951200.xyz/azure/batch/batch-pool-vm-sizes).