Pool - List Usage Metrics

  • Referensi
Service:
Batch Service
API Version:
2022-01-01.15.0

Mencantumkan metrik penggunaan, yang diagregasi menurut Kumpulan di seluruh interval waktu individual, untuk Akun yang ditentukan.
Jika Anda tidak menentukan klausa $filter termasuk poolId, respons mencakup semua Kumpulan yang ada di Akun dalam rentang waktu interval agregasi yang dikembalikan. Jika Anda tidak menentukan klausa $filter termasuk startTime atau endTime, filter ini default ke waktu mulai dan berakhir dari interval agregasi terakhir yang saat ini tersedia; artinya, hanya interval agregasi terakhir yang dikembalikan.

GET {batchUrl}/poolusagemetrics?api-version=2022-01-01.15.0
With optional parameters: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

Parameter URI

Name In Required Type Description
batchUrl
 path True
  • string

URL dasar untuk semua permintaan layanan Azure Batch.
api-version
 query True
  • string

Versi API Klien.
$filter
 query
  • string

Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query
  • string
date-time

Waktu terbaru untuk menyertakan metrik. Ini harus setidaknya dua jam sebelum waktu saat ini. Jika tidak ditentukan, default ini ke waktu akhir interval agregasi terakhir yang saat ini tersedia.
maxresults
 query
  • integer
int32

Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 hasil akan dikembalikan.
starttime
 query
  • string
date-time

Waktu paling awal untuk menyertakan metrik. Ini harus setidaknya dua setengah jam sebelum waktu saat ini. Jika tidak ditentukan, default ini ke waktu mulai interval agregasi terakhir yang saat ini tersedia.
timeout
 query
  • integer
int32

Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik.

Header Permintaan

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

Name Required Type Description
client-request-id
  • string
uuid

Identitas permintaan yang dihasilkan pemanggil, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id
  • boolean

Apakah server harus mengembalikan client-request-id dalam respons.
ocp-date
  • string
date-time-rfc1123

Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Respons

Name Type Description
200 OK

Respons yang berisi daftar detail penggunaan Kumpulan.

Headers

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

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

Pool list usage metrics

Sample Request

GET account.region.batch.azure.com/poolusagemetrics?api-version=2022-01-01.15.0

Sample Response

Status code:
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
    }
  ]
}

Definisi

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ErrorMessage

Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.
PoolListUsageMetricsResult

Hasil daftar metrik penggunaan untuk Akun.
PoolUsageMetrics

Metrik penggunaan untuk Kumpulan di seluruh interval agregasi.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Name Type Description
code
  • string

Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
message

Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values

Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Name Type Description
key
  • string

Pengidentifikasi yang menentukan arti properti Nilai.
value
  • string

Informasi tambahan disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.

Name Type Description
lang
  • string

Kode bahasa pesan kesalahan
value
  • string

Teks pesan.

PoolListUsageMetricsResult

Hasil daftar metrik penggunaan untuk Akun.

Name Type Description
odata.nextLink
  • string

URL untuk mendapatkan serangkaian hasil berikutnya.
value

Data metrik penggunaan Kumpulan.

PoolUsageMetrics

Metrik penggunaan untuk Kumpulan di seluruh interval agregasi.

Name Type Description
endTime
  • string

Waktu akhir interval agregasi yang dicakup oleh entri ini.
poolId
  • string

ID Kumpulan yang metriknya diagregasi dalam entri ini.
startTime
  • string

Waktu mulai interval agregasi yang dicakup oleh entri ini.
totalCoreHours
  • number

Total jam inti yang digunakan dalam Kumpulan selama interval agregasi ini.
vmSize
  • string

Ukuran komputer virtual di Kumpulan. Semua VM dalam Kumpulan berukuran sama.
Untuk informasi tentang ukuran komputer virtual yang tersedia di Kumpulan, lihat Memilih ukuran VM untuk Simpul Komputasi dalam Kumpulan Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).