Partition Key Range Id - List Metrics

Mengambil metrik yang ditentukan oleh filter yang diberikan untuk id rentang kunci partisi yang diberikan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/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]+)*

collectionRid
path True

string

Cosmos DB koleksi rid.

databaseRid
path True

string

Cosmos DB database rid.

partitionKeyRangeId
path True

string

Id Rentang Kunci Partisi untuk mendapatkan data.

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

PartitionMetricListResult

Metrik tingkat partisi untuk id rentang kunci partisi 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/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"
      }
    }
  ]
}

Definisi

Nama Deskripsi
MetricName

Nama metrik.

MetricValue

Mewakili nilai metrik.

PartitionMetric

Nilai metrik untuk satu partisi.

PartitionMetricListResult

Respons terhadap permintaan metrik partisi daftar.

UnitType

Unit metrik.

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.

PartitionMetric

Nilai metrik untuk satu partisi.

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.

partitionId

string

Id partisi (pengidentifikasi GUID) dari nilai metrik.

partitionKeyRangeId

string

Id rentang kunci partisi (pengidentifikasi bilangan bulat) dari nilai 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.

PartitionMetricListResult

Respons terhadap permintaan metrik partisi daftar.

Nama Jenis Deskripsi
value

PartitionMetric[]

Daftar metrik tingkat partisi untuk akun tersebut.

UnitType

Unit metrik.

Nama Jenis Deskripsi
Bytes

string

BytesPerSecond

string

Count

string

CountPerSecond

string

Milliseconds

string

Percent

string

Seconds

string