文档中心

应用性能监控全链路版

报警

GetAlarmMetricRelatedMeta

获取指定指标支持的筛选条件，分组维度和归因维度。

请求说明

客户端监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmMetricRelatedMeta&Version=2022-10-12

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	GetAlarmMetricRelatedMeta	接口名称。当前 API 的名称为 GetAlarmMetricRelatedMeta。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
common	Object of Common	否	-	通用参数。
measure	Object of Measure	否	-	报警指标。

Common

参数	类型	是否必选	示例值	描述
aid	Long	否	12345	应用ID。
os	String	否	webpro	服务类型。

Measure

参数	类型	是否必选	示例值	描述
type	String	否	monomial	指标类型。 monomial：普通指标 polynomial：复合指标
raw_measure_list	Array of RawMeasureList	否	-	所有指标的集合。
formula	String	否	-	指标四则运算。当指标类型会复合指标polynomial时选填。
name	String	否	PV	指标名。当指标为普通指标时，为指标名。当指标为复合指标时，为自定义指标名。

RawMeasureList

参数	类型	是否必选	示例值	描述
measure_name	String	否	pv_uv.count	简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_list	Array of FilterList	否	-	筛选条件。当指标类型为复合指标时，或者单个简单指标携带条件时选填。
event_name	String	否	-	自定义事件key。当指标为自定义事件指标时选填。

参数	类型	是否必选	示例值	描述
op	String	否	in	筛选条件符号。支持in，not_in，regex，not_regex。
filter_name	String	否	browser_brand	筛选字段。
values	Array of String	否	["Chrome"]	筛选条件值。调用GetAlarmMetricCandidata接口查看取值。

请求示例

POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmMetricRelatedMeta&Version=2022-10-12​
{​
    "measure":{​
        "type":"monomial",​
        "raw_measure_list":[​
            {​
                "measure_name":"pv_uv.count",​
                "event_name":"",​
                "filter_list":[​
                    {​
                        "filter_name":"browser_brand",​
                        "values":[​
                            "Chrome"​
                        ],​
                        "op":"in"​
                    }​
                ]​
            }​
        ],​
        "formula":"",​
        "name":"PV",​
        "unit":{​
            "unit_type":"",​
            "unit":""​
        }​
    },​
    "common":{​
        "aid":12345,​
        "os":"webpro"​
    }​
}

返回参数

参数	类型	示例值	描述
data	Object of Data	-	返回内容。
error_msg	String	-	错误信息。
error_no	Integer	0	错误码。成功为0。

Data

参数	类型	示例值	描述
filter_meta_list	Array of FilterMetaList	-	支持的筛选条件。
group_meta_list	Array of GroupMetaList	-	支持的分组维度。
attribution_dimension_list	Array of AttributionDimensionList	-	支持的归因维度。

FilterMetaList

参数	类型	示例值	描述
label	String	pid	筛选条件名。
filter_name	String	pid	筛选条件唯一key。
filter_type	String	regex	筛选条件类型。

GroupMetaList

参数	类型	示例值	描述
label	String	work_country	分组维度。
group_by_name	String	{"dimension":"context","map_key":"work_country"}	分组维度唯一key。
related_measure_name	Array of String	js错误/pv	分组维度相关判断。

AttributionDimensionList

参数	类型	示例值	描述
label	String	pid	归因维度名。
group_by_name	String	pid	归因维度唯一key。

返回示例

{​
    "err_detail":"",​
    "data":{​
        "filter_meta_list":[​
            {​
                "label":"pid",​
                "filter_name":"pid",​
                "filter_type":"regex"​
            },​
            {​
                "label":"work_country",​
                "filter_name":"{\"dimension\":\"context\",\"map_key\":\"work_country\"}",​
                "filter_type":"regex"​
            }​
        ],​
        "group_meta_list":[​
            {​
                "label":"pid",​
                "group_by_name":"pid"​
            },​
            {​
                "label":"work_country",​
                "group_by_name":"{\"dimension\":\"context\",\"map_key\":\"work_country\"}",​
                "related_measure_name":[​
                    "js错误/pv"​
                ],​
                "comment":{​
                    "link":"",​
                    "comment":"",​
                    "event_comment":""​
                }​
            }​
        ],​
        "attribution_dimension_list":[​
            {​
                "label":"pid",​
                "group_by_name":"pid"​
            }​
        ],​
        "measure_type":""​
    },​
    "error_msg":"",​
    "error_no":0​
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.08.28 16:25:31

这个页面对您有帮助吗？

有用

无用