Partition Key Range Id - List Metrics

Riferimento

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Recupera le metriche determinate dal filtro specificato per l'ID intervallo di chiavi di partizione specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics?api-version=2023-11-15&$filter={$filter}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account del database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
collectionRid	path	True	string	Rid raccolta cosmos DB.
databaseRid	path	True	string	Rid del database Cosmos DB.
partitionKeyRangeId	path	True	string	ID intervallo di chiavi di partizione per cui ottenere i dati.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
$filter	query	True	string	Espressione di filtro OData che descrive un subset di metriche da restituire. I parametri che possono essere filtrati sono name.value (nome della metrica, possono avere uno o più nomi), startTime, endTime e timeGrain. L'operatore supportato è eq.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PartitionMetricListResult	Le metriche a livello di partizione per l'ID intervallo di chiavi di partizione sono state recuperate correttamente.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/databases/databaseRid/collections/collectionRid/partitionKeyRangeId/0/metrics?api-version=2023-11-15&$filter=$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z


/**
 * Samples for PartitionKeyRangeId ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBPKeyRangeIdGetMetrics.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().getPartitionKeyRangeIds().listMetrics("rg1", "ddb1",
            "databaseRid", "collectionRid", "0",
            "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58: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

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdGetMetrics.json
func ExamplePartitionKeyRangeIDClient_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.NewPartitionKeyRangeIDClient().NewListMetricsPager("rg1", "ddb1", "databaseRid", "collectionRid", "0", "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58: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.PartitionMetricListResult = armcosmos.PartitionMetricListResult{
		// 	Value: []*armcosmos.PartitionMetric{
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Max RUs Per Second"),
		// 				Value: to.Ptr("Max RUs Per Second"),
		// 			},
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T23:58:55.278Z"); return t}()),
		// 			MetricValues: []*armcosmos.MetricValue{
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 				},
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:54:55.278Z"); return t}()),
		// 				},
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:55:55.278Z"); return t}()),
		// 				},
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:56:55.278Z"); return t}()),
		// 				},
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:57:55.278Z"); return t}()),
		// 				},
		// 				{
		// 					Maximum: to.Ptr[float64](5),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:58:55.278Z"); return t}()),
		// 			}},
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 			TimeGrain: to.Ptr("PT1M"),
		// 			Unit: to.Ptr(armcosmos.UnitTypeCount),
		// 			PartitionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			PartitionKeyRangeID: to.Ptr("0"),
		// 	}},
		// }
	}
}

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");

/**
 * This sample demonstrates how to Retrieves the metrics determined by the given filter for the given partition key range id.
 *
 * @summary Retrieves the metrics determined by the given filter for the given partition key range id.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdGetMetrics.json
 */
async function cosmosDbDatabaseAccountRegionGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseRid = "databaseRid";
  const collectionRid = "collectionRid";
  const partitionKeyRangeId = "0";
  const filter =
    "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.partitionKeyRangeId.listMetrics(
    resourceGroupName,
    accountName,
    databaseRid,
    collectionRid,
    partitionKeyRangeId,
    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

Sample Response

Status code:: 200

{
  "value": [
    {
      "timeGrain": "PT1M",
      "startTime": "2017-11-19T23:53:55.2780000Z",
      "endTime": "2017-11-20T23:58:55.2780000Z",
      "unit": "Count",
      "partitionId": "00000000-0000-0000-0000-000000000000",
      "partitionKeyRangeId": "0",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "maximum": 5
        },
        {
          "timestamp": "2017-11-19T23:54:55.2780000Z",
          "maximum": 5
        },
        {
          "timestamp": "2017-11-19T23:55:55.2780000Z",
          "maximum": 5
        },
        {
          "timestamp": "2017-11-19T23:56:55.2780000Z",
          "maximum": 5
        },
        {
          "timestamp": "2017-11-19T23:57:55.2780000Z",
          "maximum": 5
        },
        {
          "timestamp": "2017-11-19T23:58:55.2780000Z",
          "maximum": 5
        }
      ],
      "name": {
        "value": "Max RUs Per Second",
        "localizedValue": "Max RUs Per Second"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
MetricName	Un nome della metrica.
MetricValue	Rappresenta i valori delle metriche.
PartitionMetric	Valori delle metriche per una singola partizione.
PartitionMetricListResult	Risposta a una richiesta di metriche di partizione elenco.
UnitType	Unità della metrica.

MetricName

Un nome della metrica.

Nome	Tipo	Descrizione
localizedValue	string	Nome descrittivo della metrica.
value	string	Nome della metrica.

MetricValue

Rappresenta i valori delle metriche.

Nome	Tipo	Descrizione
_count	number	Numero di valori per la metrica.
average	number	Valore medio della metrica.
maximum	number	Valore massimo della metrica.
minimum	number	Valore minimo della metrica.
timestamp	string	Timestamp della metrica (formato ISO-8601).
total	number	Valore totale della metrica.

PartitionMetric

Valori delle metriche per una singola partizione.

Nome	Tipo	Descrizione
endTime	string	Ora di fine per la metrica (formato ISO-8601).
metricValues	MetricValue[]	Valori delle metriche per l'intervallo di tempo e il timetep specificati.
name	MetricName	Informazioni sul nome per la metrica.
partitionId	string	ID partizione (identificatore GUID) dei valori delle metriche.
partitionKeyRangeId	string	ID intervallo di chiavi di partizione (identificatore intero) dei valori della metrica.
startTime	string	Ora di inizio per la metrica (formato ISO-8601).
timeGrain	string	Intervallo di tempo da usare per riepilogare i valori delle metriche.
unit	UnitType	Unità della metrica.

PartitionMetricListResult

Risposta a una richiesta di metriche di partizione elenco.

Nome	Tipo	Descrizione
value	PartitionMetric[]	Elenco di metriche a livello di partizione per l'account.

UnitType

Unità della metrica.

Nome	Tipo	Descrizione
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
Percent	string
Seconds	string

Partition Key Range Id - List Metrics

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

Sample Response

Definizioni

MetricName

MetricValue

PartitionMetric

PartitionMetricListResult

UnitType

Risorse aggiuntive