Metrics - List
Mencantumkan nilai metrik untuk sumber daya. API ini menggunakan batas pembatasan ARM default .
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?api-version=2023-10-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&api-version=2023-10-01&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Pengidentifikasi sumber daya. |
api-version
|
query | True |
string |
Versi API yang akan digunakan untuk operasi ini. |
$filter
|
query |
string |
$filter digunakan untuk mengurangi kumpulan data metrik yang dikembalikan. |
|
aggregation
|
query |
string |
Daftar jenis agregasi (dipisahkan koma) untuk diambil. Contoh: rata-rata, minimum, maksimum |
|
Auto
|
query |
boolean |
Ketika diatur ke true, jika rentang waktu yang diteruskan tidak didukung oleh metrik ini, API akan mengembalikan hasilnya menggunakan rentang waktu yang didukung terdekat. Ketika diatur ke false, kesalahan dikembalikan untuk parameter rentang waktu yang tidak valid. Default ke false. |
|
interval
|
query |
string |
Interval (yaitu timegrain) kueri dalam format durasi ISO 8601. Default ke PT1M. Kasus khusus untuk nilai 'PENUH' yang mengembalikan titik data tunggal untuk rentang waktu yang diminta. Contoh : PT15M, PT1H, P1D, full |
|
metricnames
|
query |
string |
Nama metrik (dipisahkan koma) untuk diambil. Batas 20 metrik. |
|
metricnamespace
|
query |
string |
Namespace metrik tempat metrik yang anda inginkan berada. |
|
orderby
|
query |
string |
Agregasi yang digunakan untuk mengurutkan hasil dan arah pengurutan. Hanya satu pesanan yang dapat ditentukan. Contoh : menjumlahkan asc |
|
result
|
query |
Mengurangi kumpulan data yang dikumpulkan. Sintaks yang diizinkan tergantung pada operasi. Lihat deskripsi operasi untuk detailnya. |
||
rollupby
|
query |
string |
Nama dimensi untuk menggulung hasil. Misalnya jika Anda hanya ingin melihat nilai metrik dengan filter seperti 'City eq Seattle atau City eq Tacoma' tetapi tidak ingin melihat nilai terpisah untuk setiap kota, Anda dapat menentukan 'RollUpBy=City' untuk melihat hasil untuk Seattle dan Tacoma digulung menjadi satu kali. |
|
timespan
|
query |
string |
Rentang waktu kueri. Ini adalah string dengan format berikut 'startDateTime_ISO/endDateTime_ISO'. |
|
top
|
query |
integer int32 |
Jumlah maksimum rekaman yang akan diambil per ID sumber daya dalam permintaan. Valid hanya jika filter ditentukan. Default ke 10. |
|
Validate
|
query |
boolean |
Ketika diatur ke false, nilai parameter filter yang tidak valid akan diabaikan. Ketika diatur ke true, kesalahan dikembalikan untuk parameter filter yang tidak valid. Default ke true. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Permintaan berhasil untuk mendapatkan daftar nilai metrik. |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Permintaan sampel
GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2021-04-20T09:00:00.000Z/2021-04-20T14:00:00.000Z&interval=PT6H&metricnames=BlobCount,BlobCapacity&aggregation=average,minimum,maximum&top=5&orderby=average asc&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices&AutoAdjustTimegrain=True&ValidateDimensions=False
Respon sampel
{
"cost": 598,
"timespan": "2021-04-20T09:00:00Z/2021-04-20T14:00:00Z",
"interval": "PT1H",
"value": [
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCount",
"localizedValue": "Blob Count"
},
"displayDescription": "The number of blob objects stored in the storage account.",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
}
],
"errorCode": "Success"
},
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCapacity",
"localizedValue": "Blob Capacity"
},
"displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
"unit": "Bytes",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
}
],
"errorCode": "Success"
}
],
"namespace": "microsoft.storage/storageaccounts/blobservices",
"resourceregion": "westus2"
}
Get Metric for metadata
Permintaan sampel
GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices
Respon sampel
{
"timespan": "2021-04-15T02:18:00Z/2021-04-22T02:18:00Z",
"interval": "PT1H",
"value": [
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCount",
"localizedValue": "Blob Count"
},
"displayDescription": "The number of blob objects stored in the storage account.",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
]
}
]
}
],
"namespace": "microsoft.storage/storageaccounts/blobservices",
"resourceregion": "westus2"
}
Get Metric with error
Permintaan sampel
GET https://management.azure.com/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics?timespan=2021-06-07T21:51:00Z/2021-06-08T01:51:00Z&interval=FULL&metricnames=MongoRequestsCount,MongoRequests&aggregation=average&api-version=2023-10-01&metricnamespace=microsoft.documentdb/databaseaccounts&AutoAdjustTimegrain=True&ValidateDimensions=False
Respon sampel
{
"cost": 239,
"timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z",
"interval": "PT4H",
"value": [
{
"id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "MongoRequestsCount",
"localizedValue": "(deprecated) Mongo Request Rate"
},
"unit": "CountPerSecond",
"timeseries": [],
"errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.",
"errorCode": "InvalidSamplingType"
},
{
"id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "MongoRequests",
"localizedValue": "Mongo Requests"
},
"displayDescription": "Number of Mongo Requests Made",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [],
"data": [
{
"timeStamp": "2021-06-07T21:51:00Z",
"average": 0
}
]
}
],
"errorCode": "Success"
}
],
"namespace": "microsoft.documentdb/databaseaccounts",
"resourceregion": "westus2"
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Respons Kesalahan |
Localizable |
Kelas string yang dapat dilokalkan. |
Metadata |
Mewakili nilai metadata metrik. |
Metric |
Data hasil kueri. |
Metric |
Unit metrik. |
Metric |
Mewakili nilai metrik. |
Response |
Respons terhadap kueri metrik. |
Result |
Mengurangi kumpulan data yang dikumpulkan. Sintaks yang diizinkan tergantung pada operasi. Lihat deskripsi operasi untuk detailnya. |
Time |
Jenis hasil rangkaian waktu. Nilai diskriminator selalu TimeSeries dalam kasus ini. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorResponse
Respons Kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
LocalizableString
Kelas string yang dapat dilokalkan.
Nama | Jenis | Deskripsi |
---|---|---|
localizedValue |
string |
Nama tampilan. |
value |
string |
Nilai invarian. |
MetadataValue
Mewakili nilai metadata metrik.
Nama | Jenis | Deskripsi |
---|---|---|
name |
Nama metadata. |
|
value |
string |
Nilai metadata. |
Metric
Data hasil kueri.
Nama | Jenis | Deskripsi |
---|---|---|
displayDescription |
string |
Deskripsi terperinci tentang metrik ini. |
errorCode |
string |
'Berhasil' atau detail kesalahan tentang kegagalan kueri untuk metrik ini. |
errorMessage |
string |
Terjadi pesan kesalahan saat mengkueri metrik spesifik ini. |
id |
string |
Id metrik. |
name |
Nama dan nama tampilan metrik, yaitu string yang dapat dilokalkan. |
|
timeseries |
Rangkaian waktu ditampilkan saat kueri data dilakukan. |
|
type |
string |
Jenis sumber daya sumber daya metrik. |
unit |
Unit metrik. |
MetricUnit
Unit metrik.
Nama | Jenis | Deskripsi |
---|---|---|
BitsPerSecond |
string |
Unit laju digit biner per detik. |
ByteSeconds |
string |
Unit transfer data atau penyimpanan. Ini adalah ukuran data dalam byte dikalikan dengan waktu yang diperlukan untuk mentransfer atau menyimpan data dalam hitungan detik. |
Bytes |
string |
Unit memori dalam byte. |
BytesPerSecond |
string |
Unit laju memori dalam byte per detik. |
Cores |
string |
Unit daya pemrosesan. |
Count |
string |
Unit kuantitas mentah. |
CountPerSecond |
string |
Unit tarif kuantitas mentah per detik. |
MilliCores |
string |
Unit daya pemrosesan pada 1/1000 dari inti CPU. |
MilliSeconds |
string |
Satuan waktu dalam 1/1000 detik. |
NanoCores |
string |
Unit daya pemrosesan dalam satu miliar inti CPU. |
Percent |
string |
Unit persentase. |
Seconds |
string |
Satuan waktu dalam detik. |
Unspecified |
string |
Tidak ada unit yang ditentukan. |
MetricValue
Mewakili nilai metrik.
Nama | Jenis | Deskripsi |
---|---|---|
average |
number |
Nilai rata-rata dalam rentang waktu. |
count |
number |
Jumlah sampel dalam rentang waktu. Dapat digunakan untuk menentukan jumlah nilai yang berkontribusi pada nilai rata-rata. |
maximum |
number |
Nilai terbesar dalam rentang waktu. |
minimum |
number |
Nilai paling sedikit dalam rentang waktu. |
timeStamp |
string |
Tanda waktu untuk nilai metrik dalam format ISO 8601. |
total |
number |
Jumlah semua nilai dalam rentang waktu. |
Response
Respons terhadap kueri metrik.
Nama | Jenis | Deskripsi |
---|---|---|
cost |
number |
Nilai bilangan bulat yang mewakili biaya relatif kueri. |
interval |
string |
Interval (ukuran jendela) tempat data metrik dikembalikan dalam format durasi ISO 8601 dengan kasus khusus untuk nilai 'FULL' yang mengembalikan titik data tunggal untuk seluruh rentang waktu yang diminta (Contoh: PT15M, PT1H, P1D, FULL). Ini dapat disesuaikan dan berbeda dari apa yang awalnya diminta jika AutoAdjustTimegrain=true ditentukan. Ini tidak ada jika permintaan metadata dibuat. |
namespace |
string |
Namespace metrik yang sedang dikueri |
resourceregion |
string |
Wilayah sumber daya yang dikueri untuk metrik. |
timespan |
string |
Rentang waktu tempat data diambil. Nilainya terdiri dari dua tanggalwaktu yang digabungkan, dipisahkan oleh '/'. Ini dapat disesuaikan di masa mendatang dan dikembalikan dari apa yang awalnya diminta. |
value |
Metric[] |
Nilai koleksi. |
ResultType
Mengurangi kumpulan data yang dikumpulkan. Sintaks yang diizinkan tergantung pada operasi. Lihat deskripsi operasi untuk detailnya.
Nama | Jenis | Deskripsi |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Jenis hasil rangkaian waktu. Nilai diskriminator selalu TimeSeries dalam kasus ini.
Nama | Jenis | Deskripsi |
---|---|---|
data |
Array titik data yang mewakili nilai metrik. Ini hanya dikembalikan jika jenis hasil data ditentukan. |
|
metadatavalues |
Nilai metadata dikembalikan jika $filter ditentukan dalam panggilan. |