Metrics - List
Lista os valores de métrica de um recurso. Essa API usou os limites padrão de limitação do ARM .
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}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O identificador do recurso. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
$filter
|
query |
string |
O $filter é usado para reduzir o conjunto de dados de métrica retornados. |
|
aggregation
|
query |
string |
A lista de tipos de agregação (vírgula separada) a ser recuperada. exemplos de : média, mínimo e máximo |
|
Auto
|
query |
boolean |
Quando definido como true, se o período de tempo passado não for suportado por essa métrica, a API retornará o resultado usando o período de tempo mais próximo com suporte. Quando definido como false, um erro é retornado para parâmetros de tempo de tempo inválidos. O padrão é false. |
|
interval
|
query |
string |
O intervalo (ou seja, timegrain) da consulta no formato de duração ISO 8601. O padrão é PT1M. Caso especial para o valor 'FULL' que retorna um único ponto de dados para todo o período de tempo solicitado. exemplos de : PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Os nomes das métricas (vírgula separadas) a serem recuperadas. Limite de 20 métricas. |
|
metricnamespace
|
query |
string |
Namespace de métrica em que as métricas desejadas residem. |
|
orderby
|
query |
string |
A agregação a ser usada para classificar os resultados e a direção da classificação. Somente uma ordem pode ser especificada. exemplos de : soma asc |
|
result
|
query |
Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Consulte a descrição da operação para obter detalhes. |
||
rollupby
|
query |
string |
Nome(s) da dimensão pelo qual os resultados serão acumulados. Por exemplo, se você quiser ver apenas valores de métrica com um filtro como 'City eq Seattle ou City eq Tacoma', mas não quiser ver valores separados para cada cidade, você pode especificar 'RollUpBy=City' para ver os resultados de Seattle e Tacoma acumulados em uma série de horários. |
|
timespan
|
query |
string |
O período de tempo da consulta. É uma cadeia de caracteres com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'. |
|
top
|
query |
integer int32 |
O número máximo de registros a serem recuperados por ID de recurso na solicitação. Válido somente se o filtro for especificado. O padrão é 10. |
|
Validate
|
query |
boolean |
Quando definido como false, valores de parâmetro de filtro inválidos serão ignorados. Quando definido como true, um erro é retornado para parâmetros de filtro inválidos. O padrão é true. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Solicitação bem-sucedida para obter a lista de valores de métrica. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Solicitação de exemplo
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
Resposta de exemplo
{
"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
Solicitação de exemplo
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
Resposta de exemplo
{
"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
Solicitação de exemplo
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
Resposta de exemplo
{
"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"
}
Definições
Nome | Description |
---|---|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Resposta de erro |
Localizable |
A classe de cadeia de caracteres localizável. |
Metadata |
Representa um valor de metadados de métrica. |
Metric |
Os dados de resultado de uma consulta. |
Metric |
A unidade da métrica. |
Metric |
Representa um valor de métrica. |
Response |
A resposta a uma consulta de métricas. |
Result |
Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Consulte a descrição da operação para obter detalhes. |
Time |
Um tipo de resultado de série temporal. O valor discriminatório é sempre TimeSeries neste caso. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
LocalizableString
A classe de cadeia de caracteres localizável.
Nome | Tipo | Description |
---|---|---|
localizedValue |
string |
O nome de exibição. |
value |
string |
O valor invariável. |
MetadataValue
Representa um valor de metadados de métrica.
Nome | Tipo | Description |
---|---|---|
name |
O nome dos metadados. |
|
value |
string |
O valor dos metadados. |
Metric
Os dados de resultado de uma consulta.
Nome | Tipo | Description |
---|---|---|
displayDescription |
string |
Descrição detalhada dessa métrica. |
errorCode |
string |
'Êxito' ou os detalhes do erro sobre falhas de consulta para essa métrica. |
errorMessage |
string |
Mensagem de erro encontrada consultando essa métrica específica. |
id |
string |
A ID da métrica. |
name |
O nome e o nome de exibição da métrica, ou seja, é uma cadeia de caracteres localizável. |
|
timeseries |
A série temporal retornada quando uma consulta de dados é executada. |
|
type |
string |
O tipo de recurso do recurso de métrica. |
unit |
A unidade da métrica. |
MetricUnit
A unidade da métrica.
Nome | Tipo | Description |
---|---|---|
BitsPerSecond |
string |
Unidade de taxa de dígitos binários por segundo. |
ByteSeconds |
string |
Unidade de transferência ou armazenamento de dados. É o tamanho dos dados em bytes multiplicados pelo tempo necessário para transferir ou armazenar os dados em segundos. |
Bytes |
string |
Unidade de memória em bytes. |
BytesPerSecond |
string |
Taxa de unidade de memória em bytes por segundo. |
Cores |
string |
Unidade de poder de processamento. |
Count |
string |
Unidade de quantidade bruta. |
CountPerSecond |
string |
Unidade de taxa de quantidade bruta por segundo. |
MilliCores |
string |
Unidade de poder de processamento em 1/1000 de um núcleo de CPU. |
MilliSeconds |
string |
Unidade de tempo em 1/1000 de segundo. |
NanoCores |
string |
Unidade de poder de processamento em um bilionésimo de núcleo de CPU. |
Percent |
string |
Unidade percentual. |
Seconds |
string |
Unidade de tempo em segundos. |
Unspecified |
string |
Nenhuma unidade especificada. |
MetricValue
Representa um valor de métrica.
Nome | Tipo | Description |
---|---|---|
average |
number |
O valor médio no intervalo de tempo. |
count |
number |
O número de exemplos no intervalo de tempo. Pode ser usado para determinar o número de valores que contribuíram para o valor médio. |
maximum |
number |
O maior valor no intervalo de tempo. |
minimum |
number |
O menor valor no intervalo de tempo. |
timeStamp |
string |
O carimbo de data/hora do valor da métrica no formato ISO 8601. |
total |
number |
A soma de todos os valores no intervalo de tempo. |
Response
A resposta a uma consulta de métricas.
Nome | Tipo | Description |
---|---|---|
cost |
number |
O valor inteiro que representa o custo relativo da consulta. |
interval |
string |
O intervalo (tamanho da janela) para o qual os dados de métrica foram retornados no formato de duração ISO 8601 com um caso especial para o valor 'FULL' que retorna um único ponto de dados para todo o período de tempo solicitado (Exemplos: PT15M, PT1H, P1D, FULL). Isso pode ser ajustado e diferente do que foi solicitado originalmente se AutoAdjustTimegrain=true for especificado. Isso não está presente se uma solicitação de metadados foi feita. |
namespace |
string |
O namespace das métricas que estão sendo consultadas |
resourceregion |
string |
A região do recurso que está sendo consultado para métricas. |
timespan |
string |
O período de tempo para o qual os dados foram recuperados. Seu valor consiste em dois datetimes concatenados, separados por '/'. Isso pode ser ajustado no futuro e retornado do que foi originalmente solicitado. |
value |
Metric[] |
O valor da coleção. |
ResultType
Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Consulte a descrição da operação para obter detalhes.
Nome | Tipo | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Um tipo de resultado de série temporal. O valor discriminatório é sempre TimeSeries neste caso.
Nome | Tipo | Description |
---|---|---|
data |
Uma matriz de pontos de dados que representa os valores de métrica. Isso só será retornado se um tipo de resultado de dados for especificado. |
|
metadatavalues |
Os valores de metadados retornados se $filter foi especificado na chamada. |