文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ APP监控/ App监控查询总览卡片 - ShowRumAppViewOverviewCard
更新时间:2026-11-20 GMT+08:00
分享

App监控查询总览卡片 - ShowRumAppViewOverviewCard

功能介绍

查询APP监控总览页面的统计数据卡片。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm:application:getService

    Read

    -

    -

    apm:apm2Service:get

    -

URI

POST /v2/rum-app/view/get-overview-card/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

参数解释:

App应用ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

从IAM服务获取的用户Token。获取方式请参见:获取Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

start_timestamp

是

String

参数解释:

查询开始时间,毫秒时间戳。

约束限制:

开始时间和结束时间必须同时设置。

取值范围:

毫秒级时间戳字符串。

默认取值:

不涉及。

end_timestamp

是

String

参数解释:

查询结束时间,毫秒时间戳。

约束限制:

开始时间和结束时间必须同时设置。

取值范围:

毫秒级时间戳字符串。

默认取值:

不涉及。

search_list

否

Array of Map<String,String> objects

参数解释:

搜索条件列表。

约束限制:

不涉及。

request_id

否

String

参数解释:

请求ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

page

否

Integer

参数解释:

当前页码。

约束限制:

不涉及。

取值范围:

大于0的整数。

默认取值:

1

page_size

否

Integer

参数解释:

每页最大返回的记录数。

约束限制:

不涉及。

取值范围:

大于0的整数。

默认取值:

10

match_text

否

String

参数解释:

匹配文本。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

order_by

否

String

参数解释:

排序规则。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

type

否

String

参数解释:

查询类型。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

device_id

否

String

参数解释:

设备ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

state

否

String

参数解释:

状态筛选条件。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

tags

否

String

参数解释:

标签筛选条件。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

range_min

否

Long

参数解释:

取值范围最小值。

约束限制:

不涉及。

取值范围:

整数。

默认取值:

不涉及。

range_max

否

Long

参数解释:

取值范围最大值。

约束限制:

不涉及。

取值范围:

整数。

默认取值:

不涉及。

keyword_match

否

String

参数解释:

关键字匹配内容。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

t

是

String

参数解释:

功能类型,取值决定查询的数据类型。

约束限制:

必填。

取值范围:

  • anr:ANR卡顿。

  • crash:崩溃。

  • loopAnr:循环ANR。

  • custom-event-key:自定义事件键。

  • custom-event-value:自定义事件值。

  • device-dvc:设备机型。

  • device-area:设备地域。

  • device-osv:设备系统。

  • device-isp:设备运营商。

  • device-appv:设备版本。

  • device-net:设备网络。

  • device:设备。

  • error:错误。

  • network:网络。

  • network-state:网络状态。

  • network-api:网络API。

  • launch:启动。

默认取值:

不涉及。

timestamp

否

Long

参数解释:

上报时间戳。

约束限制:

不涉及。

取值范围:

整数。

默认取值:

不涉及。

url

否

String

参数解释:

页面URL。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

uuid

否

String

参数解释:

会话唯一标识。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

custom_key

否

String

参数解释:

自定义维度键。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

str_val

否

String

参数解释:

自定义维度值。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

ssid

否

String

参数解释:

会话标识。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

name

否

String

参数解释:

名称。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

function_type

否

String

参数解释:

查询的功能类型。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

查询结果状态。

取值范围:

不涉及。

detail

Object

参数解释:

详情内容。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

/v2/rum-app/view/get-overview-card/app-xxxxxx

{
  "start_timestamp" : "1783651200000",
  "end_timestamp" : "1783737599000",
  "t" : "launch"
}

响应示例

状态码:200

{
  "status" : "success",
  "detail" : {
    "crash_count" : 0,
    "total" : 1,
    "slow_count" : 0,
    "normal_count" : 1,
    "avg_t0" : 4872
  }
}

状态码:400

"{\n  \"error_code\": \"apm2.00000005\",\n  \"error_msg\": \"invalid parameter\"\n}"

状态码:403

"{\n  \"error_code\": \"apm2.00000004\",\n  \"error_msg\": \"has no privilege\"\n}"

状态码

状态码

描述

200

查询总览卡片成功。

400

非法请求,建议根据error_msg检查修改该请求。

403

请求被拒绝访问。

错误码

请参见错误码。

相关文档