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

文档中心

导航

GetAppExceptionalBatterySummaryData

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

获取App电量指标。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
start_time	Integer	否	`1619827200`	当前时段起始时间（Unix时间戳）。
end_time	Integer	否	`1619913600`	当前时段结束时间（Unix时间戳）。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
compare_start_time	Integer	否	`1619730800`	对比时段起始时间（Unix时间戳）。
compare_end_time	Integer	否	`1619817200`	对比时段结束时间（Unix时间戳）。
is_new	Integer	否	`1`	新增issue。
status	Array of String	否	`["closed"]`	要考虑的处理状态。
managers	Array of Long	否	`[123456789, 987654321]`	要考虑的责任人ID列表。
tags	Array of Long	否	`[111, 222]`	要考虑的标签ID列表。
token	String	否	`keyword`	搜索关键字。

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

SummaryResponseData

参数	类型	示例值	描述
battery_trace_cnt	Object of SummaryMetric	`-`	电量异常事件数量指标
battery_trace_user	Object of SummaryMetric	`-`	影响用户数量指标
battery_trace_ratio	Object of SummaryMetric	`-`	异常率
battery_trace_user_ratio	Object of SummaryMetric	`-`	影响用户比例指标

SummaryMetric

参数	类型	示例值	描述
rate	Double	`1.1`	变化率。
compare	Double	`90.0`	对比值。
current	Double	`100.0`	当前值。

请求示例

POST https://open.volcengineapi.com?Action=GetAppExceptionalBatterySummaryData&Version=2024-04-09
{
    "start_time": 1619827200,
    "end_time": 1619913600,
    "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"
                ]
            }
        ]
    },
    "compare_start_time": 1619730800,
    "compare_end_time": 1619817200,
    "is_new": 1,
    "status": [
        "closed"
    ],
    "managers": [
        123456789,
        987654321
    ],
    "tags": [
        111,
        222
    ],
    "token": "keyword"
}

返回示例

{
    "data": {
        "battery_trace_cnt": {
            "rate": 1.1,
            "compare": 90,
            "current": 100
        },
        "battery_trace_user": {
            "rate": 1.1,
            "compare": 90,
            "current": 100
        },
        "battery_trace_ratio": {
            "rate": 1.1,
            "compare": 90,
            "current": 100
        },
        "battery_trace_user_ratio": {
            "rate": 1.1,
            "compare": 90,
            "current": 100
        }
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

SummaryResponseData

SummaryMetric

请求示例

返回示例

错误码