Database Accounts - List Metrics

特定のデータベース アカウントの特定のフィルターによって決定されるメトリックを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics?api-version=2021-11-15-preview&$filter={$filter}

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

DB データベース アカウント名をCosmosします。

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

resourceGroupName
path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

$filter
query True
  • string

返すメトリックのサブセットを記述する OData フィルター式。 フィルター処理できるパラメーターは、name.value (メトリックの名前、複数の名前を持つことができます)、startTime、endTime、timeGrain です。 サポートされている演算子は eq です。

api-version
query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

データベース アカウントのメトリックが正常に取得されました。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

CosmosDBDatabaseAccountGetMetrics

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metrics?api-version=2021-11-15-preview&$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

Sample Response

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

定義

Metric

メトリック データ

MetricListResult

リスト メトリック要求への応答。

MetricName

メトリック名。

MetricValue

メトリック値を表します。

UnitType

メトリックの単位。

Metric

メトリック データ

Name Type Description
endTime
  • string

メトリックの終了時刻 (ISO-8601 形式)。

metricValues

指定した時間枠とタイムステップのメトリック値。

name

メトリックの名前情報。

startTime
  • string

メトリックの開始時刻 (ISO-8601 形式)。

timeGrain
  • string

メトリック値の集計に使用する時間グレイン。

unit

メトリックの単位。

MetricListResult

リスト メトリック要求への応答。

Name Type Description
value

アカウントのメトリックの一覧。

MetricName

メトリック名。

Name Type Description
localizedValue
  • string

メトリックのフレンドリ名。

value
  • string

メトリックの名前。

MetricValue

メトリック値を表します。

Name Type Description
_count
  • number

メトリックの値の数。

average
  • number

メトリックの平均値。

maximum
  • number

メトリックの最大値。

minimum
  • number

メトリックの最小値。

timestamp
  • string

メトリック タイムスタンプ (ISO-8601 形式)。

total
  • number

メトリックの合計値。

UnitType

メトリックの単位。

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