Partition Key Range Id - List Metrics

Referência

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Recupera as métricas determinadas pelo filtro fornecido para a ID do intervalo de chaves de partição fornecida.

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}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	Nome da conta de banco de dados do Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
collectionRid	path	True	string	Rid da coleção do Cosmos DB.
databaseRid	path	True	string	Banco de dados do Cosmos DB rid.
partitionKeyRangeId	path	True	string	ID do Intervalo de Chaves de Partição para a qual obter dados.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
$filter	query	True	string	Uma expressão de filtro OData que descreve um subconjunto de métricas a serem retornadas. Os parâmetros que podem ser filtrados são name.value (nome da métrica, pode ter um ou de vários nomes), startTime, endTime e timeGrain. O operador com suporte é eq.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	PartitionMetricListResult	As métricas no nível da partição para a ID do intervalo de chaves de partição foram recuperadas com êxito.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

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"
      }
    }
  ]
}

Definições

Nome	Description
MetricName	Um nome de métrica.
MetricValue	Representa valores de métricas.
PartitionMetric	Os valores de métrica para uma única partição.
PartitionMetricListResult	A resposta a uma solicitação de métricas de partição de lista.
UnitType	A unidade da métrica.

MetricName

Um nome de métrica.

Nome	Tipo	Description
localizedValue	string	O nome amigável da métrica.
value	string	O nome da métrica.

MetricValue

Representa valores de métricas.

Nome	Tipo	Description
_count	number	O número de valores para a métrica.
average	number	O valor médio da métrica.
maximum	number	O valor máximo da métrica.
minimum	number	O valor mínimo da métrica.
timestamp	string	O carimbo de data/hora da métrica (formato ISO-8601).
total	number	O valor total da métrica.

PartitionMetric

Os valores de métrica para uma única partição.

Nome	Tipo	Description
endTime	string	A hora de término da métrica (formato ISO-8601).
metricValues	MetricValue[]	Os valores de métrica para a janela de tempo e o carimbo de data/hora especificados.
name	MetricName	As informações de nome da métrica.
partitionId	string	A ID da partição (identificador GUID) dos valores de métrica.
partitionKeyRangeId	string	A ID do intervalo de chaves de partição (identificador inteiro) dos valores de métrica.
startTime	string	A hora de início da métrica (formato ISO-8601).
timeGrain	string	A granularidade de tempo a ser usada para resumir os valores de métrica.
unit	UnitType	A unidade da métrica.

PartitionMetricListResult

A resposta a uma solicitação de métricas de partição de lista.

Nome	Tipo	Description
value	PartitionMetric[]	A lista de métricas no nível da partição para a conta.

UnitType

A unidade da métrica.

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

Partition Key Range Id - List Metrics

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

Sample Response

Definições

MetricName

MetricValue

PartitionMetric

PartitionMetricListResult

UnitType

Recursos adicionais