Database Accounts - List Metrics

Referensi

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Mengambil metrik yang ditentukan oleh filter yang diberikan untuk akun database yang diberikan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/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.
subscriptionId	path	True	string	ID langganan target.
$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	MetricListResult	Metrik untuk akun database 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

CosmosDBDatabaseAccountGetMetrics

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metrics?api-version=2023-11-15&$filter=$filter=(name.value eq 'Total Requests') 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 DatabaseAccounts ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBDatabaseAccountGetMetrics.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountGetMetrics.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountGetMetrics(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().listMetrics("rg1", "ddb1",
            "$filter=(name.value eq 'Total Requests') 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/CosmosDBDatabaseAccountGetMetrics.json
func ExampleDatabaseAccountsClient_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.NewDatabaseAccountsClient().NewListMetricsPager("rg1", "ddb1", "$filter=(name.value eq 'Total Requests') 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.MetricListResult = armcosmos.MetricListResult{
		// 	Value: []*armcosmos.Metric{
		// 		{
		// 			Name: &armcosmos.MetricName{
		// 				LocalizedValue: to.Ptr("Total Requests"),
		// 				Value: to.Ptr("Total Requests"),
		// 			},
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:13:55.278Z"); return t}()),
		// 			MetricValues: []*armcosmos.MetricValue{
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:58:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:03:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 				},
		// 				{
		// 					Count: to.Ptr[int32](0),
		// 					Average: to.Ptr[float64](0),
		// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:08:55.278Z"); return t}()),
		// 					Total: to.Ptr[float64](0),
		// 			}},
		// 			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.UnitTypeCount),
		// 	}},
		// }
	}
}

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 database account.
 *
 * @summary Retrieves the metrics determined by the given filter for the given database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetrics.json
 */
async function cosmosDbDatabaseAccountGetMetrics() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const filter =
    "$filter=(name.value eq 'Total Requests') 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.databaseAccounts.listMetrics(
    resourceGroupName,
    accountName,
    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": "Count",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-19T23:58:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:03:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:08:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        }
      ],
      "name": {
        "value": "Total Requests",
        "localizedValue": "Total Requests"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
Metric	Data metrik
MetricListResult	Respons terhadap permintaan metrik daftar.
MetricName	Nama metrik.
MetricValue	Mewakili nilai metrik.
UnitType	Unit metrik.

Metric

Data metrik

Nama	Jenis	Deskripsi
endTime	string	Waktu akhir untuk metrik (format ISO-8601).
metricValues	MetricValue[]	Nilai metrik 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.

MetricListResult

Respons terhadap permintaan metrik daftar.

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

MetricName

Nama metrik.

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

MetricValue

Mewakili nilai metrik.

Nama	Jenis	Deskripsi
_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

Database Accounts - List Metrics

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

CosmosDBDatabaseAccountGetMetrics

Sample Request

Sample Response

Definisi

Metric

MetricListResult

MetricName

MetricValue

UnitType

Sumber Daya Tambahan: