Get app battery foreground list.

Request description

RUM is deployed across multiple regions worldwide to provide more stable and low-latency access. You can refer to the Service addresses topic to choose the most suitable access point based on your business location.

Request method: POST

Request URL: https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppBatteryPageList&Version=2022-10-12

Request parameters

The following table lists only the request parameters specific to this API and some public parameters. For details, see Public parameters.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	GetAppBatteryPageList	The API name. The current API name is GetAppBatteryPageList.
Version	String	Yes	2022-10-12	The API version. The current API version is 2022-10-12.
start_time	Integer	No	1619827200	Query start time (Unix timestamp).
end_time	Integer	No	1619913600	Query end time (Unix timestamp).
filters	Object of Condition	No	-	The filter condition. You can specify multiple key‑value pairs to filter data.
page_no	Integer	No	1	Page number to query.
page_size	Integer	No	20	Number of items displayed per page.
metrics	String	No	battery_usage	Battery metric name used for the query.
order_by	String	No	avg_ascend	Sorting basis. avg_ascend: Sort by average value in ascending order avg_descend: Sort by average value in descending order pct25_ascend: Sort by 25th percentile value in ascending order pct25_descend: Sort by 25th percentile value in descending order pct50_ascend: Sort by 50th percentile value in ascending order pct50_descend: Sort by 50th percentile value in descending order pct75_ascend: Sort by 75th percentile value in ascending order pct75_descend: Sort by 75th percentile value in descending order pct90_ascend: Sort by 90th percentile value in ascending order pct90_descend: Sort by 90th percentile value in descending order pct99_ascend: Sort by 99th percentile value in ascending order pct99_descend: Sort by 99th percentile value in descending order statistics_cnt_ascend: Sort by statistical count in ascending order statistics_cnt_descend: Sort by statistical count in descending order
scene	String	No	HomePage	Page name to search.

Condition

Parameters	Type	Required	Sample value	Description
op	String	No	in	The operator. gt: greater than gte: greater than or equal to lt: less than lte: less than or equal to eq: equal to neq: not equal to in: contains not_in: does not contain lk: Matches data that fits a specific pattern. nlk: Excludes data that fits a specific pattern.
type	String	No	expression	The type of the filter condition. expression: The current condition is an expression. and: The current condition is a compound expression, and multiple sub-conditions are in an AND logical relationship. or: The current condition is a compound expression, and multiple sub-conditions are in an OR logical relationship. map: The current condition is of map type.
value	String	No	123456	The filter value.
values	Array of String	No	[123456]	The filter value. Multiple filter values are supported.
map_key	String	No	key_1	The key of the map type. It is required when the type is set to map.
dimension	String	No	aid	The name of the condition.
sub_conditions	Array of Condition	No	-	The sub-condition.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of SearchResponseData	-	Returned content
error_msg	String	-	Error message.
error_no	Integer	0	Error code.

SearchResponseData

Parameters	Type	Sample value	Description
total	Integer	10	Total number of items in the list
result	Array of BatteryScenePageItem	-	List details.

BatteryScenePageItem

Parameters	Type	Sample value	Description
pct25	Double	10.5	25th percentile value.
pct50	Double	14.0	50th percentile value (median).
pct75	Double	17.8	75th percentile value.
pct90	Double	19.6	90th percentile value.
pct99	Double	23.4	99th percentile value.
scene	String	HomePage	Page name.
avg_value	Double	15.2	Average metric value.
statistics_cnt	Double	200	Sample count.

Sample response

Error codes

No error codes are specific to this API. If the API call returns an error code, refer to Public error codes for troubleshooting.

Application Performance Management Plus