Metrics - List
Kaynakiçin ölçüm değerlerini listeler. Bu API,
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}
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
Kaynağın tanımlayıcısı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
|
$filter
|
query |
string |
$filter, döndürülen ölçüm verileri kümesini azaltmak için kullanılır. |
|
|
aggregation
|
query |
string |
Alınacak toplama türlerinin (virgülle ayrılmış) listesi. Örnekleri: ortalama, en düşük, en yüksek |
|
|
Auto
|
query |
boolean |
true olarak ayarlandığında, geçirilen zaman aralığı bu ölçüm tarafından desteklenmiyorsa, API desteklenen en yakın zaman aralığını kullanarak sonucu döndürür. false olarak ayarlandığında, geçersiz zaman aralığı parametreleri için bir hata döndürülür. Varsayılan değer false'tur. |
|
|
interval
|
query |
string |
Sorgunun ISO 8601 süre biçimindeki aralığı (yani timegrain). Varsayılan olarak PT1M'yi kullanır. İstenen tüm zaman aralığı için tek bir veri noktası döndüren 'FULL' değeri için özel durum. Örnekleri: PT15M, PT1H, P1D, FULL |
|
|
metricnames
|
query |
string |
Alınacak ölçümlerin (virgülle ayrılmış) adları. 20 ölçümü sınırlayın. |
|
|
metricnamespace
|
query |
string |
İstediğiniz ölçümlerin bulunduğu ölçüm ad alanı. |
|
|
orderby
|
query |
string |
Sonuçları sıralamak için kullanılacak toplama ve sıralamanın yönü. Yalnızca bir sipariş belirtilebilir. Örnekleri: sum asc |
|
|
result
|
query |
Toplanan veri kümesini azaltır. İzin verilen söz dizimi işleme bağlıdır. Ayrıntılar için işlemin açıklamasına bakın. |
||
|
rollupby
|
query |
string |
Sonuçların toplaması için boyut adları. Örneğin, yalnızca 'City eq Seattle veya City eq Tacoma' gibi bir filtreye sahip ölçüm değerlerini görmek istiyor ancak her şehir için ayrı değerler görmek istemiyorsanız, Seattle ve Tacoma'nın sonuçlarını tek bir zaman aralığına almak için 'RollUpBy=City' belirtebilirsiniz. |
|
|
timespan
|
query |
string |
Sorgunun zaman aralığı. 'startDateTime_ISO/endDateTime_ISO' biçiminde bir dizedir. |
|
|
top
|
query |
integer (int32) |
İstekteki kaynak kimliği başına alınacak en fazla kayıt sayısı. Yalnızca filtre belirtilmişse geçerlidir. Varsayılan değer 10'dır. |
|
|
Validate
|
query |
boolean |
false olarak ayarlandığında geçersiz filtre parametresi değerleri yoksayılır. true olarak ayarlandığında, geçersiz filtre parametreleri için bir hata döndürülür. Varsayılan değer true'dır. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
Ölçüm değerlerinin listesini alma isteği başarılı oldu. |
|
| Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 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 |
Örnekler
| Get Metric for data |
| Get Metric for metadata |
| Get Metric with error |
Get Metric for data
Örnek isteği
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
Örnek yanıt
{
"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
Örnek isteği
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
Örnek yanıt
{
"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
Örnek isteği
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
Örnek yanıt
{
"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"
}
Tanımlar
| Name | Description |
|---|---|
|
Error |
Kaynak yönetimi hatası ek bilgileri. |
|
Error |
Hata Yanıtı |
|
Localizable |
Yerelleştirilebilir dize sınıfı. |
|
Metadata |
Ölçüm meta veri değerini temsil eder. |
| Metric |
Sorgunun sonuç verileri. |
|
Metric |
Ölçümün birimi. |
|
Metric |
Bir ölçüm değerini temsil eder. |
| Response |
Ölçüm sorgusuna verilen yanıt. |
|
Result |
Toplanan veri kümesini azaltır. İzin verilen söz dizimi işleme bağlıdır. Ayrıntılar için işlemin açıklamasına bakın. |
|
Time |
Zaman serisi sonuç türü. Ayrıştırıcı değeri bu durumda her zaman TimeSeries'dir. |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
| Name | Tür | Description |
|---|---|---|
| info |
object |
Ek bilgiler. |
| type |
string |
Ek bilgi türü. |
ErrorResponse
Hata Yanıtı
| Name | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgileri. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi. |
LocalizableString
Yerelleştirilebilir dize sınıfı.
| Name | Tür | Description |
|---|---|---|
| localizedValue |
string |
Görünen ad. |
| value |
string |
Sabit değer. |
MetadataValue
Ölçüm meta veri değerini temsil eder.
| Name | Tür | Description |
|---|---|---|
| name |
Meta verilerin adı. |
|
| value |
string |
Meta verilerin değeri. |
Metric
Sorgunun sonuç verileri.
| Name | Tür | Description |
|---|---|---|
| displayDescription |
string |
Bu ölçümün ayrıntılı açıklaması. |
| errorCode |
string |
'Başarılı' veya bu ölçüm için sorgu hatalarıyla ilgili hata ayrıntıları. |
| errorMessage |
string |
Bu ölçüm sorgulanırken hata iletisiyle karşılaşıldı. |
| id |
string |
Ölçüm kimliği. |
| name |
Ölçümün adı ve görünen adı, yani yerelleştirilebilir dizedir. |
|
| timeseries |
Veri sorgusu gerçekleştirildiğinde döndürülen zaman serisi. |
|
| type |
string |
Ölçüm kaynağının kaynak türü. |
| unit |
Ölçümün birimi. |
MetricUnit
Ölçümün birimi.
| Değer | Description |
|---|---|
| Count |
Ham miktar birimi. |
| Bytes |
Bayt cinsinden bellek birimi. |
| Seconds |
Saniye olarak zaman birimi. |
| CountPerSecond |
Saniye başına ham miktarın fiyat birimi. |
| BytesPerSecond |
Bellek birimini saniye başına bayt cinsinden derecelendir. |
| Percent |
Yüzde birimi. |
| MilliSeconds |
Saniyenin 1/1000'inde zaman birimi. |
| ByteSeconds |
Veri aktarımı veya depolama birimi. Verilerin bayt cinsinden boyutu, verileri saniye cinsinden aktarmak veya depolamak için geçen süreyle çarpılır. |
| Unspecified |
Belirtilen birim yok. |
| Cores |
İşlem gücü birimi. |
| MilliCores |
CPU çekirdeğinin 1/1000'inde işlem gücü birimi. |
| NanoCores |
CPU çekirdeğinin milyarda birinde işlem gücü birimi. |
| BitsPerSecond |
saniye başına ikili basamakların hız birimi. |
MetricValue
Bir ölçüm değerini temsil eder.
| Name | Tür | Description |
|---|---|---|
| average |
number (double) |
Zaman aralığındaki ortalama değer. |
| count |
number (double) |
Zaman aralığındaki örneklerin sayısı. Ortalama değere katkıda bulunan değerlerin sayısını belirlemek için kullanılabilir. |
| maximum |
number (double) |
Zaman aralığındaki en büyük değer. |
| minimum |
number (double) |
Zaman aralığındaki en küçük değer. |
| timeStamp |
string (date-time) |
ISO 8601 biçimindeki ölçüm değerinin zaman damgası. |
| total |
number (double) |
Zaman aralığındaki tüm değerlerin toplamı. |
Response
Ölçüm sorgusuna verilen yanıt.
| Name | Tür | Description |
|---|---|---|
| cost |
number (int32) minimum: 0 |
Sorgunun göreli maliyetini temsil eden tamsayı değeri. |
| interval |
string |
Ölçüm verilerinin ISO 8601 süre biçiminde döndürüldüğü aralık (pencere boyutu), istenen tüm zaman aralığı için tek bir veri noktası döndüren 'FULL' değeri için özel bir durumla (Örnekler: PT15M, PT1H, P1D, FULL). Bu ayarlanabilir ve AutoAdjustTimegrain=true belirtilirse başlangıçta istenenden farklı olabilir. Meta veri isteğinde bulunulduysa bu mevcut değildir. |
| namespace |
string |
Sorgulanan ölçümlerin ad alanı |
| resourceregion |
string |
Ölçümler için sorgulanan kaynağın bölgesi. |
| timespan |
string |
Verilerin alındığı zaman aralığı. Değeri, '/' ile ayrılmış iki tarih saatlerinden oluşur. Bu, gelecekte ayarlanabilir ve başlangıçta istenenden geri döndürülebilir. |
| value |
Metric[] |
Koleksiyonun değeri. |
ResultType
Toplanan veri kümesini azaltır. İzin verilen söz dizimi işleme bağlıdır. Ayrıntılar için işlemin açıklamasına bakın.
| Değer | Description |
|---|---|
| Data | |
| Metadata |
TimeSeriesElement
Zaman serisi sonuç türü. Ayrıştırıcı değeri bu durumda her zaman TimeSeries'dir.
| Name | Tür | Description |
|---|---|---|
| data |
Ölçüm değerlerini temsil eden bir veri noktaları dizisi. Bu yalnızca bir sonuç türü belirtilmişse döndürülür. |
|
| metadatavalues |
Çağrıda $filter belirtildiyse döndürülen meta veri değerleri. |