Partition Key Range Id - List Metrics

Referens

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Hämtar de mått som bestäms av det angivna filtret för det angivna partitionsnyckelintervall-ID:t.

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Namn på Cosmos DB-databaskonto. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
collectionRid	path	True	string	Cosmos DB-samlings-rid.
databaseRid	path	True	string	Cosmos DB-databas rid.
partitionKeyRangeId	path	True	string	Partitionsnyckelintervall-ID som du vill hämta data för.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
$filter	query	True	string	Ett OData-filteruttryck som beskriver en delmängd av mått som ska returneras. Parametrarna som kan filtreras är name.value (måttets namn, kan ha ett eller flera namn), startTime, endTime och timeGrain. Operatorn som stöds är eq.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	PartitionMetricListResult	Måtten på partitionsnivå för partitionsnyckelns intervall-ID hämtades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
MetricName	Ett måttnamn.
MetricValue	Representerar måttvärden.
PartitionMetric	Måttvärdena för en enskild partition.
PartitionMetricListResult	Svaret på en begäran om mått för listpartitionsmått.
UnitType	Enheten för måttet.

MetricName

Ett måttnamn.

Name	Typ	Description
localizedValue	string	Måttets egna namn.
value	string	Namnet på måttet.

MetricValue

Representerar måttvärden.

Name	Typ	Description
_count	number	Antalet värden för måttet.
average	number	Det genomsnittliga värdet för måttet.
maximum	number	Maxvärdet för måttet.
minimum	number	Minsta värde för måttet.
timestamp	string	Tidsstämpel för mått (ISO-8601-format).
total	number	Det totala värdet för måttet.

PartitionMetric

Måttvärdena för en enskild partition.

Name	Typ	Description
endTime	string	Sluttiden för måttet (ISO-8601-format).
metricValues	MetricValue[]	Måttvärdena för det angivna tidsfönstret och tidssteget.
name	MetricName	Namninformationen för måttet.
partitionId	string	Partitions-ID (GUID-identifierare) för måttvärdena.
partitionKeyRangeId	string	Partitionsnyckelns intervall-ID (heltalsidentifierare) för måttvärdena.
startTime	string	Starttiden för måttet (ISO-8601-format).
timeGrain	string	Tidsintervallet som ska användas för att sammanfatta måttvärdena.
unit	UnitType	Enheten för måttet.

PartitionMetricListResult

Svaret på en begäran om mått för listpartitionsmått.

Name	Typ	Description
value	PartitionMetric[]	Listan över mått på partitionsnivå för kontot.

UnitType

Enheten för måttet.

Name	Typ	Description
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
Percent	string
Seconds	string

Partition Key Range Id - List Metrics

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

Sample Response

Definitioner

MetricName

MetricValue

PartitionMetric

PartitionMetricListResult

UnitType

Ytterligare resurser