文档首页/ 应用性能管理 APM/ API参考（2.0）/ API/ VIEW/ 获取趋势图
更新时间：2023-08-02 GMT+08:00
查看PDF
分享

获取趋势图

功能介绍

获取趋势图。

URI

POST /v1/apm2/openapi/view/metric/trend

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-business-id

是

Long

应用id。

X-Auth-Token

是

String

从IAM服务获取的用户Token。
表2 请求Body参数

参数

是否必选

参数类型

描述

view_config

是

TrendView object

视图配置信息。

instance_id

否

Long

实例id。

monitor_item_id

否

Long

监控项id。

env_id

是

Long

环境id。

start_time

是

String

开始时间。

end_time

是

String

结束时间。
表3 TrendView

参数

是否必选

参数类型

描述

view_type

是

String

视图类型。

枚举值：

  • trend
  • sumtable
  • rawtable

collector_name

是

String

采集器名称。

metric_set

是

String

视图对应的指标集名称。

title

否

String

图标所需展示的标题。

table_direction

否

String

表格的方向，H：默认，表头横向，V：表头纵向。

枚举值：

  • H
  • V

group_by

否

String

分组。

filter

否

String

过滤列表模型。

field_item_list

是

Array of FieldItem objects

所需展示的字段列表模型列表。

span

否

Boolean

跨度。

span_field

否

String

span字段属性。

order_by

否

String

排序。

latest

否

String

是否只展示最近一笔数据。
表4 FieldItem

参数

是否必选

参数类型

描述

function

是

String

表达式。

as

否

String

作为。

default_value

否

String

默认值。

trace

否

Boolean

是否是trace。

precision

否

Integer

百分比。

unit

否

String

单位。

visible

否

Boolean

是否可见。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

line_list

Array of FrontLine objects

趋势图数据列表。

latest_data_Time

Long

最后日期时间。
表6 FrontLine

参数

参数类型

描述

point_list

Array of FrontPoint objects

数据点集合。

title

String

标题。

unit

String

单位。

precision

Integer

百分比。

data_type

String

日期类型。

visible

Boolean

是否可见。
表7 FrontPoint

参数

参数类型

描述

time

Long

时间。

value

Object

值。

请求示例

获取趋势图，入参为view_type参数为trend的视图配置，可从查询监控项配置信息接口获取。

/v1/apm2/openapi/view/metric/trend

{
  "end_time" : "2022-10-25 15:40:00",
  "env_id" : "11",
  "monitor_item_id" : 78,
  "start_time" : "2022-10-25 15:20:00",
  "view_config" : {
    "latest" : null,
    "span" : true,
    "collector_name" : "Url",
    "metric_set" : "url",
    "title" : "调用次数",
    "table_direction" : null,
    "group_by" : "",
    "filter" : "url=/apm2/health/v1/health-check^method=GET",
    "field_item_list" : [ {
      "trace" : null,
      "function" : "SUM(invokeCount)",
      "as" : "调用次数",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    } ],
    "span_field" : "source",
    "view_type" : "trend"
  }
}

响应示例

状态码： 200

OK，请求响应成功。

{
  "line_list" : [ {
    "point_list" : [ {
      "time" : 1666682400000,
      "value" : 8
    }, {
      "time" : 1666682460000,
      "value" : 8
    }, {
      "time" : 1666682520000,
      "value" : 8
    }, {
      "time" : 1666682580000,
      "value" : 8
    }, {
      "time" : 1666682640000,
      "value" : 8
    }, {
      "time" : 1666682700000,
      "value" : 8
    }, {
      "time" : 1666682760000,
      "value" : 8
    }, {
      "time" : 1666682820000,
      "value" : 8
    }, {
      "time" : 1666682880000,
      "value" : 8
    }, {
      "time" : 1666682940000,
      "value" : 8
    }, {
      "time" : 1666683000000,
      "value" : 8
    }, {
      "time" : 1666683060000,
      "value" : 8
    }, {
      "time" : 1666683120000,
      "value" : 8
    }, {
      "time" : 1666683180000,
      "value" : 8
    }, {
      "time" : 1666683240000,
      "value" : 8
    }, {
      "time" : 1666683300000,
      "value" : 8
    }, {
      "time" : 1666683360000,
      "value" : 8
    }, {
      "time" : 1666683420000,
      "value" : null
    }, {
      "time" : 1666683480000,
      "value" : null
    }, {
      "time" : 1666683540000,
      "value" : null
    } ],
    "title" : "调用次数",
    "unit" : null,
    "precision" : null,
    "data_type" : "INT",
    "visible" : true
  } ],
  "latest_data_Time" : 1666683360000
}

状态码

状态码

描述

200

OK，请求响应成功。

401

Unauthorized，没有权限

403

Forbidden，禁止访问。

404

Not Found，没有找到要请求的资源。

错误码

请参见错误码。

父主题： VIEW