You need to enable JavaScript to run this app.
导航

Draw

最近更新时间2023.05.16 17:56:31

首次发布时间2023.01.06 16:49:38

调用Draw接口查询指标的详细信息。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,请参见公共参数

字段

位置

类型

是否必填

说明

Action

Query

String

要执行的操作,取值:Draw。

Version

Query

String

请求版本。取值:2022-11-09。

Graph

Body

Query

详情请参见Graph

CurrentVaribaleValues

Body

Array[Varable]

传入空数组。

StartTime

Body

Int64

开始时间。

EndTime

Body

Int64

结束时间。

GranularityUnit

Body

String

间隔时间周期。

Granularity

Body

Int64

间隔值。

Graph

参数

类型

是否必填

说明

Id

String

前端传入任意值。

GraphType

String

看板类型。

  • time_series:时序图
  • table:表格
  • single_value:值

Name

String

前端传入任意值。

TimeSeriesConf

TimeSeriesGraphConfig

看板类型为time_series时使用。详情请参见TimeSeriesGraphConfig

TableConf

TableGraphConfig

看板类型为table时使用。详情请参见TableGraphConfig

SingleValueConf

SingleValueGraphConfig

看板类型为single_value时使用。详情请参见SingleValueGraphConfig

TimeSeriesGraphConfig

参数

类型

是否必填

说明

SimpleQueries

Array[TimeSeriesQuery]

简单查询。详情请参见TimeSeriesQuery

FormulaQueries

Array[FormulaQuery]

公式查询。详情请参见FormulaQuery

Precision

Int32

精度,小数点后位数。

Marker

Array[Marker]

标记,传入空数组。

ShowLegend

Boolean

是否显示图例。

Legend

Array[String]

图列列表。

TimeSeriesQuery

名称

类型

是否必填

描述

Id

String

查询名称,前端自定义。

Ispromql

Boolean

是否为PromQL指标。

Promql

String

promsql查询。

Metric

String

指标名称。

Unit

String

单位。

Alphabet

String

计算复合指标公式使用的符号。

Alias

String

别名。

MetricCategory

String

Metric类型。

  • host
  • process
  • container
  • custom_metric

MetricSource

String

指标类型。

  • prometheus
  • influxdb

GroupByFields

Array[String]

分组。

Aggregator

String

分组聚合函数。

AddFunc

String

后处理函数。

  • diff
  • per_second_rate
  • per_minute_rate
  • per_second
  • per_minute

Filters

Array[FilterCondition]

过滤条件。详情请参见FilterCondition

Hide

Boolean

是否隐藏。

CounterAs

String

Counter类型。

  • count
  • rate

TableQuery

名称

类型

是否必填

描述

Id

String

查询名称,前端自定义。

Ispromql

Boolean

是否为PromQL指标。

Promql

String

promsql查询。

Metric

String

指标名称。

Unit

String

单位。

Alphabet

String

计算复合指标公式使用的符号。

Alias

String

别名。

MetricCategory

String

Metric类型。

  • host
  • process
  • container
  • custom_metric

MetricSource

String

指标类型。

  • prometheus
  • influxdb

GroupByFields

Array[String]

分组。

Aggregator

String

分组聚合函数。

AddFunc

String

后处理函数。

  • diff
  • per_second_rate
  • per_minute_rate
  • per_second
  • per_minute

Filters

Array[FilterCondition]

过滤条件。详情请参见FilterCondition

Hide

Boolean

是否显示。

CounterAs

String

Counter类型。

  • count
  • rate

RollupTimeframeByAggregator

String

时间窗口聚合方式。

  • AVG
  • SUM
  • LAST
  • COUNT
  • MAX
  • MIN

SingleValueQuery

名称

类型

是否必填

描述

Id

String

查询名称,前端自定义。

Ispromql

Boolean

是否为PromQL指标。

Promql

String

promsql查询。

Metric

String

指标名称。

Unit

String

单位。

Alphabet

String

计算复合指标公式使用的符号。

Alias

String

别名。

MetricCategory

String

Metric类型。

  • host
  • process
  • container
  • custom_metric

MetricSource

String

指标类型。

  • prometheus
  • influxdb

GroupByFields

Array[String]

分组。

Aggregator

String

分组聚合函数。

AddFunc

String

后处理函数。

  • diff
  • per_second_rate
  • per_minute_rate
  • per_second
  • per_minute

Filters

Array[FilterCondition]

过滤条件。详情请参见FilterCondition

Hide

Boolean

是否隐藏。

CounterAs

String

Counter类型。

  • count
  • rate

RollupTimeframeByAggregator

String

时间窗口聚合方式。

  • AVG
  • SUM
  • LAST
  • COUNT
  • MAX
  • MIN

FormulaQuery

字段

类型

是否必填

说明

Formula

String

复合指标计算公式。

Alias

String

展示名称。

Unit

String

单位。

Alphabet

String

计算公式使用的符号。

返回参数

Result字段包含以下参数:

字段

类型

说明

SingleValue

SingleValueData

数值看板。详情请参见SingleValueData

Table

TableData

表格看板。详情请参见TableData

TimeSeries

Array[TimeSeriesData]

时序数据看板。详情请参见TimeSeriesData

SingleValueData

字段

类型

示例值

说明

Value

String

100

数值。

Unit

String

s

单位。

TableData

字段

类型

说明

Columns

Array[String]

列名。

Units

Array[String]

单位,与列名对应。

Rows

Array[Array[String]]

数值。

TimeSeriesData

字段

类型

说明

QueryId

String

请求ID,与request中的ID一致。

Title

String

标题,与request中Alias一致。

Unit

String

单位。

Legend

Legend

图例。

Points

Array[SeriesPoint]

时序数据点。

Tagkvs

Array[Tagkv]

标签。

Legend

字段

类型

说明

Max

Float

最大值。

Min

Float

最小值。

Avg

Float

平均值。

Current

Float

当前值。

SeriesPoint

字段

类型

说明

Timestamp

String

数据时间戳。

Value

String

时序时间点值。

EndTimestamp

String

结束时间戳,用来处理多点合并。

TagKV

字段

类型

说明

Key

String

标记。

Lable

String

标签。

Value

String

标记值。

请求示例

POST https://open.volcengineapi.com?Action=Draw&Version=2022-11-09
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "",
        "Action": "Draw",
        "Version": "2022-11-09",
        "Service": "apmplus_server",
        "Region": "cn-beijing"
    },
    "Result": {
        "SingleValue": {
            "Unit": "",
            "Value": ""
        },
        "Table": {
            "Columns": [],
            "Rows": [],
            "Units": []
        },
        "TimeSeries": [
            {
                "Legend": {
                    "Avg": 199291.5994444445,
                    "Current": 210846.96666666667,
                    "Max": 211086.86666666667,
                    "Min": 190502.8
                },
                "Points": [
                    {
                        "Timestamp": "1668135210",
                        "Value": 190875.13333333333
                    },
                    {
                        "Timestamp": "1668135240",
                        "Value": 190982.33333333334
                    },
                    {
                        "Timestamp": "1668135270",
                        "Value": 190502.8
                    },
                    {
                        "Timestamp": "1668135300",
                        "Value": 191046.43333333332
                    },
                    {
                        "Timestamp": "1668135330",
                        "Value": 190787.73333333334
                    },
                    {
                        "Timestamp": "1668135360",
                        "Value": 191358.9
                    },
                    {
                        "Timestamp": "1668135390",
                        "Value": 191692.96666666667
                    },
                    {
                        "Timestamp": "1668135420",
                        "Value": 191917.03333333333
                    },
                    {
                        "Timestamp": "1668135450",
                        "Value": 191739.16666666666
                    },
                    {
                        "Timestamp": "1668135480",
                        "Value": 191995.73333333334
                    },
                    {
                        "Timestamp": "1668135510",
                        "Value": 192374.5
                    },
                    {
                        "Timestamp": "1668135540",
                        "Value": 192149
                    },
                    {
                        "Timestamp": "1668135570",
                        "Value": 192211.73333333334
                    },
                    {
                        "Timestamp": "1668135600",
                        "Value": 193150.93333333332
                    },
                    {
                        "Timestamp": "1668135630",
                        "Value": 194578.9
                    },
                    {
                        "Timestamp": "1668135660",
                        "Value": 195246.33333333334
                    },
                    {
                        "Timestamp": "1668135690",
                        "Value": 195474.8
                    },
                    {
                        "Timestamp": "1668135720",
                        "Value": 194953.9
                    }
                ],
                "QueryId": "5387660146-1657110201438",
                "Tagkvs": [],
                "Title": "a : RTA_Product.call_user_interested",
                "Unit": ""
            }
        ]
    }
}