你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Metrics - Get Multiple
检索指标数据
获取多个指标的指标值
POST https://api.applicationinsights.io/v1/apps/{appId}/metrics
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
app
|
path | True |
string |
应用程序的 ID。 这是Azure 门户“API 访问设置”边栏选项卡中的应用程序 ID。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
body |
批处理指标查询。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功的响应 |
|
Other Status Codes |
错误响应对象。 |
安全性
oauth2
连接到 Azure 应用程序 Insights API
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
postMetric
示例请求
POST https://api.applicationinsights.io/v1/apps/DEMO_APP/metrics
[
{
"id": "failed",
"parameters": {
"metricId": "requests/failed",
"timespan": "P2D",
"interval": "P1D"
}
},
{
"id": "count",
"parameters": {
"metricId": "requests/count",
"timespan": "P2D",
"interval": "P1D"
}
}
]
示例响应
[
{
"id": "failed",
"status": 200,
"body": {
"value": {
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-24T19:59:12.488Z",
"interval": "P1D",
"segments": [
{
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-23T00:00:00.000Z",
"requests/failed": {
"sum": 277
}
},
{
"start": "2018-01-23T00:00:00.000Z",
"end": "2018-01-24T00:00:00.000Z",
"requests/failed": {
"sum": 1599
}
},
{
"start": "2018-01-24T00:00:00.000Z",
"end": "2018-01-24T19:59:12.488Z",
"requests/failed": {
"sum": 1392
}
}
]
}
}
},
{
"id": "count",
"status": 200,
"body": {
"value": {
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-24T19:59:12.488Z",
"interval": "P1D",
"segments": [
{
"start": "2018-01-22T19:59:12.488Z",
"end": "2018-01-23T00:00:00.000Z",
"requests/count": {
"sum": 1225
}
},
{
"start": "2018-01-23T00:00:00.000Z",
"end": "2018-01-24T00:00:00.000Z",
"requests/count": {
"sum": 7382
}
},
{
"start": "2018-01-24T00:00:00.000Z",
"end": "2018-01-24T19:59:12.488Z",
"requests/count": {
"sum": 6674
}
}
]
}
}
}
]
定义
名称 | 说明 |
---|---|
error |
错误详细信息。 |
error |
错误的代码和消息。 |
error |
错误详细信息。 |
Metric |
指标的 ID。 这是标准 AI 指标或特定于应用程序的自定义指标。 |
Metrics |
计算指标值时使用的聚合。 若要一次检索多个聚合,请使用逗号分隔它们。 如果未指定聚合,则使用指标的默认聚合。 |
metrics |
指标请求 |
metrics |
指标结果。 |
metrics |
指标结果数据。 |
metrics |
一组指标结果。 |
Metrics |
要按其划分指标值的维度的名称。 此维度必须适用于要检索的指标。 若要一次按多个维度分段,请使用逗号 (,) 分隔它们。 在这种情况下,指标数据将按维度在 参数中列出的顺序进行分段。 |
metrics |
指标段 |
Parameters |
单个指标查询的参数 |
errorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalProperties |
object |
|
code |
string |
错误的代码。 |
message |
string |
人工可读的错误消息。 |
resources |
string[] |
指示导致错误的资源。 |
target |
string |
指示请求中的哪个属性是导致错误的。 |
value |
string |
指示“target”中的哪个值导致错误。 |
errorInfo
错误的代码和消息。
名称 | 类型 | 说明 |
---|---|---|
additionalProperties |
object |
|
code |
string |
计算机可读错误代码。 |
details |
错误详细信息。 |
|
innererror |
错误的代码和消息。 |
|
message |
string |
人工可读的错误消息。 |
errorResponse
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
error |
错误的代码和消息。 |
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 |
metricsPostBodySchema
指标请求
名称 | 类型 | 说明 |
---|---|---|
id |
string |
此查询的标识符。 在请求的帖子正文中必须是唯一的。 此标识符将是表示此查询的响应对象的“id”属性。 |
parameters |
单个指标查询的参数 |
metricsResult
指标结果。
名称 | 类型 | 说明 |
---|---|---|
value |
指标结果数据。 |
metricsResultInfo
指标结果数据。
名称 | 类型 | 说明 |
---|---|---|
end |
string |
指标的开始时间。 |
interval |
string |
用于对指标数据进行分段的间隔。 |
segments |
如果分段) ,则 (分段指标数据。 |
|
start |
string |
指标的开始时间。 |
metricsResults
一组指标结果。
名称 | 类型 | 说明 |
---|---|---|
body |
此指标查询的结果。 |
|
id |
string |
此指标的指定 ID。 |
status |
integer |
此指标查询的 HTTP 状态代码。 |
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 |
如果进一步细分) ,则细分指标数据 (。 |
|
start |
string |
仅当) 指定间隔时,指标段的开始时间才 (。 |
Parameters
单个指标查询的参数
名称 | 类型 | 说明 |
---|---|---|
aggregation |
计算指标值时使用的聚合。 若要一次检索多个聚合,请使用逗号分隔它们。 如果未指定聚合,则使用指标的默认聚合。 |
|
filter |
string |
用于筛选结果的表达式。 此值应是有效的 OData 筛选器表达式,其中每个子句的键应是所检索指标的适用维度。 |
interval |
string |
检索指标值时要使用的时间间隔。 这是一个ISO8601持续时间。 如果省略间隔,则会在整个时间跨度内聚合指标值。 如果提供间隔,服务器可能会根据查询所用的时间跨度将间隔调整为更合适的大小。 在所有情况下,用于查询的实际间隔都包含在响应中。 |
metricId |
指标的 ID。 这是标准 AI 指标或特定于应用程序的自定义指标。 |
|
orderby |
string |
对段进行排序的聚合函数和方向。 此值仅在指定段时有效。 |
segment |
要按其划分指标值的维度的名称。 此维度必须适用于要检索的指标。 若要一次按多个维度分段,请使用逗号 (,) 分隔它们。 在这种情况下,指标数据将按维度在 参数中列出的顺序进行分段。 |
|
timespan |
string |
检索指标值的时间跨度。 这是一个ISO8601时间段值。 如果省略时间跨度,则使用默认时间范围 |
top |
integer |
要返回的段数。 此值仅在指定段时有效。 |