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

Metrics - Get

参考

服务:: Application Insights

API 版本:: v1

检索指标数据
获取单个指标的指标值

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}

具有可选参数:

GET https://api.applicationinsights.io/v1/apps/{appId}/metrics/{metricId}?timespan={timespan}&interval={interval}&aggregation={aggregation}&segment={segment}&top={top}&orderby={orderby}&filter={filter}

URI 参数

名称	在	必需	类型	说明
appId	path	True	string	应用程序的 ID。这是Azure 门户“API 访问设置”边栏选项卡中的应用程序 ID。
metricId	path	True	MetricId	指标的 ID。这是标准 AI 指标或特定于应用程序的自定义指标。
aggregation	query		MetricsAggregation[]	计算指标值时使用的聚合。若要一次检索多个聚合，请使用逗号分隔它们。如果未指定聚合，则使用指标的默认聚合。
filter	query		string	用于筛选结果的表达式。此值应该是有效的 OData 筛选器表达式，其中每个子句的键应是所检索指标的适用维度。
interval	query		string duration	检索指标值时要使用的时间间隔。这是一个ISO8601持续时间。如果省略 interval，则指标值将在整个时间跨度内聚合。如果提供间隔，服务器可能会根据用于查询的时间跨度将间隔调整为更合适的大小。在所有情况下，用于查询的实际间隔都包含在响应中。
orderby	query		string	对段进行排序的聚合函数和方向。此值仅在指定段时有效。
segment	query		MetricsSegment[]	要根据指标值进行分段的维度的名称。此维度必须适用于要检索的指标。若要一次按多个维度分段，请使用逗号 (，) 分隔它们。在这种情况下，指标数据将按照参数中列出维度的顺序进行分段。
timespan	query		string	检索指标值的时间跨度。这是一个ISO8601时间段值。如果省略 timespan，则使用默认时间范围 `PT12H` (“过去 12 小时”) 。查询的实际时间跨度可以由基于服务器的调整。在所有情况下，用于查询的实际时间跨度都包含在响应中。
top	query		integer int32	要返回的段数。此值仅在指定段时有效。

响应

名称	类型	说明
200 OK	metricsResult	成功的响应
Other Status Codes	errorResponse	错误响应对象。

安全性

oauth2

连接到 Azure 应用程序 Insights API

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

intervaledMetric

segmentedIntervaledMetric

simpleMetric

intervaledMetric

示例请求

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D

示例响应

状态代码:: 200

{
  "value": {
    "start": "2018-02-04T10:01:35.086Z",
    "end": "2018-02-06T10:01:35.086Z",
    "interval": "P1D",
    "segments": [
      {
        "start": "2018-02-04T10:01:35.086Z",
        "end": "2018-02-05T00:00:00.000Z",
        "requests/count": {
          "sum": 4927
        }
      },
      {
        "start": "2018-02-05T00:00:00.000Z",
        "end": "2018-02-06T00:00:00.000Z",
        "requests/count": {
          "sum": 8460
        }
      },
      {
        "start": "2018-02-06T00:00:00.000Z",
        "end": "2018-02-06T10:01:35.086Z",
        "requests/count": {
          "sum": 3743
        }
      }
    ]
  }
}

segmentedIntervaledMetric

示例请求

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount?timespan=P2D&interval=P1D&segment=operation/name,request/success

示例响应

状态代码:: 200

{
  "value": {
    "start": "2018-10-22T10:40:09.065Z",
    "end": "2018-10-22T22:40:09.065Z",
    "segments": [
      {
        "operation/name": "GET Home/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 156483,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 3795,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /",
        "segments": [
          {
            "requests/count": null,
            "sum": 34168,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 12,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-light-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9378,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-webfont.eot",
        "segments": [
          {
            "requests/count": null,
            "sum": 9370,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 1989,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 14,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1991,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1990,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET ServiceTickets/GetLogEntries",
        "segments": [
          {
            "requests/count": null,
            "sum": 1985,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Employees/Details",
        "segments": [
          {
            "requests/count": null,
            "sum": 663,
            "request/success": false
          },
          {
            "requests/count": null,
            "sum": 663,
            "request/success": true
          }
        ]
      },
      {
        "operation/name": "GET Reports/Index",
        "segments": [
          {
            "requests/count": null,
            "sum": 1086,
            "request/success": true
          }
        ]
      }
    ]
  }
}

simpleMetric

示例请求

HTTP

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics/requests%2Fcount

示例响应

状态代码:: 200

{
  "value": {
    "start": "2016-01-01T02:00:00.000Z",
    "end": "2016-01-03T02:00:00.000Z",
    "requests/count": {
      "sum": 23
    }
  }
}

定义

名称	说明
errorDetail	错误详细信息。
errorInfo	错误的代码和消息。
errorResponse	错误详细信息。
MetricId	指标的 ID。这是标准 AI 指标或特定于应用程序的自定义指标。
MetricsAggregation	计算指标值时使用的聚合。若要一次检索多个聚合，请使用逗号分隔它们。如果未指定聚合，则使用指标的默认聚合。
metricsResult	指标结果。
metricsResultInfo	指标结果数据。
MetricsSegment	要根据指标值进行分段的维度的名称。此维度必须适用于要检索的指标。若要一次按多个维度分段，请使用逗号 (，) 分隔它们。在这种情况下，指标数据将按照参数中列出维度的顺序进行分段。
metricsSegmentInfo	指标段

errorDetail

错误详细信息。

名称	类型	说明
additionalProperties	object
code	string	错误的代码。
message	string	人工可读错误消息。
resources	string[]	指示对错误负责的资源。
target	string	指示请求中的哪个属性对错误负责。
value	string	指示“target”中的哪个值是导致此错误的。

errorInfo

错误的代码和消息。

名称	类型	说明
additionalProperties	object
code	string	计算机可读错误代码。
details	errorDetail[]	错误详细信息。
innererror	errorInfo	错误的代码和消息。内部错误详细信息（如果存在）。
message	string	人工可读错误消息。

errorResponse

错误详细信息。

名称	类型	说明
error	errorInfo	错误的代码和消息。错误详细信息。

MetricId

指标的 ID。这是标准 AI 指标或特定于应用程序的自定义指标。

名称	类型	说明
availabilityResults/availabilityPercentage	string
availabilityResults/duration	string
billing/telemetryCount	string
client/networkDuration	string
client/processingDuration	string
client/receiveDuration	string
client/sendDuration	string
client/totalDuration	string
customEvents/count	string
dependencies/count	string
dependencies/duration	string
dependencies/failed	string
exceptions/browser	string
exceptions/count	string
exceptions/server	string
pageViews/count	string
pageViews/duration	string
performanceCounters/exceptionsPerSecond	string
performanceCounters/memoryAvailableBytes	string
performanceCounters/processCpuPercentage	string
performanceCounters/processIOBytesPerSecond	string
performanceCounters/processPrivateBytes	string
performanceCounters/processorCpuPercentage	string
performanceCounters/requestExecutionTime	string
performanceCounters/requestsInQueue	string
performanceCounters/requestsPerSecond	string
requests/count	string
requests/duration	string
requests/failed	string
sessions/count	string
users/authenticated	string
users/count	string

MetricsAggregation

计算指标值时使用的聚合。若要一次检索多个聚合，请使用逗号分隔它们。如果未指定聚合，则使用指标的默认聚合。

名称	类型	说明
avg	string
count	string
max	string
min	string
sum	string
unique	string

metricsResult

指标结果。

名称	类型	说明
value	metricsResultInfo	指标结果数据。

metricsResultInfo

指标结果数据。

名称	类型	说明
end	string	指标的开始时间。
interval	string	用于对指标数据进行分段的间隔。
segments	metricsSegmentInfo[]	如果分段) ，则 (分段指标数据。
start	string	指标的开始时间。

MetricsSegment

要根据指标值进行分段的维度的名称。此维度必须适用于要检索的指标。若要一次按多个维度分段，请使用逗号 (，) 分隔它们。在这种情况下，指标数据将按照参数中列出维度的顺序进行分段。

名称	类型	说明
applicationBuild	string
applicationVersion	string
authenticatedOrAnonymousTraffic	string
browser	string
browserVersion	string
city	string
cloudRoleName	string
cloudServiceName	string
continent	string
countryOrRegion	string
deploymentId	string
deploymentUnit	string
deviceType	string
environment	string
hostingLocation	string
instanceName	string

metricsSegmentInfo

指标段

名称	类型	说明
end	string	仅当) 指定了间隔时，指标段的开始时间才 (。
segments	metricsSegmentInfo[]	如果进一步细分) ，则分段指标数据 (。
start	string	仅当) 指定了间隔时，指标段的开始时间才 (。

通过

Metrics - Get

URI 参数

响应

安全性

oauth2

作用域

示例

intervaledMetric

示例请求

示例响应

segmentedIntervaledMetric

示例请求

示例响应

simpleMetric

示例请求

示例响应

定义

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo

其他资源