You need to enable JavaScript to run this app.
导航
PCCrashIssueList
最近更新时间:2024.07.15 14:26:46首次发布时间:2022.11.15 20:38:47

按错误聚合崩溃列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=PCCrashIssueList&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringPCCrashIssueList接口名称。当前 API 的名称为 PCCrashIssueList
VersionString2022-10-28接口版本。当前 API 的版本为 2022-10-28

Body

参数类型是否必选示例值描述
app_idInteger12345App ID。
page_numInteger1崩溃列表页数。
page_sizeInteger1一次返回崩溃数。
start_timeInteger1656288235开始时间。
end_timeInteger1656288235结束时间。

order

String

desc

排序。

  • asc:正序
  • desc:倒序

order_by_metric

String

user

用哪个字段排序。

  • count
  • user
search_textStringstack info堆栈过滤字段。

search_type

Integer

1

堆栈过滤方式。

  • 0:字符串
  • 1:正则
regionStringcn请求区域,默认cn。
issue_idsArray of String[]搜索的崩溃ID,为空全搜索。
filtersObject of Condition-筛选条件过滤项。
contextJSON Map{os_version_parsed: ["10.0.17763 2928", "10.0.10586 0"]}自定义context,key-value样式,是您自定义的筛选项。

issue_states

Array of String

["unassigned", "doing", "done", "be_processed_again"]

过滤的issue状态。

  • unassigned
  • doing
  • done
  • be_processed_again
issue_managersArray of String["zhangshan"]过滤崩溃管理人列表。

crash_time_type

String

server_time

时间类型。

  • server_time:服务端时间
  • client_time:客户端时间
is_first_issueBooleanfalse是否为新发现的issue。
issue_levelsArray of Integer[]过滤issue等级。

tag_op

String

not_in

tag过滤方式。

  • not_in:不包含
  • in:包含
issue_tagsArray of TagAndGroupId-tag列表。
crash_typeString""崩溃类型。pc_jank或者空。

Condition

参数类型是否必选示例值描述

op

String

in

查找类型。

  • in
  • >
  • <

type

String

and

条件类型。

  • and
  • or
valuesArray of String["1", "2"]维度值
dimensionStringdim1过滤维度。
sub_conditionsArray of Condition[ { "dimension": "parse_success", "op": "in", "values": [ "1" ], "groupKey": "dimension" } ]具体条件。

Context

参数类型是否必选示例值描述
keyStringos_version_parsed自定义筛选项的关键字。
valueArray of String["10.0.17763 2928", "10.0.10586 0"]自定义筛选项的取值。

TagAndGroupId

参数类型是否必选示例值描述
tag_idInteger1标签ID。
group_idInteger1标签组ID。

返回参数

参数类型示例值描述
dataObject of ListData-返回数据。
errmsgString""错误信息,成功为空。
errnoInteger200错误码,成功为200。

ListData

参数类型示例值描述
issue_listArray of ListItem-崩溃列表。
issue_list_countInteger32崩溃总数。

ListItem

参数类型示例值描述
userInteger22崩溃影响用户数。
countInteger30崩溃事件数。
issue_idStringff56eea75c0411ed95d崩溃ID。
tag_infoArray of Tag-崩溃标签信息。
user_ratioDouble0.01用户错误率。
count_ratioDouble0.03错误率。
issue_levelInteger1崩溃等级。
crash_reasonStringoutofmemory崩溃原因。
issue_statusString未处理崩溃处理状态。
max_event_idString-事件聚合。
top_versionsJSON Map{windows: {min: "1.2.1", max: "1.9.0"}}崩溃涉及的系统版本信息。
issue_managerString张三崩溃管理人。
max_key_stackStringd3d11.dll CContext::TID3D11DeviceContext_UpdateSubresource_l崩溃聚合堆栈。
user_ratio_avgDouble0.02平均用户错误率。
user_mini_chartArray of ChartData-用户数。
crash_reason_maxStringoutofmemory崩溃原因。
error_mini_chartArray of ChartData-错误数。
user_rate_mini_chartArray of ChartData-用户错误率。
error_rate_mini_chartArray of ChartData-错误率。

Tag

参数类型示例值描述
idInteger1标签ID。
group_idInteger1所属标签组ID。
tag_nameStringtag标签名称。

TopVersions

参数类型示例值描述
keyStringwindows崩溃涉及的的系统。
valueObject of VersionRange{"min": "1.2.1", "max": "1.9.0"}崩溃涉及的的版本。

ChartData

参数类型示例值描述
sourceArray of JSON Map[{start_time: 1665331200}]数据列表。
dimensionsArray of DimensionData-维度列表。

VersionRange

参数类型示例值描述
maxString2.2.1最大版本。
minString1.1.1最小版本。

Source

参数类型示例值描述
keyStringstart_time维度定义的key。
valueDouble1665331200维度定义的key的取值。

DimensionData

参数类型示例值描述
nameStringstart_time维度名。

type

String

string

维度值类型。

  • time
  • string
  • int

请求示例

POST https://open.volcengineapi.com?Action=PCCrashIssueList&Version=2022-10-28
{
    "app_id": 12345,
    "page_num": 1,
    "page_size": 1,
    "start_time": 1656288235,
    "end_time": 1656288235,
    "issue_tags": [
        {
            "group_id": 1,
            "tag_id": 1
        }
    ],
    "region": "cn",
    "filters": {
        "values": [
            "1",
            "2"
        ],
        "dimension": "dim1",
        "type": "and",
        "op": "in",
        "sub_conditions": [
            {
                "dimension": "parse_success",
                "op": "in",
                "values": [
                    "1"
                ],
                "groupKey": "dimension"
            }
        ]
    },
    "context": {
        "os_version_parsed": [
            "10.0.17763 2928",
            "10.0.10586 0"
        ]
    },
    "issue_managers": [
        "zhangshan"
    ],
    "tag_op": "not_in",
    "search_type": 1,
    "issue_states": [
        "unassigned",
        "doing",
        "done",
        "be_processed_again"
    ],
    "order": "desc",
    "order_by_metric": "user",
    "crash_type": "",
    "issue_ids": [],
    "issue_levels": [],
    "crash_time_type": "server_time",
    "search_text": "stack info",
    "is_first_issue": false
}

返回示例

{
    "errmsg": "",
    "errno": 200,
    "data": {
        "issue_list": [
            {
                "max_event_id": "",
                "top_versions": {
                    "windows": {
                        "min": "1.2.1",
                        "max": "1.9.0"
                    }
                },
                "max_key_stack": "d3d11.dll CContext::TID3D11DeviceContext_UpdateSubresource_l",
                "count": 30,
                "issue_manager": "张三",
                "error_mini_chart": [
                    {
                        "dimensions": [
                            {
                                "type": "string",
                                "name": "start_time"
                            }
                        ],
                        "source": [
                            {
                                "start_time": 1665331200
                            }
                        ]
                    }
                ],
                "issue_id": "ff56eea75c0411ed95d",
                "crash_reason_max": "outofmemory",
                "user_ratio": 0.01,
                "tag_info": [
                    {
                        "id": 1,
                        "group_id": 1,
                        "tag_name": "tag"
                    }
                ],
                "error_rate_mini_chart": [
                    {
                        "dimensions": [
                            {
                                "type": "string",
                                "name": "start_time"
                            }
                        ],
                        "source": [
                            {
                                "start_time": 1665331200
                            }
                        ]
                    }
                ],
                "crash_reason": "outofmemory",
                "user_ratio_avg": 0.02,
                "count_ratio": 0.03,
                "issue_level": 1,
                "issue_status": "未处理",
                "user": 22,
                "user_rate_mini_chart": [
                    {
                        "source": [
                            {
                                "start_time": 1665331200
                            }
                        ],
                        "dimensions": [
                            {
                                "type": "string",
                                "name": "start_time"
                            }
                        ]
                    }
                ],
                "user_mini_chart": [
                    {
                        "source": [
                            {
                                "start_time": 1665331200
                            }
                        ],
                        "dimensions": [
                            {
                                "type": "string",
                                "name": "start_time"
                            }
                        ]
                    }
                ]
            }
        ],
        "issue_list_count": 32
    }
}

错误码

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