Percentile - List Metrics

Servicio:: Cosmos DB Resource Provider

Versión de la API:: 2025-04-15

Recupera las métricas determinadas por el filtro especificado para la cuenta de base de datos determinada. Esta dirección URL solo es para datos de latencia de replicación y PBS.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics?api-version=2025-04-15&$filter={$filter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nombre de la cuenta de base de datos de Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	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 minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	PercentileMetricListResult	Las métricas de percentil de la cuenta se recuperaron correctamente.

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 tu cuenta de usuario

Ejemplos

CosmosDBDatabaseAccountRegionGetMetrics

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/percentile/metrics?api-version=2025-04-15&$filter=$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z


/**
 * Samples for Percentile ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBPercentileGetMetrics.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountRegionGetMetrics.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountRegionGetMetrics(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getPercentiles().listMetrics("rg1", "ddb1",
            "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_percentile_get_metrics.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.percentile.list_metrics(
        resource_group_name="rg1",
        account_name="ddb1",
        filter="$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBPercentileGetMetrics.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBPercentileGetMetrics.json
func ExamplePercentileClient_NewListMetricsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPercentileClient().NewListMetricsPager("rg1", "ddb1", "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PercentileMetricListResult = armcosmos.PercentileMetricListResult{
		// 	Value: []*armcosmos.PercentileMetric{
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Probabilistic Bounded Staleness-S-West Central US-T-East US"),
		// 				Value: to.Ptr("Probabilistic Bounded Staleness-S-West Central US-T-East US"),
		// 			},
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:13:55.278Z"); return t}()),
		// 			MetricValues: []*armcosmos.PercentileMetricValue{
		// 				{
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 					P10: to.Ptr[float64](1.11),
		// 					P25: to.Ptr[float64](2.5),
		// 					P50: to.Ptr[float64](4.34),
		// 					P75: to.Ptr[float64](5.2),
		// 					P90: to.Ptr[float64](6.77),
		// 					P95: to.Ptr[float64](7.1),
		// 					P99: to.Ptr[float64](8.3),
		// 			}},
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 			TimeGrain: to.Ptr("PT5M"),
		// 			Unit: to.Ptr(armcosmos.UnitTypeMilliseconds),
		// 		},
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Probabilistic Bounded Staleness-S-West Central US-T-West US"),
		// 				Value: to.Ptr("Probabilistic Bounded Staleness-S-West Central US-T-West US"),
		// 			},
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:13:55.278Z"); return t}()),
		// 			MetricValues: []*armcosmos.PercentileMetricValue{
		// 				{
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 					P10: to.Ptr[float64](1.11),
		// 					P25: to.Ptr[float64](2.5),
		// 					P50: to.Ptr[float64](4.34),
		// 					P75: to.Ptr[float64](5.2),
		// 					P90: to.Ptr[float64](6.77),
		// 					P95: to.Ptr[float64](7.1),
		// 					P99: to.Ptr[float64](8.3),
		// 			}},
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 			TimeGrain: to.Ptr("PT5M"),
		// 			Unit: to.Ptr(armcosmos.UnitTypeMilliseconds),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
 *
 * @summary Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBPercentileGetMetrics.json
 */
async function cosmosDbDatabaseAccountRegionGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const filter =
    "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.percentile.listMetrics(resourceGroupName, accountName, filter)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "timeGrain": "PT5M",
      "startTime": "2017-11-19T23:53:55.2780000Z",
      "endTime": "2017-11-20T00:13:55.2780000Z",
      "unit": "Milliseconds",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "P10": 1.11,
          "P25": 2.5,
          "P50": 4.34,
          "P75": 5.2,
          "P90": 6.77,
          "P95": 7.1,
          "P99": 8.3
        }
      ],
      "name": {
        "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US",
        "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US"
      }
    },
    {
      "timeGrain": "PT5M",
      "startTime": "2017-11-19T23:53:55.2780000Z",
      "endTime": "2017-11-20T00:13:55.2780000Z",
      "unit": "Milliseconds",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "P10": 1.11,
          "P25": 2.5,
          "P50": 4.34,
          "P75": 5.2,
          "P90": 6.77,
          "P95": 7.1,
          "P99": 8.3
        }
      ],
      "name": {
        "value": "Probabilistic Bounded Staleness-S-West Central US-T-West US",
        "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US"
      }
    }
  ]
}

Definiciones

Nombre	Description
MetricName	Nombre de la métrica.
PercentileMetric	Datos de métricas de percentil
PercentileMetricListResult	Respuesta a una solicitud de métricas de percentil de lista.
PercentileMetricValue	Representa valores de métricas de percentil.
UnitType	Unidad de la métrica.

MetricName

Object

Nombre de la métrica.

Nombre	Tipo	Description
localizedValue	string	Nombre descriptivo de la métrica.
value	string	El nombre de la métrica.

PercentileMetric

Object

Datos de métricas de percentil

Nombre	Tipo	Description
endTime	string (date-time)	Hora de finalización de la métrica (formato ISO-8601).
metricValues	PercentileMetricValue[]	Valores de métricas de percentil para la ventana de tiempo y el intervalo de tiempo especificados.
name	MetricName	Información de nombre de la métrica.
startTime	string (date-time)	Hora de inicio de la métrica (formato ISO-8601).
timeGrain	string	Intervalo de tiempo que se usará para resumir los valores de métrica.
unit	UnitType	Unidad de la métrica.

PercentileMetricListResult

Object

Respuesta a una solicitud de métricas de percentil de lista.

Nombre	Tipo	Description
value	PercentileMetric[]	Lista de métricas de percentil para la cuenta.

PercentileMetricValue

Object

Representa valores de métricas de percentil.

Nombre	Tipo	Description
P10	number (double)	Valor del percentil 10 de la métrica.
P25	number (double)	Valor del percentil 25 de la métrica.
P50	number (double)	Valor del percentil 50 de la métrica.
P75	number (double)	Valor del percentil 75 de la métrica.
P90	number (double)	Valor del percentil 90 de la métrica.
P95	number (double)	Valor del percentil 95 de la métrica.
P99	number (double)	Valor del percentil 99 de la métrica.
_count	number (int32)	Número de valores de la métrica.
average	number (double)	Valor medio de la métrica.
maximum	number (double)	Valor máximo de la métrica.
minimum	number (double)	Valor mínimo de la métrica.
timestamp	string (date-time)	Marca de tiempo de métrica (formato ISO-8601).
total	number (double)	Valor total de la métrica.

UnitType

Enumeración

Unidad de la métrica.

Valor	Description
Bytes
BytesPerSecond
Count
CountPerSecond
Milliseconds
Percent
Seconds

Compartir a través de

Percentile - List Metrics

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

CosmosDBDatabaseAccountRegionGetMetrics

Solicitud de ejemplo

Respuesta de muestra

Definiciones

MetricName

PercentileMetric

PercentileMetricListResult

PercentileMetricValue

UnitType