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

文档中心

立即注册

导航

MiniProAlarmMetricsMeta

最近更新时间：2024.07.15 15:52:21首次发布时间：2024.04.03 17:37:06

根据指标获取过滤和分组、归因维度。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=MiniProAlarmMetricsMeta&Version=2024-03-12

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
common	Object of Common	是	`-`	通用参数。
measure	Object of Measure	否	`-`	报警指标。

Common

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
os	String	否	`minipro`	服务类型。取值支持app、webpro、minipro。

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`接口查看取值。

String

否

in

筛选条件符号。

in
not_in
regex
not_regex

filter_name String 否 browser_brand 筛选字段。

values Array of String 否 ["Chrome"] 筛选条件值。调用GetAlarmMetricCandidata接口查看取值。

返回参数

参数	类型	示例值	描述
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。

请求示例

POST https://open.volcengineapi.com?Action=MiniProAlarmMetricsMeta&Version=2024-03-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": "minipro"
    }
}

返回示例

{
    "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
}

错误码

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

应用性能监控全链路版