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

文档中心

导航

GetAppMemoryList

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

获取内存泄露或者大对象的列表信息。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
os	String	否	`Android`	操作系统。 Android：安卓 iOS：iOS
start_time	Integer	否	`1665417600`	开始时间（Unix时间戳）。
end_time	Integer	否	`1665417600`	终止时间（Unix时间戳）。
type	String	否	`leaked`	内存问题类型。 leaked：泄漏 large_object：大对象
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
token	String	否	`ttt`	搜索关键字或令牌，用于查询特定信息。
page_no	Integer	否	`1`	页号。
page_size	Integer	否	`10`	每页项数。
order_by	String	否	`count_ascend`	排序方式。 count_ascend：泄露数升序 count_descend：泄漏数降序 user_ascend：影响用户数升序 user_descend：影响用户数降序 avg_size_ascend：平均内存大小升序 avg_size_descend：平均内存大小降序 total_ascend：内存总大小升序 total_descend：内存总大小降序
is_new	Integer	否	`0`	是否新增issue。 1：只看新增issue 0：全部issue
status	Array of String	否	`["pending"]`	处理状态。 pending：未修复 processing：修复中 ignored：已忽略 solved：已修复 reopen：重复出现
managers	Array of Long	否	`-`	按责任人筛选，传用户ID列表。
tags	Array of Integer	否	`-`	自定义标签筛选。

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 AnalysesListResponseData	`-`	返回内容。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

AnalysesListResponseData

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

AnalysesListItem

参数	类型	示例值	描述
user	Integer	`75`	影响用户数。
count	Integer	`75`	错误数。
issue	Object of IssueInfo	`-`	标签和issue状态、处理人issue状态相关信息，目前包括责任人和状态。
title	String	`com.example.apminsightdemo.NetworkFragment`	对象、类相关信息，暂未定义对象、类相关信息。
avg_size	Double	`75KB`	平均大小。
issue_id	String	`1f8f1ad29b14e18ef605e1319c8e6cfe`	issue的唯一标识符。
sub_title	String	`thread com.apm.insight.runtime.u$c.contextClassLoader`	线程信息。
total_size	Double	`75KB`	总大小。
max_version	String	`2.0`	issue的结束版本。
min_version	String	`1.0`	issue的开始版本。
top_version	String	`1.5`	影响最大的issue版本。
user_compare	Double	`0.75`	影响用户数变化率。
count_compare	Double	`0.75`	错误数变化率。
avg_size_compare	Double	`0.75`	平均大小变化率。
top_version_count	Integer	`100`	影响最大版本的泄漏数目。
total_size_compare	Double	`0.75`	总大小变化率。
top_version_percent	Double	`0.75`	影响最大版本占比。
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`	修复版本号。

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

ValueId

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

请求示例

POST https://open.volcengineapi.com?Action=GetAppMemoryList&Version=2024-04-09
{
    "os": "Android",
    "start_time": 1665417600,
    "end_time": 1665417600,
    "type": "leaked",
    "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"
                ]
            }
        ]
    },
    "token": "ttt",
    "page_no": 1,
    "page_size": 10,
    "order_by": "count_ascend",
    "is_new": 0,
    "status": [
        "pending"
    ],
    "managers": [
        130
    ],
    "tags": [
        722
    ]
}

返回示例

{
    "data": {
        "total": 10,
        "result": [
            {
                "user": 75,
                "count": 75,
                "issue": {
                    "id": 1112121,
                    "tag": [
                        {
                            "id": 301,
                            "key": "component",
                            "values": [
                                {
                                    "id": 201,
                                    "value": "production"
                                }
                            ]
                        }
                    ],
                    "status": "processing",
                    "fixed_version": "v1.1.2"
                },
                "title": "com.example.apminsightdemo.NetworkFragment",
                "avg_size": 75,
                "issue_id": "1f8f1ad29b14e18ef605e1319c8e6cfe",
                "sub_title": "thread com.apm.insight.runtime.u$c.contextClassLoader",
                "total_size": 75,
                "max_version": "2.0",
                "min_version": "1.0",
                "top_version": "1.5",
                "user_compare": 0.75,
                "count_compare": 0.75,
                "avg_size_compare": 0.75,
                "top_version_count": 100,
                "total_size_compare": 0.75,
                "top_version_percent": 0.75
            }
        ]
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

AnalysesListResponseData

AnalysesListItem

IssueInfo

Tags

ValueId

请求示例

返回示例

错误码