Metrics - List
Enumera los valores de métrica de un recurso. Esta API usó los límites de limitación de ARM predeterminados .
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 identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Identificador del recurso. |
api-version
|
query | True |
string |
Versión de la API que se va a usar para esta operación. |
$filter
|
query |
string |
El $filter se usa para reducir el conjunto de datos de métricas devueltos. |
|
aggregation
|
query |
string |
Lista de tipos de agregación (separados por comas) que se van a recuperar. ejemplos de : promedio, mínimo y máximo |
|
Auto
|
query |
boolean |
Cuando se establece en true, si esta métrica no admite el intervalo de tiempo pasado, la API devolverá el resultado mediante el intervalo de tiempo más cercano admitido. Cuando se establece en false, se devuelve un error para parámetros de intervalo de tiempo no válidos. El valor predeterminado es false. |
|
interval
|
query |
string |
Intervalo (es decir, timegrain) de la consulta en formato de duración ISO 8601. El valor predeterminado es PT1M. Caso especial para el valor "FULL" que devuelve un único punto de datos para todo el intervalo de tiempo solicitado. ejemplos de : PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
Nombres de las métricas (separadas por comas) que se van a recuperar. Limite 20 métricas. |
|
metricnamespace
|
query |
string |
Espacio de nombres de métrica donde residen las métricas que desea. |
|
orderby
|
query |
string |
Agregación que se va a usar para ordenar los resultados y la dirección de la ordenación. Solo se puede especificar un pedido. ejemplos de : suma asc |
|
result
|
query |
Reduce el conjunto de datos recopilados. La sintaxis permitida depende de la operación. Consulte la descripción de la operación para obtener más información. |
||
rollupby
|
query |
string |
Nombres de dimensión por los que se resumen los resultados. Por ejemplo, si solo desea ver valores de métricas con un filtro como "City eq Seattle o City eq Tacoma", pero no quiere ver valores independientes para cada ciudad, puede especificar "RollUpBy=City" para ver los resultados de Seattle y Tacoma inscritos en una serie de veces. |
|
timespan
|
query |
string |
Intervalo de tiempo de la consulta. Es una cadena con el siguiente formato "startDateTime_ISO/endDateTime_ISO". |
|
top
|
query |
integer int32 |
Número máximo de registros que se van a recuperar por identificador de recurso en la solicitud. Válido solo si se especifica el filtro. El valor predeterminado es 10. |
|
Validate
|
query |
boolean |
Cuando se establece en false, se omitirán los valores de parámetro de filtro no válidos. Cuando se establece en true, se devuelve un error para los parámetros de filtro no válidos. El valor predeterminado es true. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Solicitud correcta para obtener la lista de valores de métricas. |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
Solicitud de ejemplo
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
Respuesta de muestra
{
"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
Solicitud de ejemplo
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
Respuesta de muestra
{
"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
Solicitud de ejemplo
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
Respuesta de muestra
{
"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"
}
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Respuesta de error |
Localizable |
Clase de cadena localizable. |
Metadata |
Representa un valor de metadatos de métrica. |
Metric |
Datos de resultado de una consulta. |
Metric |
Unidad de la métrica. |
Metric |
Representa un valor de métrica. |
Response |
Respuesta a una consulta de métricas. |
Result |
Reduce el conjunto de datos recopilados. La sintaxis permitida depende de la operación. Consulte la descripción de la operación para obtener más información. |
Time |
Tipo de resultado de serie temporal. El valor de discriminador siempre es TimeSeries en este caso. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
LocalizableString
Clase de cadena localizable.
Nombre | Tipo | Description |
---|---|---|
localizedValue |
string |
Nombre para mostrar. |
value |
string |
Valor invariable. |
MetadataValue
Representa un valor de metadatos de métrica.
Nombre | Tipo | Description |
---|---|---|
name |
Nombre de los metadatos. |
|
value |
string |
Valor de los metadatos. |
Metric
Datos de resultado de una consulta.
Nombre | Tipo | Description |
---|---|---|
displayDescription |
string |
Descripción detallada de esta métrica. |
errorCode |
string |
"Correcto" o los detalles del error en los errores de consulta de esta métrica. |
errorMessage |
string |
Mensaje de error al consultar esta métrica específica. |
id |
string |
Identificador de métrica. |
name |
El nombre y el nombre para mostrar de la métrica, es decir, es una cadena localizable. |
|
timeseries |
Serie temporal devuelta cuando se realiza una consulta de datos. |
|
type |
string |
Tipo de recurso del recurso de métrica. |
unit |
Unidad de la métrica. |
MetricUnit
Unidad de la métrica.
Nombre | Tipo | Description |
---|---|---|
BitsPerSecond |
string |
Unidad de velocidad de dígitos binarios por segundo. |
ByteSeconds |
string |
Unidad de transferencia de datos o almacenamiento. Es el tamaño de los datos en bytes multiplicados por el tiempo necesario para transferir o almacenar los datos en segundos. |
Bytes |
string |
Unidad de memoria en bytes. |
BytesPerSecond |
string |
Unidad de velocidad de memoria en bytes por segundo. |
Cores |
string |
Unidad de potencia de procesamiento. |
Count |
string |
Unidad de cantidad sin procesar. |
CountPerSecond |
string |
Unidad de velocidad de cantidad sin procesar por segundo. |
MilliCores |
string |
Unidad de potencia de procesamiento en 1/1000 de un núcleo de CPU. |
MilliSeconds |
string |
Unidad de tiempo en 1/1000 de segundo. |
NanoCores |
string |
Unidad de potencia de procesamiento en un milésima parte de un núcleo de CPU. |
Percent |
string |
Unidad de porcentaje. |
Seconds |
string |
Unidad de tiempo en segundos. |
Unspecified |
string |
No se ha especificado ninguna unidad. |
MetricValue
Representa un valor de métrica.
Nombre | Tipo | Description |
---|---|---|
average |
number |
Valor medio en el intervalo de tiempo. |
count |
number |
Número de muestras en el intervalo de tiempo. Se puede usar para determinar el número de valores que han contribuido al valor medio. |
maximum |
number |
Valor máximo en el intervalo de tiempo. |
minimum |
number |
Valor mínimo en el intervalo de tiempo. |
timeStamp |
string |
Marca de tiempo del valor de métrica en formato ISO 8601. |
total |
number |
Suma de todos los valores del intervalo de tiempo. |
Response
Respuesta a una consulta de métricas.
Nombre | Tipo | Description |
---|---|---|
cost |
number |
Valor entero que representa el costo relativo de la consulta. |
interval |
string |
Intervalo (tamaño de ventana) para el que se devolvieron los datos de métricas en formato de duración ISO 8601 con un caso especial para el valor "FULL" que devuelve un único punto de datos para todo el intervalo de tiempo solicitado (Ejemplos: PT15M, PT1H, P1D, FULL). Esto se puede ajustar y diferir de lo que se solicitó originalmente si se especifica AutoAdjustTimegrain=true. Esto no está presente si se realizó una solicitud de metadatos. |
namespace |
string |
Espacio de nombres de las métricas que se consultan |
resourceregion |
string |
Región del recurso que se consulta para las métricas. |
timespan |
string |
Intervalo de tiempo para el que se recuperaron los datos. Su valor consta de dos datetimes concatenados, separados por '/'. Esto puede ajustarse en el futuro y devolverlo de lo que se solicitó originalmente. |
value |
Metric[] |
Valor de la colección. |
ResultType
Reduce el conjunto de datos recopilados. La sintaxis permitida depende de la operación. Consulte la descripción de la operación para obtener más información.
Nombre | Tipo | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
Tipo de resultado de serie temporal. El valor de discriminador siempre es TimeSeries en este caso.
Nombre | Tipo | Description |
---|---|---|
data |
Matriz de puntos de datos que representan los valores de métrica. Esto solo se devuelve si se especifica un tipo de resultado de datos. |
|
metadatavalues |
Los valores de metadatos devueltos si $filter se especificó en la llamada. |