Database Accounts - List Metric Definitions

Mengambil definisi metrik untuk akun database yang diberikan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions?api-version=2021-04-01-preview

Parameter URI

Name In Required Type Description
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.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Respons

Name Type Description
200 OK

Definisi metrik untuk akun database berhasil diambil.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Meniru akun pengguna Anda

Contoh

CosmosDBDatabaseAccountGetMetricDefinitions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metricDefinitions?api-version=2021-04-01-preview

Sample Response

{
  "value": [
    {
      "metricAvailabilities": [
        {
          "timeGrain": "PT5M",
          "retention": "P2D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P14D"
        },
        {
          "timeGrain": "P1D",
          "retention": "P60D"
        }
      ],
      "primaryAggregationType": "Total",
      "unit": "Count",
      "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
      "name": {
        "value": "Total Requests",
        "localizedValue": "Total Requests"
      }
    }
  ]
}

Definisi

MetricAvailability

Ketersediaan metrik.

MetricDefinition

Definisi metrik.

MetricDefinitionsListResult

Respons terhadap permintaan definisi metrik daftar.

MetricName

Nama metrik.

PrimaryAggregationType

Jenis agregasi utama metrik.

UnitType

Unit metrik.

MetricAvailability

Ketersediaan metrik.

Name Type Description
retention
  • string

Retensi untuk nilai metrik.

timeGrain
  • string

Butir waktu yang akan digunakan untuk meringkas nilai metrik.

MetricDefinition

Definisi metrik.

Name Type Description
metricAvailabilities

Daftar ketersediaan metrik untuk akun.

name

Informasi nama untuk metrik.

primaryAggregationType

Jenis agregasi utama metrik.

resourceUri
  • string

Uri sumber daya database.

unit

Unit metrik.

MetricDefinitionsListResult

Respons terhadap permintaan definisi metrik daftar.

Name Type Description
value

Daftar definisi metrik untuk akun tersebut.

MetricName

Nama metrik.

Name Type Description
localizedValue
  • string

Nama metrik yang mudah diingat.

value
  • string

Nama metrik.

PrimaryAggregationType

Jenis agregasi utama metrik.

Name Type Description
Average
  • string
Last
  • string
Maximum
  • string
Minimum
  • string
None
  • string
Total
  • string

UnitType

Unit metrik.

Name Type Description
Bytes
  • string
BytesPerSecond
  • string
Count
  • string
CountPerSecond
  • string
Milliseconds
  • string
Percent
  • string
Seconds
  • string