Partition Key Range Id Region - List Metrics

Ruft die Metriken ab, die vom angegebenen Filter für die angegebene Partitionsschlüsselbereichs-ID und -Region bestimmt werden.

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-Parameter

Name In Erforderlich Typ Beschreibung
accountName
path True

string

Name des Cosmos DB-Datenbankkontos.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

collectionRid
path True

string

Cosmos DB-Sammlung entfernt.

databaseRid
path True

string

Cosmos DB-Datenbank wird entfernt.

partitionKeyRangeId
path True

string

Partitionsschlüsselbereichs-ID, für die Daten abgerufen werden sollen.

region
path True

string

Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort in Großbuchstaben.

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

$filter
query True

string

Ein OData-Filterausdruck, der eine Teilmenge der zurückzugebenden Metriken beschreibt. Die Parameter, die gefiltert werden können, sind name.value (Name der Metrik, kann einen oder mehrere Namen aufweisen), startTime, endTime und timeGrain. Der unterstützte Operator ist eq.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

PartitionMetricListResult

Die Metriken auf Partitionsebene für die Partitionsschlüsselbereichs-ID und -Region wurden erfolgreich abgerufen.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Sample Response

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

Definitionen

Name Beschreibung
MetricName

Metrikname

MetricValue

Stellt Metrikwerte dar.

PartitionMetric

Die Metrikwerte für eine einzelne Partition.

PartitionMetricListResult

Die Antwort auf eine Listenpartitionsmetrikanforderung.

UnitType

Die Einheit der Metrik.

MetricName

Metrikname

Name Typ Beschreibung
localizedValue

string

Der Anzeigename der Metrik.

value

string

Der Name der Metrik.

MetricValue

Stellt Metrikwerte dar.

Name Typ Beschreibung
_count

number

Die Anzahl der Werte für die Metrik.

average

number

Der Durchschnittswert der Metrik.

maximum

number

Der maximale Wert der Metrik.

minimum

number

Der min-Wert der Metrik.

timestamp

string

Der Metrikzeitstempel (ISO-8601-Format).

total

number

Der Gesamtwert der Metrik.

PartitionMetric

Die Metrikwerte für eine einzelne Partition.

Name Typ Beschreibung
endTime

string

Die Endzeit für die Metrik (ISO-8601-Format).

metricValues

MetricValue[]

Die Metrikwerte für das angegebene Zeitfenster und den angegebenen Zeitschritt.

name

MetricName

Die Namensinformationen für die Metrik.

partitionId

string

Die Partitions-ID (GUID-Bezeichner) der Metrikwerte.

partitionKeyRangeId

string

Die Partitionsschlüsselbereichs-ID (ganzzahliger Bezeichner) der Metrikwerte.

startTime

string

Die Startzeit für die Metrik (ISO-8601-Format).

timeGrain

string

Das Zeitkorn, das zum Zusammenfassen der Metrikwerte verwendet werden soll.

unit

UnitType

Die Einheit der Metrik.

PartitionMetricListResult

Die Antwort auf eine Listenpartitionsmetrikanforderung.

Name Typ Beschreibung
value

PartitionMetric[]

Die Liste der Metriken auf Partitionsebene für das Konto.

UnitType

Die Einheit der Metrik.

Name Typ Beschreibung
Bytes

string

BytesPerSecond

string

Count

string

CountPerSecond

string

Milliseconds

string

Percent

string

Seconds

string