You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
合作与生态
支持与服务
开发者
了解我们
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

GetAlarmMetricCandidate

更新时间：2023.04.11 16:11:02

我的收藏

调用GetAlarmMetricCandidate接口获取指定报警指标下具体筛选条件的可选值。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

是

GetAlarmMetricCandidate

请求名称。

Version

String

是

2022-10-12

请求版本。

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

Body

参数

类型

是否必填

示例值

说明

flex_param

object of flex_param

是

-

指定报警指标和筛选条件。

common

object of common

是

-

通用参数。

flex_param

参数

类型

是否必填

示例值

说明

filter_name

string

是

browser_brand

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

measure_list

object of measure_list

是

-

报警指标列表。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。

measure_list

参数

类型

是否必填

示例值

说明

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。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。

event_name

string

否

-

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

filter_list

object of filter_list

否

-

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

filter_list

参数

类型

是否必填

示例值

说明

filter_name

string

是

browser_brand

筛选字段。调用GetAlarmEventMetaMetric接口查看取值。

values

[]string

是

["Chrome"]

筛选条件值。

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

参数

类型

示例值

说明

candidate_list

object of candidate_list

-

筛选条件可选值列表。

candidate_list

参数

类型

示例值

说明

label

string

Chrome

筛选条件。

value

string

Chrome

筛选条件的可选值。

请求示例 

POST https://open.volcengineapi.com/?Action=GetAlarmMetricCandidate&Version=2022-10-12

{
    "flex_param":{
        "filter_name":"browser_brand",
        "measure_list":[
            {
                "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"
            }
        ]
    },
    "common":{
        "aid":12345,
        "os":"webpro"
    }
}

返回示例 

{
    "err_detail":"",
    "data":{
        "candidate_list":[
            {
                "label":"Chrome",
                "value":"Chrome"
            },
            {
                "label":"Chrome Mobile iOS",
                "value":"Chrome Mobile iOS"
            }
        ]
    },
    "error_msg":"",
    "error_no":0
}