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

文档中心

导航

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

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

Body

参数	类型	是否必选	示例值	描述
app_id	Integer	是	`12345`	App ID。
page_num	Integer	是	`1`	崩溃列表页数。
page_size	Integer	是	`1`	一次返回崩溃数。
start_time	Integer	是	`1656288235`	开始时间。
end_time	Integer	是	`1656288235`	结束时间。
order	String	否	`desc`	排序。 asc：正序 desc：倒序
order_by_metric	String	否	`user`	用哪个字段排序。 count user
search_text	String	否	`stack info`	堆栈过滤字段。
search_type	Integer	否	`1`	堆栈过滤方式。 0：字符串 1：正则
region	String	否	`cn`	请求区域，默认cn。
issue_ids	Array of String	否	`[]`	搜索的崩溃ID，为空全搜索。
filters	Object of Condition	否	`-`	筛选条件过滤项。
context	JSON 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_managers	Array of String	否	`["zhangshan"]`	过滤崩溃管理人列表。
crash_time_type	String	否	`server_time`	时间类型。 server_time：服务端时间 client_time：客户端时间
is_first_issue	Boolean	否	`false`	是否为新发现的issue。
issue_levels	Array of Integer	否	`[]`	过滤issue等级。
tag_op	String	否	`not_in`	tag过滤方式。 not_in：不包含 in：包含
issue_tags	Array of TagAndGroupId	否	`-`	tag列表。
crash_type	String	否	`""`	崩溃类型。pc_jank或者空。

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	查找类型。 in > <
type	String	否	`and`	条件类型。 and or
values	Array of String	否	`["1", "2"]`	维度值
dimension	String	否	`dim1`	过滤维度。
sub_conditions	Array of Condition	否	`[ { "dimension": "parse_success", "op": "in", "values": [ "1" ], "groupKey": "dimension" } ]`	具体条件。

Context

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

TagAndGroupId

参数	类型	是否必选	示例值	描述
tag_id	Integer	否	`1`	标签ID。
group_id	Integer	否	`1`	标签组ID。

返回参数

参数	类型	示例值	描述
data	Object of ListData	`-`	返回数据。
errmsg	String	`""`	错误信息，成功为空。
errno	Integer	`200`	错误码，成功为200。

ListData

参数	类型	示例值	描述
issue_list	Array of ListItem	`-`	崩溃列表。
issue_list_count	Integer	`32`	崩溃总数。

ListItem

参数	类型	示例值	描述
user	Integer	`22`	崩溃影响用户数。
count	Integer	`30`	崩溃事件数。
issue_id	String	`ff56eea75c0411ed95d`	崩溃ID。
tag_info	Array of Tag	`-`	崩溃标签信息。
user_ratio	Double	`0.01`	用户错误率。
count_ratio	Double	`0.03`	错误率。
issue_level	Integer	`1`	崩溃等级。
crash_reason	String	`outofmemory`	崩溃原因。
issue_status	String	`未处理`	崩溃处理状态。
max_event_id	String	`-`	事件聚合。
top_versions	JSON Map	`{windows: {min: "1.2.1", max: "1.9.0"}}`	崩溃涉及的系统版本信息。
issue_manager	String	`张三`	崩溃管理人。
max_key_stack	String	`d3d11.dll CContext::TID3D11DeviceContext_UpdateSubresource_l`	崩溃聚合堆栈。
user_ratio_avg	Double	`0.02`	平均用户错误率。
user_mini_chart	Array of ChartData	`-`	用户数。
crash_reason_max	String	`outofmemory`	崩溃原因。
error_mini_chart	Array of ChartData	`-`	错误数。
user_rate_mini_chart	Array of ChartData	`-`	用户错误率。
error_rate_mini_chart	Array of ChartData	`-`	错误率。

Tag

参数	类型	示例值	描述
id	Integer	`1`	标签ID。
group_id	Integer	`1`	所属标签组ID。
tag_name	String	`tag`	标签名称。

TopVersions

参数	类型	示例值	描述
key	String	`windows`	崩溃涉及的的系统。
value	Object of VersionRange	`{"min": "1.2.1", "max": "1.9.0"}`	崩溃涉及的的版本。

ChartData

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

VersionRange

参数	类型	示例值	描述
max	String	`2.2.1`	最大版本。
min	String	`1.1.1`	最小版本。

Source

参数	类型	示例值	描述
key	String	`start_time`	维度定义的key。
value	Double	`1665331200`	维度定义的key的取值。

DimensionData

参数类型示例值描述

name String start_time 维度名。

参数	类型	示例值	描述
name	String	`start_time`	维度名。
type	String	`string`	维度值类型。 time string int

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
    }
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

Context

TagAndGroupId

返回参数

ListData

ListItem

Tag

TopVersions

ChartData

VersionRange

Source

DimensionData

请求示例

返回示例

错误码