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

文档中心

导航

GetAlarmMeta

最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:01

获取所有类型的报警指标元数据。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=GetAlarmMeta&Version=2022-10-12

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
common	Object of CommonParams	否	`-`	通用参数。

CommonParams

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
site_type	String	是	`web`	站点类型。
env	String	是	`online`	环境，填""时为全部。
os	String	否	`webpro`	服务类型，可选值为webpro，app，minipro。
user	String	否	`test_user`	用户名。

返回参数

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

FlexMetaResponseData

参数	类型	示例值	描述
measure_category_meta_list	Array of FlexMeasureCategoryMetaItem	`-`	报警返回的元数据。

FlexMeasureCategoryMetaItem

参数	类型	示例值	描述
key	String	`pageview`	报警类型唯一key。
type	String	`simple`	类型。 event：选择事件后需要调用事件相关接口 simple：其他的固定的指标
label	String	`用户分析`	报警类型。
measure_meta_list	Array of FlexMeasureMetaItem	`-`	具体报警类型下的报警指标。

FlexMeasureMetaItem

参数类型示例值描述

参数	类型	示例值	描述
type	String	`basic`	该指标下是否有子指标。 basic：没有子指标 group：有子指标
label	String	`PV`	指标名。
measure_name	String	`pv_uv.count`	指标唯一key。

type

String

basic

该指标下是否有子指标。

basic：没有子指标
group：有子指标

label String PV 指标名。

measure_name String pv_uv.count 指标唯一key。

请求示例

POST https://open.volcengineapi.com/?Action=GetAlarmMeta&Version=2022-10-12
{
    "common":{
        "aid":12345,
        "os":"webpro"
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "measure_category_meta_list":[
            {
                "key":"pageview",
                "label":"用户分析",
                "type":"simple",
                "measure_meta_list":[
                    {
                        "key":"",
                        "type":"basic",
                        "label":"PV",
                        "short_label":"",
                        "measure_name":"pv_uv.count"
                    }
                ]
            },
            {
                "key":"performance",
                "label":"性能指标",
                "type":"simple",
                "measure_meta_list":[
                    {
                        "key":"",
                        "type":"group",
                        "label":"DomReady",
                        "short_label":"",
                        "measure_meta_list":[
                            {
                                "key":"",
                                "type":"basic",
                                "label":"DomReady/均值",
                                "short_label":"",
                                "measure_name":"browser_perf.dom_ready.avg"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "error_msg":"",
    "error_no":0
}

错误码

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

应用性能监控全链路版