Metrics - List
Lista os valores de métrica para um recurso. Essa API usou os limites de limitação ARM padrão .
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 do URI
Name | Em | Necessá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 métricos retornados. |
|
aggregation
|
query |
string |
A lista de tipos de agregação (separados por vírgula) a serem recuperados. Exemplos: média, mínima, máxima |
|
Auto
|
query |
boolean |
Quando definido como true, se o intervalo de tempo passado não for suportado por essa métrica, a API retornará o resultado usando o intervalo de tempo suportado mais próximo. Quando definido como false, um erro é retornado para parâmetros de intervalo 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: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Os nomes das métricas (separadas por vírgula) a serem recuperadas. Limite de 20 métricas. |
|
metricnamespace
|
query |
string |
Namespace de métrica onde residem as métricas desejadas. |
|
orderby
|
query |
string |
A agregação a ser usada para classificar resultados e a direção da classificação. Apenas uma ordem pode ser especificada. Exemplos: sum 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(s) dimensão(ões) para acumular resultados. Por exemplo, se você quiser ver apenas valores métricos 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 agrupados em uma série temporal. |
|
timespan
|
query |
string |
O período de tempo da consulta. É uma string 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, os valores de parâmetros 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
Name | Tipo | Description |
---|---|---|
200 OK |
Solicitação bem-sucedida para obter a lista de valores métricos. |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Segurança
azure_auth
Azure Ative Directory OAuth2 Flow
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | personificar a sua conta de utilizador |
Exemplos
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Pedido de amostra
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
Name | Description |
---|---|
Error |
O erro de gerenciamento de recursos informações adicionais. |
Error |
Resposta de erro |
Localizable |
A classe de cadeia de caracteres localizável. |
Metadata |
Representa um valor de metadados métricos. |
Metric |
Os dados de resultado de uma consulta. |
Metric |
A unidade da métrica. |
Metric |
Representa um valor métrico. |
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. Neste caso, o valor discriminador é sempre TimeSeries. |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorResponse
Resposta de erro
Name | Tipo | Description |
---|---|---|
additionalInfo |
O erro informações adicionais. |
|
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.
Name | Tipo | Description |
---|---|---|
localizedValue |
string |
O nome para exibição. |
value |
string |
O valor invariante. |
MetadataValue
Representa um valor de metadados métricos.
Name | Tipo | Description |
---|---|---|
name |
O nome dos metadados. |
|
value |
string |
O valor dos metadados. |
Metric
Os dados de resultado de uma consulta.
Name | Tipo | Description |
---|---|---|
displayDescription |
string |
Descrição detalhada desta métrica. |
errorCode |
string |
'Sucesso' ou os detalhes do erro em falhas de consulta para esta métrica. |
errorMessage |
string |
Mensagem de erro encontrada consultando essa métrica específica. |
id |
string |
A métrica Id. |
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 métrico. |
unit |
A unidade da métrica. |
MetricUnit
A unidade da métrica.
Name | 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 multiplicado pelo tempo necessário para transferir ou armazenar os dados em segundos. |
Bytes |
string |
Unidade de memória em bytes. |
BytesPerSecond |
string |
Taxa 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 um núcleo de CPU. |
Percent |
string |
Unidade percentual. |
Seconds |
string |
Unidade de tempo em segundos. |
Unspecified |
string |
Nenhuma unidade especificada. |
MetricValue
Representa um valor métrico.
Name | Tipo | Description |
---|---|---|
average |
number |
O valor médio no intervalo de tempo. |
count |
number |
O número de amostras 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 para o 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.
Name | 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 métricos 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 originalmente solicitado 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. O seu valor consiste em duas datas/hora concatenadas, separadas por '/'. Este poderá ser ajustado no futuro e devolvido do que foi inicialmente 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.
Name | Tipo | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Um tipo de resultado de série temporal. Neste caso, o valor discriminador é sempre TimeSeries.
Name | Tipo | Description |
---|---|---|
data |
Uma matriz de pontos de dados que representam os valores métricos. 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. |