Database Accounts - List Metrics
Recupera las métricas determinadas por el filtro especificado para la cuenta de base de datos especificada.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics?api-version=2023-11-15&$filter={$filter}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nombre de la cuenta de base de datos de Cosmos DB. Regex pattern: |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
$filter
|
query | True |
string |
Expresión de filtro de OData que describe un subconjunto de métricas que se van a devolver. Los parámetros que se pueden filtrar son name.value (nombre de la métrica, puede tener o varios nombres), startTime, endTime y timeGrain. El operador admitido es eq. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Las métricas de la cuenta de base de datos se recuperaron correctamente. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Ejemplos
CosmosDBDatabaseAccountGetMetrics
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metrics?api-version=2023-11-15&$filter=$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z
Sample Response
{
"value": [
{
"timeGrain": "PT5M",
"startTime": "2017-11-19T23:53:55.2780000Z",
"endTime": "2017-11-20T00:13:55.2780000Z",
"unit": "Count",
"metricValues": [
{
"timestamp": "2017-11-19T23:53:55.2780000Z",
"total": 0,
"_count": 0,
"average": 0
},
{
"timestamp": "2017-11-19T23:58:55.2780000Z",
"total": 0,
"_count": 0,
"average": 0
},
{
"timestamp": "2017-11-20T00:03:55.2780000Z",
"total": 0,
"_count": 0,
"average": 0
},
{
"timestamp": "2017-11-20T00:08:55.2780000Z",
"total": 0,
"_count": 0,
"average": 0
}
],
"name": {
"value": "Total Requests",
"localizedValue": "Total Requests"
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Metric |
Datos métricos |
Metric |
Respuesta a una solicitud de métricas de lista. |
Metric |
Un nombre para la métrica. |
Metric |
Representa valores de métricas. |
Unit |
Unidad de la métrica. |
Metric
Datos métricos
Nombre | Tipo | Description |
---|---|---|
endTime |
string |
Hora de finalización de la métrica (formato ISO-8601). |
metricValues |
Valores de métricas para el período de tiempo y el intervalo de tiempo especificados. |
|
name |
Información de nombre de la métrica. |
|
startTime |
string |
Hora de inicio de la métrica (formato ISO-8601). |
timeGrain |
string |
Intervalo de tiempo que se va a usar para resumir los valores de las métricas. |
unit |
Unidad de la métrica. |
MetricListResult
Respuesta a una solicitud de métricas de lista.
Nombre | Tipo | Description |
---|---|---|
value |
Metric[] |
Lista de métricas de la cuenta. |
MetricName
Un nombre para la métrica.
Nombre | Tipo | Description |
---|---|---|
localizedValue |
string |
Nombre descriptivo de la métrica. |
value |
string |
El nombre de la métrica. |
MetricValue
Representa valores de métricas.
Nombre | Tipo | Description |
---|---|---|
_count |
number |
Número de valores de la métrica. |
average |
number |
Valor medio de la métrica. |
maximum |
number |
Valor máximo de la métrica. |
minimum |
number |
Valor mínimo de la métrica. |
timestamp |
string |
Marca de tiempo de métrica (formato ISO-8601). |
total |
number |
Valor total de la métrica. |
UnitType
Unidad de la métrica.
Nombre | Tipo | Description |
---|---|---|
Bytes |
string |
|
BytesPerSecond |
string |
|
Count |
string |
|
CountPerSecond |
string |
|
Milliseconds |
string |
|
Percent |
string |
|
Seconds |
string |