你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Collection Region - List Metrics

检索给定筛选器为给定数据库帐户、集合和区域确定的指标。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics?api-version=2024-05-15&$filter={$filter}

URI 参数

名称 必需 类型 说明
accountName
path True

string

Cosmos DB 数据库帐户名称。

正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*

collectionRid
path True

string

Cosmos DB 集合删除。

databaseRid
path True

string

Cosmos DB 数据库删除。

region
path True

string

Cosmos DB 区域,单词和每个单词之间的空格已大写。

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 版本。

响应

名称 类型 说明
200 OK

MetricListResult

已成功检索数据库帐户的指标。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CosmosDBRegionCollectionGetMetrics

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/region/North Europe/databases/databaseRid/collections/collectionRid/metrics?api-version=2024-05-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

示例响应

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

指标数据

名称 类型 说明
endTime

string

指标的结束时间 (ISO-8601 格式) 。

metricValues

MetricValue[]

指定时间窗口和 timestep 的指标值。

name

MetricName

指标的名称信息。

startTime

string

指标的开始时间 (ISO-8601 格式) 。

timeGrain

string

用于汇总指标值的时间粒度。

unit

UnitType

指标的单位。

MetricListResult

对列表指标请求的响应。

名称 类型 说明
value

Metric[]

帐户的指标列表。

MetricName

指标名称。

名称 类型 说明
localizedValue

string

指标的友好名称。

value

string

指标的名称。

MetricValue

表示指标值。

名称 类型 说明
_count

number

指标的值数。

average

number

指标的平均值。

maximum

number

指标的最大值。

minimum

number

指标的最小值。

timestamp

string

指标时间戳 (ISO-8601 格式) 。

total

number

指标的总值。

UnitType

指标的单位。

名称 类型 说明
Bytes

string

BytesPerSecond

string

Count

string

CountPerSecond

string

Milliseconds

string

Percent

string

Seconds

string