You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/报警/GetAlarmMetricRelatedMeta
GetAlarmMetricRelatedMeta
最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:01
我的收藏

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

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=GetAlarmMetricRelatedMeta&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetAlarmMetricRelatedMeta接口名称。当前 API 的名称为 GetAlarmMetricRelatedMeta。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

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

Common

参数类型是否必选示例值描述
aidLong否12345应用ID。
osString否webpro服务类型。

Measure

参数类型是否必选示例值描述

type

String

否

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList否-所有指标的集合。
formulaString否-指标四则运算。当指标类型会复合指标polynomial时选填。

name

String

否

PV

指标名。

  • 当指标为普通指标时，为指标名。
  • 当指标为复合指标时，为自定义指标名。

RawMeasureList

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

FilterList

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

返回参数

参数类型示例值描述
dataObject of Data-返回内容。
error_msgString-错误信息。
error_noInteger0错误码。成功为0。

Data

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

FilterMetaList

参数类型示例值描述
labelStringpid筛选条件名。
filter_nameStringpid筛选条件唯一key。
filter_typeStringregex筛选条件类型。

GroupMetaList

参数类型示例值描述
labelStringwork_country分组维度。
group_by_nameString{\"dimension\":\"context\",\"map_key\":\"work_country\"}分组维度唯一key。
related_measure_nameArray of Stringjs错误/pv分组维度相关判断。

AttributionDimensionList

参数类型示例值描述
labelStringpid归因维度名。
group_by_nameStringpid归因维度唯一key。

请求示例

POST https://open.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"
    }
}

返回示例

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

错误码

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