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

文档中心

导航

GetAppMemoryDetail

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

获取单个内存的摘要信息。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
os	String	否	`android`	系统类型。 Android：安卓 iOS：iOS
memory_type	String	否	`leaked`	内存问题类型。 leaked：泄露 large_object：大对象
issue_id	String	否	`issue123`	issue的唯一标识符。
start_time	Integer	否	`1665417600`	开始时间（Unix时间戳）。
end_time	Integer	否	`1665504000`	结束时间（Unix时间戳）。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
token	String	否	`error`	搜索关键字或令牌，用于查询特定信息。

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

DetailResponseData

参数	类型	示例值	描述
user	Integer	`50`	影响的用户数。
count	Integer	`100`	错误数。
issue	Object of IssueInfo	`-`	issue状态相关信息，目前包括责任人和状态。
title	String	`android.graphics.Bitmap`	issue详情信息。
sub_title	String	`thread com.apm.insight.runtime.u$c.contextClassLoader`	issue线程信息。
user_rate	Double	`0.05`	影响用户比例。
count_rate	Double	`0.02`	错误率。
user_compare	Double	`20`	前一统计周期的影响用户数。
count_compare	Double	`1`	前一统计周期的错误数。
latest_event_time	Long	`1665504000`	最晚出现错误的时间（Unix时间戳）。
user_rate_compare	Double	`0.02`	影响用户比例变化率。
count_rate_compare	Double	`-0.01`	错误率变化率。
latest_report_time	Long	`1665580400`	最后一次报告错误的时间（Unix时间戳）。
earliest_event_time	Long	`1665417600`	最早出现错误的时间（Unix时间戳）。

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=GetAppMemoryDetail&Version=2024-04-09
{
    "os": "android",
    "memory_type": "leaked",
    "issue_id": "issue123",
    "start_time": 1665417600,
    "end_time": 1665504000,
    "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": "error"
}

返回示例

{
    "data": {
        "user": 50,
        "count": 100,
        "issue": "",
        "title": "android.graphics.Bitmap",
        "sub_title": "thread com.apm.insight.runtime.u$c.contextClassLoader",
        "user_rate": 0.05,
        "count_rate": 0.02,
        "user_compare": 20,
        "count_compare": 1,
        "latest_event_time": 1665504000,
        "user_rate_compare": 0.02,
        "count_rate_compare": -0.01,
        "latest_report_time": 1665580400,
        "earliest_event_time": 1665417600
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

DetailResponseData

IssueInfo

Tags

ValueId

请求示例

返回示例

错误码