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

Collection Partition - List Metrics

检索由给定集合的给定筛选器确定的指标,按分区拆分。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics?api-version=2021-04-01-preview&$filter={$filter}

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

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

collectionRid
path True
  • string

Cosmos DB 集合 rid。

databaseRid
path True
  • string

Cosmos DB 数据库 rid。

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

$filter
query True
  • string

描述要返回的指标子集的 OData 筛选器表达式。 可以筛选的参数是指标的名称.value (名称,可以具有多个名称) 、startTime、endTime 和 timeGrain。 支持的运算符为 eq。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索集合的分区级别指标。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBDatabaseAccountRegionGetMetrics

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/databases/databaseRid/collections/collectionRid/partitions/metrics?api-version=2021-04-01-preview&$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"
      }
    }
  ]
}

定义

MetricName

指标名称。

MetricValue

表示指标值。

PartitionMetric

单个分区的指标值。

PartitionMetricListResult

对列表分区指标请求的响应。

UnitType

指标的单位。

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

指标的总值。

PartitionMetric

单个分区的指标值。

Name Type Description
endTime
  • string

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

metricValues

指定时间窗口和时间步骤的指标值。

name

指标的名称信息。

partitionId
  • string

指标值的分区 ID (GUID 标识符) 。

partitionKeyRangeId
  • string

分区键范围 ID (指标值的整数标识符) 。

startTime
  • string

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

timeGrain
  • string

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

unit

指标的单位。

PartitionMetricListResult

对列表分区指标请求的响应。

Name Type Description
value

帐户的分区级别指标列表。

UnitType

指标的单位。

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