Metrics - List
Listy wartości metryk dla zasobu.
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}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Identyfikator zasobu. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
$filter
|
query |
string |
$filter służy do zmniejszenia zestawu zwracanych danych metryk. |
|
aggregation
|
query |
string |
Lista typów agregacji (rozdzielonych przecinkami) do pobrania. Przykłady: średnia, minimalna, maksymalna |
|
Auto
|
query |
boolean |
Jeśli ustawiono wartość true, jeśli przedział czasu przekazany przez tę metrykę nie jest obsługiwany, interfejs API zwróci wynik przy użyciu najbliższego obsługiwanego przedziału czasu. Po ustawieniu wartości false zostanie zwrócony błąd dla nieprawidłowych parametrów przedziału czasu. Wartość domyślna to false. |
|
interval
|
query |
string |
Interwał (tj. timegrain) zapytania w formacie czasu trwania ISO 8601. Wartość domyślna to PT1M. Specjalny przypadek dla wartości "FULL", która zwraca pojedynczy punkt danych dla całego żądanego przedziału czasu. Przykłady: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Nazwy metryk (rozdzielone przecinkami) do pobrania. |
|
metricnamespace
|
query |
string |
Przestrzeń nazw metryk, w której znajdują się metryki. |
|
orderby
|
query |
string |
Agregacja używana do sortowania wyników i kierunku sortowania. Można określić tylko jedno zamówienie. Przykłady: sum asc |
|
result
|
query |
Zmniejsza zestaw zebranych danych. Dozwolona składnia zależy od operacji. Aby uzyskać szczegółowe informacje, zobacz opis operacji. |
||
rollupby
|
query |
string |
Nazwy wymiarów do zestawienia wyników według. Jeśli na przykład chcesz wyświetlić tylko wartości metryk z filtrem, na przykład "City eq Seattle lub City eq Tacoma", ale nie chcesz widzieć oddzielnych wartości dla każdego miasta, możesz określić wartość "RollUpBy=City", aby zobaczyć wyniki dla Seattle i Tacoma zwinięte w jeden czasorzy. |
|
timespan
|
query |
string |
Przedział czasu zapytania. Jest to ciąg o następującym formacie "startDateTime_ISO/endDateTime_ISO". |
|
top
|
query |
integer int32 |
Maksymalna liczba rekordów do pobrania na identyfikator zasobu w żądaniu. Prawidłowy tylko wtedy, gdy określono filtr. Wartość domyślna to 10. |
|
Validate
|
query |
boolean |
Po ustawieniu wartości false nieprawidłowe wartości parametrów filtru zostaną zignorowane. Po ustawieniu wartości true zostanie zwrócony błąd dla nieprawidłowych parametrów filtru. Wartość domyślna to true. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślne żądanie pobrania listy wartości metryk. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"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"
}
Definicje
Nazwa | Opis |
---|---|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Odpowiedź na błąd |
Localizable |
Lokalizowalna klasa ciągów. |
Metadata |
Reprezentuje wartość metadanych metryk. |
Metric |
Dane wynikowe zapytania. |
Metric |
Jednostka metryki. |
Metric |
Reprezentuje wartość metryki. |
Response |
Odpowiedź na zapytanie metryk. |
Result |
Zmniejsza zestaw zebranych danych. Dozwolona składnia zależy od operacji. Aby uzyskać szczegółowe informacje, zobacz opis operacji. |
Time |
Typ wyniku szeregów czasowych. W tym przypadku wartość dyskryminująca jest zawsze wartością TimeSeries. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
LocalizableString
Lokalizowalna klasa ciągów.
Nazwa | Typ | Opis |
---|---|---|
localizedValue |
string |
Nazwa wyświetlana. |
value |
string |
Niezmienna wartość. |
MetadataValue
Reprezentuje wartość metadanych metryk.
Nazwa | Typ | Opis |
---|---|---|
name |
Nazwa metadanych. |
|
value |
string |
Wartość metadanych. |
Metric
Dane wynikowe zapytania.
Nazwa | Typ | Opis |
---|---|---|
displayDescription |
string |
Szczegółowy opis tej metryki. |
errorCode |
string |
"Powodzenie" lub szczegóły błędu dotyczące niepowodzeń zapytań dla tej metryki. |
errorMessage |
string |
Napotkano komunikat o błędzie podczas wykonywania zapytań dotyczących tej konkretnej metryki. |
id |
string |
Identyfikator metryki. |
name |
Nazwa i nazwa wyświetlana metryki, czyli ciąg lokalizowalny. |
|
timeseries |
Szereg czasowy zwracany po wykonaniu zapytania o dane. |
|
type |
string |
Typ zasobu metryki. |
unit |
Jednostka metryki. |
MetricUnit
Jednostka metryki.
Nazwa | Typ | Opis |
---|---|---|
BitsPerSecond |
string |
Jednostka współczynnika cyfr binarnych na sekundę. |
ByteSeconds |
string |
Jednostka transferu danych lub magazynu. Jest to rozmiar danych w bajtach pomnożony przez czas potrzebny na transfer lub przechowywanie danych w sekundach. |
Bytes |
string |
Jednostka pamięci w bajtach. |
BytesPerSecond |
string |
Szybkość jednostki pamięci w bajtach na sekundę. |
Cores |
string |
Jednostka mocy obliczeniowej. |
Count |
string |
Jednostka ilości pierwotnej. |
CountPerSecond |
string |
Jednostka stawki ilości pierwotnej na sekundę. |
MilliCores |
string |
Jednostka mocy obliczeniowej w 1/1000 rdzenia procesora CPU. |
MilliSeconds |
string |
Jednostka czasu w 1/1000 sekundy. |
NanoCores |
string |
Jednostka mocy obliczeniowej w miliardach rdzeni procesora CPU. |
Percent |
string |
Jednostka procentowa. |
Seconds |
string |
Jednostka czasu w sekundach. |
Unspecified |
string |
Nie określono jednostki. |
MetricValue
Reprezentuje wartość metryki.
Nazwa | Typ | Opis |
---|---|---|
average |
number |
Średnia wartość w zakresie czasu. |
count |
number |
Liczba próbek w zakresie czasu. Może służyć do określenia liczby wartości, które przyczyniły się do wartości średniej. |
maximum |
number |
Największa wartość w zakresie czasu. |
minimum |
number |
Najmniejsza wartość w zakresie czasu. |
timeStamp |
string |
Sygnatura czasowa wartości metryki w formacie ISO 8601. |
total |
number |
Suma wszystkich wartości w zakresie czasu. |
Response
Odpowiedź na zapytanie metryk.
Nazwa | Typ | Opis |
---|---|---|
cost |
number |
Wartość całkowita reprezentująca względny koszt zapytania. |
interval |
string |
Interwał (rozmiar okna), dla którego dane metryki zostały zwrócone w formacie czasu trwania ISO 8601 ze specjalnym przypadkiem dla wartości "FULL", która zwraca pojedynczy punkt danych dla całego żądanego przedziału czasu (przykłady: PT15M, PT1H, P1D, FULL). Można to dostosować i różnić się od tego, czego pierwotnie zażądano, jeśli określono parametr AutoAdjustTimegrain=true. Nie jest to obecne, jeśli zostało wykonane żądanie metadanych. |
namespace |
string |
Przestrzeń nazw zapytań dotyczących metryk |
resourceregion |
string |
Region zasobu, którego dotyczy zapytanie o metryki. |
timespan |
string |
Przedział czasu, dla którego pobrano dane. Jego wartość składa się z dwóch połączonych dat/godzin rozdzielonych znakami "/". Może to zostać skorygowane w przyszłości i zwrócone z tego, czego pierwotnie zażądano. |
value |
Metric[] |
Wartość kolekcji. |
ResultType
Zmniejsza zestaw zebranych danych. Dozwolona składnia zależy od operacji. Aby uzyskać szczegółowe informacje, zobacz opis operacji.
Nazwa | Typ | Opis |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Typ wyniku szeregów czasowych. W tym przypadku wartość dyskryminująca jest zawsze wartością TimeSeries.
Nazwa | Typ | Opis |
---|---|---|
data |
Tablica punktów danych reprezentujących wartości metryk. Jest to zwracane tylko wtedy, gdy określono typ wyniku danych. |
|
metadatavalues |
Wartości metadanych zwrócone, jeśli $filter zostały określone w wywołaniu. |