You need to enable JavaScript to run this app.
导航

GetAppExceptionIssueList

最近更新时间2023.05.10 14:58:40

首次发布时间2023.03.13 16:59:23

调用GetAppExceptionIssueList接口获取App端崩溃分析、MetricKit、崩溃防护、自定义错误、卡顿分析相关的issue列表。

使用说明

  • 接口名称:GetAppExceptionIssueList
  • 请求方式:POST
  • 接口地址:/?Action=GetAppExceptionIssueList&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

string

GetAppExceptionIssueList

请求名称。

Version

string

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

aid

i32

123456

应用ID。

start_time

i32

1677772800

开始时间。

end_time

i32

1678442865

终止时间。

biz_type

string

crash

异常类型。

  • crash:崩溃
  • crash_defend:崩溃防护
  • lag:卡顿
  • custom_exception:自定义异常
  • metric_kit:MetricKit

filters

object of filters

-

筛选条件。

is_new

i32

0

是否新增issue。

  • 0:不是新增issue
  • 1:是新增issue

token

string

-

搜索关键字。

page_no

i32

1

页号。

page_size

i32

1

每页项数。

order_by

string

crash_user_ascend

排序。

  • crash_user_ascend:用户数升序
  • crash_user_descend:用户数降序
  • crash_count_ascend:上报量升序
  • crash_count_descend:上报量降序

status

array of string

[
"pending"
]

issue状态,支持多个。

  • pending:未修复
  • processing:修复中
  • ignored:已忽略
  • solved:已修复
  • reopen:重复出现

managers

array of string

-

按责任人筛选,传用户ID列表。

tags

array of string

-

标签。

time_type

string

-

时间类型。

  • api_time:上报时间(默认)
  • event_time:发生时间

filters

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型。

  • expression:表达式
  • map:映射
  • and:且条件
  • or:或条件

op

string

in

操作符。

  • in:包含

dimension

string

aid

条件的名称。

values

array of string

[123456]

筛选值,支持多个。

value

string

123456

筛选值。

map_key

string

key_1

map类型key,当type为map时必填。

sub_conditions

array of sub_conditions

-

子条件。

sub_conditions

参数

类型

是否必选

示例值

描述

type

string

expression

筛选条件类型。

  • expression:表达式
  • map:映射
  • and:且条件
  • or:或条件

op

string

in

操作符。

  • in:包含

dimension

string

os

条件的名称。

values

array of string

["Android"]

筛选值,支持多个。

value

string

123456

筛选值。

map_key

string

key_1

map类型key,当type为map时必填。

sub_conditions

array of string

-

子条件。

返回参数

参数

类型

示例值

描述

data

object of data

-

返回数据。

error_msg

string

-

错误信息。

error_no

i32

0

错误码。

data

参数

类型

示例值

描述

result

array of result

-

崩溃列表数据。

total

i32

12

崩溃列表中的崩溃数据个数。

result

参数

类型

示例值

描述

issue_id

string

7e753d***b0267

issue ID。

crash_type

string

anr

崩溃类型。

  • java:Java崩溃
  • launch:Java启动崩溃
  • native:Native崩溃
  • anr:ANR
  • crash:崩溃
  • watch_dog:卡死
  • oom_crash:OOM崩溃
  • extension:Extension崩溃

os

string

Android

操作系统。

  • Android
  • iOS

title

string

-

子标题。

event_detail

string

-

崩溃内容。

block_duration_avg

i64

0

平均卡顿时长。

block_duration_avg_compare

double

0

平均卡顿时长变化率。

latest_crash_time

i64

1677829093865

最近发生时间。

latest_report_time

i64

1677829112000

最近上报时间。

crash_count

i32

21

崩溃次数。

crash_count_compare

double

20

崩溃次数变化率。

crash_user

i32

1

崩溃人数。

crash_user_compare

double

0

崩溃人数变化率。

crash_ratio

double

0.00021714852959424247

崩溃率。

crash_ratio_compare

double

25.16552922198784

崩溃率变化率。

crash_user_ratio

double

0.0004885197850512946

崩溃用户率。

crash_user_ratio_compare

double

0.3634587200781632

崩溃用户率变化率。

start_app_version

string

1.0

开始版本。

end_app_version

string

1.0

结束版本。

stack

object of stack

-

堆栈相关信息。

crash_line_num

string

217

崩溃行号。

issue

object of issue

-

issue状态相关信息,目前包括责任人和状态。

report_cnt_per_lanuch

i64

-

CPU单次启动上报次数。

avg_process_cpu_rate

i64

-

CPU平均进程使用率。

stack

参数

类型

示例值

描述

title

string

com.example.crash.test.MonitorCrashActivity

堆栈标题。

brief

string

-

堆栈的简要描述。

detail

string

-

堆栈详情。

issue

参数

类型

示例值

描述

id

i64

1234567

issue在mysql里的ID,不同于issue_id。

managers

array of managers

-

责任人。

status

string

processing

issue状态。

tag

array of tag

-

标签。

fixed_version

string

-

修复版本号。

managers

参数

类型

示例值

描述

name

string

admin-1

处理人名称。

user_id

i64

1

处理人ID。

示例

请求示例

POST https://open.volcengineapi.com/?Action=GetAppExceptionIssueList&Version=2022-10-12 

{
    "aid":123456,
    "start_time":1677772800,
    "end_time":1678442865,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "Android"
                ]
            }
        ]
    },
    "biz_type":"crash",
    "order_by":"crash_user_ascend",
    "status":[
        "pending"
    ],
    "page_no":1,
    "page_size":1
}

正常返回示例

{
    "err_detail":"",
    "data":{
        "result":[
            {
                "issue_id":"7e753d***b0267",
                "crash_type":"anr",
                "os":"Android",
                "title":"",
                "event_detail":"",
                "block_duration_avg":"0",
                "block_duration_avg_compare":0,
                "latest_crash_time":"1677829093865",
                "latest_report_time":"1677829112000",
                "crash_count":21,
                "crash_count_compare":20,
                "crash_user":1,
                "crash_user_compare":0,
                "crash_ratio":0.00021714852959424247,
                "crash_ratio_compare":25.16552922198784,
                "crash_user_ratio":0.0004885197850512946,
                "crash_user_ratio_compare":0.3634587200781632,
                "start_app_version":"1.0",
                "end_app_version":"1.0",
                "stack":{
                    "title":"com.example.crash.test.MonitorCrashActivity",
                    "brief":"",
                    "detail":"\"main\" prio=5 tid=1 Sleeping\n| group=\"main\" sCount=1 dsCount=0 flags=1 obj=0x70f50458 self=0xf165ce00\n| sysTid=18721 nice=-10 cgrp=default sched=0/0 handle=0xf1c1fdc0\n| state=S schedstat=( 1593032647 271433213 2620 ) utm=126 stm=31 core=5 HZ=100\n| stack=0xff5d4000-0xff5d6000 stackSize=8192KB\n| held mutexes=\nat java.lang.Thread.sleep(Thread.java)\n- sleeping on <0x0c824559> (a java.lang.Object)\nat java.lang.Thread.sleep(Thread.java:440)\n- locked <0x0c824559> (a java.lang.Object)\nat java.lang.Thread.sleep(Thread.java:356)\nat android.os.SystemClock.sleep(SystemClock.java:131)\nat com.example.crash.test.MonitorCrashActivity.onClick(MonitorCrashActivity.java:217)\nat java.lang.reflect.Method.invoke(Method.java)\nat android.view.View$DeclaredOnClickListener.onClick(View.java:6108)\nat android.view.View.performClick(View.java:7259)\nat android.view.View.performClickInternal(View.java:7236)\nat android.view.View.access$3600(View.java:801)\nat android.view.View$PerformClick.run(View.java:27892)\nat android.os.Handler.handleCallback(Handler.java:883)\nat android.os.Handler.dispatchMessage(Handler.java:100)\nat android.os.Looper.loop(Looper.java:214)\nat android.app.ActivityThread.main(ActivityThread.java:7356)\nat java.lang.reflect.Method.invoke(Method.java)\nat com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:492)\nat com.android.internal.os.ZygoteInit.main(ZygoteInit.java:930)"
                },
                "crash_line_num":"217",
                "issue":{
                    "id":"1234567",
                    "managers":[
                        {
                            "name":"admin-1",
                            "user_id":"1"
                        }
                    ],
                    "status":"processing",
                    "tag":[

                    ],
                    "fixed_version":""
                }
            }
        ],
        "total":12
    },
    "error_msg":"",
    "error_no":0
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806*****0232280022D30",
        "Action": "GetAppExceptionIssueList",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}