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

文档中心

导航

GetAppBatteryTrend

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

获取App电量的前台电流值、电池温度的趋势。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
start_time	Integer	否	`1617225600`	查询开始时间（Unix时间戳）。
end_time	Integer	否	`1617312000`	查询结束时间（Unix时间戳）。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
granularity	Integer	否	`5`	聚合粒度，单位是分钟。
metrics	String	否	`battery_electric`	查询的指标名
statistic_scale	String	否	`avg`	统计口径。 avg pct25 pct50 pct75 pct90 pct99
scene	String	否	`main_activity`	页面名称。

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	Array of TrendLine	`-`	不分组的请求下，list只有一个元素，分组情况下会有多个元素，每个元素代表一条线。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

TrendLine

参数	类型	示例值	描述
name	String	`test123`	线的名称，在分组的情况下，name应该是分组维度的取值，比如用来显示曲线的图标。
points	Array of TrendPoint	`-`	曲线上的点。
total	Double		总数

TrendPoint

参数	类型	示例值	描述
alert	Object of AlertPoint	`-`	提示信息。
value	Double	`123`	指标值。
timestamp	Long	`1665417600`	指标发生时间（Unix时间戳）。
readable_timestamp	String	`2022-10-11`	指标发生时间（自然时间）。

AlertPoint

参数	类型	示例值	描述
msg	String	`No error`	提示信息。
alert	Boolean	`true`	是否需要提示。

请求示例

POST https://open.volcengineapi.com?Action=GetAppBatteryTrend&Version=2024-04-09
{
    "start_time": 1617225600,
    "end_time": 1617312000,
    "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"
                ]
            }
        ]
    },
    "granularity": 5,
    "metrics": "battery_electric",
    "statistic_scale": "avg",
    "scene": "main_activity"
}

返回示例

{
    "data": [
        {
            "name": "test123",
            "points": [
                {
                    "alert": {
                        "alert": "true",
                        "msg": "No error"
                    },
                    "value": 123,
                    "timestamp": 1665417600,
                    "readable_timestamp": "2022-10-11"
                }
            ]
        }
    ],
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

TrendLine

TrendPoint

AlertPoint

请求示例

返回示例

错误码