GetAppExceptionalBatteryIssueList--应用性能监控全链路版-火山引擎

文档中心

导航

GetAppExceptionalBatteryIssueList

最近更新时间：2024.07.15 16:31:31首次发布时间：2024.04.25 17:57:50

获取App耗电异常列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=GetAppExceptionalBatteryIssueList&Version=2024-04-09

ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAppExceptionalBatteryIssueList`	接口名称。当前 API 的名称为 `GetAppExceptionalBatteryIssueList`。
Version	String	是	`2024-04-09`	接口版本。当前 API 的版本为 `2024-04-09`。

Body

参数	类型	是否必选	示例值	描述
start_time	Integer	否	`1619827200`	查询起始时间（Unix时间戳）。
end_time	Integer	否	`1619913600`	查询结束时间（Unix时间戳）。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
is_new	Integer	否	`0`	issue新增状态。 0 ：不是新增issue 1 ：新增issue
page_no	Integer	否	`1`	页码。
page_size	Integer	否	`20`	每页大小。
status	Array of String	否	`pending`	处理状态。 pending：未修复 processing：修复中 ignored：已忽略 solved：已修复 reopen：重复出现
managers	Array of Long	否	`[123456, 789012]`	按责任人筛选，传用户ID列表。
tags	Array of Long	否	`[111, 222]`	传自定义标签ID列表。
token	String	否	`keyword`	搜索关键字。
order_by	String	否	`trace_cnt_desc`	排序字段和方式。

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	Object of BatteryTraceIssueData	`-`	返回内容。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

BatteryTraceIssueData

参数	类型	示例值	描述
total	Integer	`10`	列表总数。
result	Array of IssuePageItem	`-`	列表详情。

IssuePageItem

参数	类型	示例值	描述
issue	Object of IssueInfo	`-`	issue状态相关信息，目前包括责任人和状态。
stack	Object of ParsedStack	`-`	堆栈相关信息。
issue_id	String	`issue_12345`	issue ID。
trace_cnt	Integer	`100`	发生次数。
trace_type	Integer	`1`	跟踪类型。
trace_user	Integer	`50`	影响用户数。
end_app_version	String	`1.0.5`	结束版本。
first_event_time	Integer	`1619820000`	首次事件时间。
last_report_time	Integer	`1619900000`	最后一次报告的时间。
start_app_version	String	`1.0.0`	开始版本。
trace_cnt_compare	Double	`0.1`	发生次数变化率。
trace_user_compare	Double	`0.2`	影响用户数变化率。
end_update_version_code	String	`1.0.5`	结束应用小版本
start_update_version_code	String	`1.0.0`	起始应用小版本

IssueInfo

参数	类型	示例值	描述
id	Long	`1112121`	issue在mysql里的ID，不同于issue_id。
tag	Array of Tags	`-`	标签。
status	String	`processing`	issue状态。 pending：未修复 processing：修复中 ignored：已忽略 solved：已修复 reopen：重复出现
fixed_version	String	`v1.1.2`	修复版本号。

ParsedStack

参数	类型	示例值	描述
brief	String	`Crash due to null object reference`	堆栈的简要描述。
title	String	`NullPointerException`	堆栈标题。
detail	String	`at com.example.myapp.MainActivity.onCreate`	堆栈详情。
error_msg	String	`retrace error`	retrace 符号表相关错误，提示用户
unexist_libs	JSON Map		缺失符号表信息，key: 组件名，value: UUID

参数	类型	示例值	描述
id	Long	`301`	tag ID。
key	String	`component`	tag key。
values	Array of ValueId	`-`	tag value。

UnexistLibs

参数	类型	示例值	描述
key	String
value	String

ValueId

参数	类型	示例值	描述
id	Long	`201`	tag valueID。
value	String	`production`	tag value。

请求示例

POST https://open.volcengineapi.com?Action=GetAppExceptionalBatteryIssueList&Version=2024-04-09
{
    "start_time": 1619827200,
    "end_time": 1619913600,
    "filters": {
        "type": "and",
        "sub_conditions": [
            {
                "dimension": "apm_version",
                "type": "expression",
                "op": "in",
                "values": [
                    "1.4.5"
                ]
            },
            {
                "dimension": "device_model",
                "type": "expression",
                "op": "in",
                "values": [
                    "MI 5X"
                ]
            }
        ]
    },
    "is_new": 0,
    "page_no": 1,
    "page_size": 20,
    "status": [
        "pending"
    ],
    "managers": [
        123456,
        789012
    ],
    "tags": [
        111,
        222
    ],
    "token": "keyword",
    "order_by": "trace_cnt_desc"
}

返回示例

{
    "data": {
        "total": 10,
        "result": [
            {
                "issue": {
                    "id": 1112121,
                    "tag": [
                        {
                            "id": 301,
                            "key": "component",
                            "values": [
                                {
                                    "id": 201,
                                    "value": "production"
                                }
                            ]
                        }
                    ],
                    "status": "processing",
                    "fixed_version": "v1.1.2"
                },
                "stack": {
                    "brief": "Crash due to null object reference",
                    "title": "NullPointerException",
                    "detail": "at com.example.myapp.MainActivity.onCreate"
                },
                "issue_id": "issue_12345",
                "trace_cnt": 100,
                "trace_type": 1,
                "trace_user": 50,
                "end_app_version": "1.0.5",
                "first_event_time": 1619820000,
                "last_report_time": 1619900000,
                "start_app_version": "1.0.0",
                "trace_cnt_compare": 0.1,
                "trace_user_compare": 0.2
            }
        ]
    },
    "error_msg": "",
    "error_no": 0
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

BatteryTraceIssueData

IssuePageItem

IssueInfo

ParsedStack

Tags

UnexistLibs

ValueId

请求示例

返回示例

错误码