Get the available values of specific filter criteria under the specified alert metric.

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=GetAlarmMetricCandidate&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	GetAlarmMetricCandidate	The API name. The API name is GetAlarmMetricCandidate.
Version	String	Yes	2022-10-12	The API version. The current API version is 2022-10-12.
common	Object of Common	No	-	Common parameters.
flex_param	Object of FlexParam	No	-	Alert metrics and filtering conditions.

Common

Parameters	Type	Required	Sample value	Description
aid	Long	No	12345	Application ID.
os	String	No	webpro	Service type.

FlexParam

Parameters	Type	Required	Sample value	Description
measure_list	Array of MeasureList	No	-	A list of alert metrics. Call the GetAlarmMeta and GetAlarmEventMetaMetric APIs to view the values.
filter_name	String	No	browser_brand	The key of the filtering condition. Call the GetAlarmMetricRelatedMeta API to view available values.

MeasureList

Parameters	Type	Required	Sample value	Description
type	String	No	monomial	Metric type. monomial: Simple metric polynomial: Composite metric
raw_measure_list	Array of RawMeasureList	No	-	A list of all metrics.
formula	String	No	-	The arithmetic formula for the metric. This parameter is optional when the metric type is polynomial.
name	String	No	PV	The metric name. When the metric is a simple metric, it is the metric name. When the metric is a composite metric, it is the custom metric name.

RawMeasureList

Parameters	Type	Required	Sample value	Description
measure_name	String	No	pv_uv.count	Simple metric key. Call the GetAlarmMeta and GetAlarmEventMetaMetric APIs to view the values.
filter_list	Array of FilterList	No	-	Custom event key. Required when the metric is a custom event metric.
event_name	String	No	-	The filter condition. Optional when a single simple metric carries criteria and the metric type is composite.

Parameters	Type	Required	Sample value	Description
op	String	No	in	Filtering condition operator. Supported values include in, not_in, regex, and not_regex.
filter_name	String	No	browser_brand	Filter field. Call the GetAlarmEventMetaMetric API to view available values.
values	Array of String	No	["Chrome"]	Filtering condition values.

Sample request

Response parameters

Parameters	Type	Sample value	Description
data	Object of Data	-	Response data.
error_msg	String	-	Error message.
error_no	Integer	0	Error code. 0 indicates success.

Data

Parameters	Type	Sample value	Description
candidate_list	Array of CandidateList	-	A list of optional values for filtering conditions.

CandidateList

Parameters	Type	Sample value	Description
label	String	Chrome	The filter condition.
value	String	Chrome	Available value for the filtering condition.

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