Percentile Source Target - List Metrics

Referensi

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Mengambil metrik yang ditentukan oleh filter yang diberikan untuk akun, sumber, dan wilayah target yang diberikan. Url ini hanya untuk data Latensi PBS dan Replikasi

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
sourceRegion	path	True	string	Wilayah sumber dari mana data ditulis. Wilayah Cosmos DB, dengan spasi antara kata dan setiap kata dikapitalisasi.
subscriptionId	path	True	string	ID langganan target.
targetRegion	path	True	string	Wilayah target yang datanya ditulis. Wilayah Cosmos DB, dengan spasi antara kata dan setiap kata dikapitalisasi.
$filter	query	True	string	Ekspresi filter OData yang menjelaskan subset metrik yang akan dikembalikan. Parameter yang dapat difilter adalah name.value (nama metrik, dapat memiliki atau beberapa nama), startTime, endTime, dan timeGrain. Operator yang didukung adalah eq.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	PercentileMetricListResult	Metrik persentil untuk wilayah akun, sumber, dan target berhasil diambil.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

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


/**
 * 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

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

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

Definisi

Nama	Deskripsi
MetricName	Nama metrik.
PercentileMetric	Data Metrik Persentil
PercentileMetricListResult	Respons terhadap permintaan metrik persentil daftar.
PercentileMetricValue	Mewakili nilai metrik persentil.
UnitType	Unit metrik.

MetricName

Nama metrik.

Nama	Jenis	Deskripsi
localizedValue	string	Nama metrik yang mudah diingat.
value	string	Nama metrik.

PercentileMetric

Data Metrik Persentil

Nama	Jenis	Deskripsi
endTime	string	Waktu akhir untuk metrik (format ISO-8601).
metricValues	PercentileMetricValue[]	Nilai metrik persentil untuk jendela waktu dan timestep yang ditentukan.
name	MetricName	Informasi nama untuk metrik.
startTime	string	Waktu mulai untuk metrik (format ISO-8601).
timeGrain	string	Butir waktu yang akan digunakan untuk meringkas nilai metrik.
unit	UnitType	Unit metrik.

PercentileMetricListResult

Respons terhadap permintaan metrik persentil daftar.

Nama	Jenis	Deskripsi
value	PercentileMetric[]	Daftar metrik persentil untuk akun tersebut.

PercentileMetricValue

Mewakili nilai metrik persentil.

Nama	Jenis	Deskripsi
P10	number	Nilai persentil ke-10 untuk metrik.
P25	number	Nilai persentil ke-25 untuk metrik.
P50	number	Nilai persentil ke-50 untuk metrik.
P75	number	Nilai persentil ke-75 untuk metrik.
P90	number	Nilai persentil ke-90 untuk metrik.
P95	number	Nilai persentil ke-95 untuk metrik.
P99	number	Nilai persentil ke-99 untuk metrik.
_count	number	Jumlah nilai untuk metrik.
average	number	Nilai rata-rata metrik.
maximum	number	Nilai maksimum metrik.
minimum	number	Nilai min metrik.
timestamp	string	Tanda waktu metrik (format ISO-8601).
total	number	Nilai total metrik.

UnitType

Unit metrik.

Nama	Jenis	Deskripsi
Bytes	string
BytesPerSecond	string
Count	string
CountPerSecond	string
Milliseconds	string
Percent	string
Seconds	string

Percentile Source Target - List Metrics

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

Sample Response

Definisi

MetricName

PercentileMetric

PercentileMetricListResult

PercentileMetricValue

UnitType

Sumber Daya Tambahan: