你当前正在访问 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持续时间。如果省略间隔，则指标值将在整个时间跨度内聚合。如果提供了间隔，服务器可以根据查询所用的时间跨度将间隔调整为更合适的大小。在所有情况下，用于查询的实际间隔都包含在响应中。
orderby	query		string	聚合函数和排序依据的段的方向。仅当指定段时，此值才有效。
segment	query		MetricsSegment[]	要按其细分指标值的维度的名称。此维度必须适用于要检索的指标。若要一次按多个维度分段，请用逗号（，）分隔它们。在这种情况下，指标数据将按维度列在参数中的顺序进行分段。
timespan	query		string	要检索指标值的时间跨度。这是ISO8601时间段值。如果省略时间跨度，则使用默认时间范围 `PT12H`（“过去 12 小时”）。可以基于服务器调整查询的实际时间跨度。在所有情况下，用于查询的实际时间跨度都包含在响应中。
top	query		integer (int32)	要返回的段数。仅当指定段时，此值才有效。

响应

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

安全性

oauth2

连接到 Azure Application 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

Object

错误详细信息。

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

errorInfo

Object

错误的代码和消息。

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

errorResponse

Object

错误详细信息。

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

MetricId

枚举

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

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

MetricsAggregation

枚举

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

值	说明
min
max
avg
sum
count
unique

metricsResult

Object

指标结果。

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

metricsResultInfo

Object

指标结果数据。

名称	类型	说明
end	string (date_time)	指标的开始时间。
interval	string (duration)	用于分段指标数据的间隔。
segments	metricsSegmentInfo[]	分段指标数据（如果已分段）。
start	string (date_time)	指标的开始时间。

MetricsSegment

枚举

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

值	说明
applicationBuild
applicationVersion
authenticatedOrAnonymousTraffic
browser
browserVersion
city
cloudRoleName
cloudServiceName
continent
countryOrRegion
deploymentId
deploymentUnit
deviceType
environment
hostingLocation
instanceName

metricsSegmentInfo

Object

指标段

名称	类型	说明
end	string (date_time)	指标段的开始时间（仅在指定间隔时）。
segments	metricsSegmentInfo[]	分段指标数据（如果进一步分段）。
start	string (date_time)	指标段的开始时间（仅在指定间隔时）。

通过

Metrics - Get

URI 参数

响应

安全性

oauth2

作用域

示例

intervaledMetric

示例请求

示例响应

segmentedIntervaledMetric

示例请求

示例响应

simpleMetric

示例请求

示例响应

定义

errorDetail

errorInfo

errorResponse

MetricId

MetricsAggregation

metricsResult

metricsResultInfo

MetricsSegment

metricsSegmentInfo