Partition Key Range Id Region - List Metrics

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Lekéri az adott partíciókulcs-tartományazonosító és -régió adott szűrője által meghatározott metrikákat.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	Cosmos DB-adatbázisfiók neve. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
collectionRid	path	True	string	Cosmos DB-gyűjtemény rid.
databaseRid	path	True	string	Cosmos DB-adatbázis rid.
partitionKeyRangeId	path	True	string	Partíciókulcs-tartomány azonosítója, amelyhez adatokat szeretne lekérni.
region	path	True	string	Cosmos DB-régió, a szavak és az egyes szavak közötti szóközök nagybetűvel.
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
$filter	query	True	string	OData-szűrőkifejezés, amely a visszaadandó metrikák egy részhalmazát írja le. A szűrhető paraméterek a következők: name.value (a metrika neve, lehet egy vagy több neve), startTime, endTime és timeGrain. A támogatott operátor az eq.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	PartitionMetricListResult	A partíciókulcs-tartomány azonosítójának és régiójának partíciószintű metrikáinak lekérése sikerült.

Biztonság

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	A felhasználói fiók megszemélyesítése

Példák

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/region/West US/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 PartitionKeyRangeIdRegion ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBPKeyRangeIdRegionGetMetrics.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().getPartitionKeyRangeIdRegions().listMetrics("rg1", "ddb1",
            "West US", "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/CosmosDBPKeyRangeIdRegionGetMetrics.json
func ExamplePartitionKeyRangeIDRegionClient_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.NewPartitionKeyRangeIDRegionClient().NewListMetricsPager("rg1", "ddb1", "West US", "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 and region.
 *
 * @summary Retrieves the metrics determined by the given filter for the given partition key range id and region.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json
 */
async function cosmosDbDatabaseAccountRegionGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const region = "West US";
  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.partitionKeyRangeIdRegion.listMetrics(
    resourceGroupName,
    accountName,
    region,
    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"
      }
    }
  ]
}

Definíciók

Name	Description
MetricName	Egy metrikanév.
MetricValue	Metrikák értékeit jelöli.
PartitionMetric	Egyetlen partíció metrikaértékei.
PartitionMetricListResult	Válasz egy listapartíció-metrikakérésre.
UnitType	A metrika egysége.

MetricName

Egy metrikanév.

Name	Típus	Description
localizedValue	string	A metrika rövid neve.
value	string	A metrika neve.

MetricValue

Metrikák értékeit jelöli.

Name	Típus	Description
_count	number	A metrika értékeinek száma.
average	number	A metrika átlagos értéke.
maximum	number	A metrika maximális értéke.
minimum	number	A metrika minimális értéke.
timestamp	string	A metrika időbélyege (ISO-8601 formátum).
total	number	A metrika teljes értéke.

PartitionMetric

Egyetlen partíció metrikaértékei.

Name	Típus	Description
endTime	string	A metrika befejezési ideje (ISO-8601 formátum).
metricValues	MetricValue[]	A megadott időkeret és időtartomány metrikaértékei.
name	MetricName	A metrika névadatai.
partitionId	string	A metrikaértékek partícióazonosítója (GUID azonosítója).
partitionKeyRangeId	string	A metrikaértékek partíciókulcs-tartományazonosítója (egész szám azonosítója).
startTime	string	A metrika kezdő időpontja (ISO-8601 formátum).
timeGrain	string	A metrikaértékek összegzéséhez használandó időfelbontás.
unit	UnitType	A metrika egysége.

PartitionMetricListResult

Válasz egy listapartíció-metrikakérésre.

Name	Típus	Description
value	PartitionMetric[]	A fiók partíciószintű metrikáinak listája.

UnitType

A metrika egysége.

Name	Típus	Description
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
Percent	string
Seconds	string

Partition Key Range Id Region - List Metrics

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

Sample Response

Definíciók

MetricName

MetricValue

PartitionMetric

PartitionMetricListResult

UnitType

További források