Percentile Source Target - List Metrics

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 kontot, källan och målregionen. Den här URL:en gäller endast pbs- och replikeringssvarstidsdata

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/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]+)*
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
sourceRegion	path	True	string	Källregion som data skrivs från. Cosmos DB-region med blanksteg mellan ord och varje ord med versaler.
subscriptionId	path	True	string	ID för målprenumerationen.
targetRegion	path	True	string	Målregion som data skrivs till. Cosmos DB-region med blanksteg mellan ord och varje ord med versaler.
$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	PercentileMetricListResult	Percentilmåtten för konto-, käll- och målregionerna har hämtats.

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

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sourceRegion/West Central US/targetRegion/East US/percentile/metrics?api-version=2023-11-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

Java

/**
 * Samples for PercentileSourceTarget ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBPercentileSourceTargetGetMetrics.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().getPercentileSourceTargets().listMetrics("rg1", "ddb1",
            "West Central US", "East US",
            "$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

Go

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/CosmosDBPercentileSourceTargetGetMetrics.json
func ExamplePercentileSourceTargetClient_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.NewPercentileSourceTargetClient().NewListMetricsPager("rg1", "ddb1", "West Central US", "East US", "$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),
		// 	}},
		// }
	}
}

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

JavaScript

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 account, source and target region. This url is only for PBS and Replication Latency data
 *
 * @summary Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileSourceTargetGetMetrics.json
 */
async function cosmosDbDatabaseAccountRegionGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const sourceRegion = "West Central US";
  const targetRegion = "East US";
  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 (let item of client.percentileSourceTarget.listMetrics(
    resourceGroupName,
    accountName,
    sourceRegion,
    targetRegion,
    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": "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"
      }
    }
  ]
}

Definitioner

Name	Description
MetricName	Ett måttnamn.
PercentileMetric	Percentilmåttdata
PercentileMetricListResult	Svaret på en begäran om percentilmått för en lista.
PercentileMetricValue	Representerar percentilmåttvärden.
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.

PercentileMetric

Percentilmåttdata

Name	Typ	Description
endTime	string	Sluttiden för måttet (ISO-8601-format).
metricValues	PercentileMetricValue[]	Percentilens måttvärden för det angivna tidsfönstret och tidssteget.
name	MetricName	Namninformationen för måttet.
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.

PercentileMetricListResult

Svaret på en begäran om percentilmått för en lista.

Name	Typ	Description
value	PercentileMetric[]	Listan över percentilmått för kontot.

PercentileMetricValue

Representerar percentilmåttvärden.

Name	Typ	Description
P10	number	Det tionde percentilvärdet för måttet.
P25	number	Måttets 25:e percentilvärde.
P50	number	Det 50:e percentilvärdet för måttet.
P75	number	Det 75:e percentilvärdet för måttet.
P90	number	Det 90:e percentilvärdet för måttet.
P95	number	Det 95:e percentilvärdet för måttet.
P99	number	Det 99:e percentilvärdet för måttet.
_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.

UnitType

Enheten för måttet.

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