You need to enable JavaScript to run this app.
导航
GetAlarmMetricRelatedMeta
最近更新时间:2023.04.11 16:11:02首次发布时间:2022.11.01 11:26:01

调用GetAlarmMetricRelatedMeta接口获取指定指标支持的筛选条件,分组维度和归因维度。

使用说明

  • 接口名称:GetAlarmMetricRelatedMeta
  • 请求方式:POST
  • 接口地址:/?Action=GetAlarmMetricRelatedMeta&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

GetAlarmMetricRelatedMeta

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必填

示例值

说明

measure

object of measure

-

报警指标。

common

object of common

-

通用参数。

measure

参数

类型

是否必填

示例值

说明

type

string

monomial

指标类型。

  • monomial:普通指标
  • polynomial:复合指标

raw_measure_list

object of raw_measure_list

-

所有指标的集合。

formula

string

-

指标四则运算公式。当指标类型为复合指标polynomial时选填。

name

string

PV

指标名。

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

raw_measure_list

参数

类型

是否必填

示例值

说明

measure_name

string

pv_uv.count

简单指标key。调用GetAlarmMetaGetAlarmEventMetaMetric接口查看取值。

event_name

string

-

自定义事件key。当指标为自定义事件指标时是。

filter_list

object of filter_list

-

筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。

filter_list

参数

类型

是否必填

示例值

说明

filter_name

string

browser_brand

筛选字段。

values

array

["Chrome"]

筛选条件值。调用GetAlarmMetricCandidata接口查看取值。

op

string

in

筛选条件符号。

  • in
  • not_in
  • regex
  • not_regex

common

参数

类型

是否必填

示例值

说明

aid

int64

12345

应用ID。

os

string

webpro

服务类型。

返回参数

参数

类型

示例值

说明

err_detail

string

-

错误详情

data

object of data

-

返回内容。

error_msg

string

-

错误信息。

error_no

int

0

错误码。0为成功。

data

参数

类型

示例值

说明

filter_meta_list

object of filter_meta_list

-

支持的筛选条件。

group_meta_list

object of group_meta_list

-

支持的分组维度。

attribution_dimension_list

object of attribution_dimension_list

-

支持的归因维度。

filter_meta_list

参数

类型

示例值

说明

label

string

pid

筛选条件名。

filter_name

string

pid

筛选条件唯一key。

filter_type

string

regex

筛选条件类型。

group_meta_list

参数

类型

示例值

说明

label

string

work_country

分组维度。

group_by_name

string

{\"dimension\":\"context\",\"map_key\":\"work_country\"}

分组维度唯一key。

related_measure_name

array

js错误/pv

分组维度相关判断。

attribution_dimension_list

参数

类型

示例值

说明

label

string

pid

归因维度名。

group_by_name

string

pid

归因维度唯一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
}