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

ReqOverviewTrend

最近更新时间2023.04.11 16:29:04

首次发布时间2022.11.18 15:32:34

调用ReqOverviewTrend接口获取请求总览趋势。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

ReqOverviewTrend

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

filter_conditions

object of filter_conditions

-

筛选条件。

slow_duration

i64

3000

慢请求阈值。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

filter_conditions

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of children

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

children

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。

field

string

pid

条件字段key,可选值集合由GetFieldKeys方法获取。

op

string

in

条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。

groupKey

string

context

map类型字段key,可选值集合由GetFieldKeys方法获取。

values

array of string

[数据探索]

条件值,可选值集合由GetFieldValues方法获取。

children

array of string

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数

类型

示例值

描述

data

object of data

-

总览趋势。

error_no

i32

0

错误码,成功为0。

error_msg

string

-

错误信息,成功为空。

data

参数

类型

示例值

描述

chart

object of chart

-

自定义事件上报趋势。

info

array of info

-

自定义事件总览值。

extra

object of extra

-

自定义事件额外信息。

chart

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

info

参数

类型

示例值

描述

id

string

count

汇总值key。

name

string

白屏数

汇总值名。

count

string

1

汇总值。

unit

string

ms

汇总值单位。

change

string

1.0

环比。

extra

参数

类型

示例值

描述

release_info

array of release_info

-

版本发布情况。

fields

参数

类型

示例值

描述

id

string

date

维度key。

dataType

string

string

维度类型。

name

string

日期

维度名。

aggregate

string

-

聚合方式。

release_info

参数

类型

示例值

描述

create_at

i32

1668483578

版本发布时间。

release

string

v2.2.123

版本。

env

string

test

版本发布环境。

commit

string

[]

版本相关commit。

示例

请求示例

POST https://open.volcengineapi.com/?Action=ReqOverviewTrend&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "slow_duration": 3000,
    "filter_conditions": {
        "type": "and",
        "op": "in",
        "values": "[数据探索]",
        "groupKey": "context",
        "field": "pid",
        "children": [
            {
                "type": "and",
                "field": "pid",
                "children": [],
                "values": "[数据探索]",
                "op": "in",
                "groupKey": "context"
            }
        ]
    }
}

正常返回示例

{
    "error_msg": "",
    "data": {
        "chart": {
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ],
            "fields": [
                {
                    "aggregate": "increased",
                    "dataType": "string",
                    "name": "日期",
                    "id": "date"
                }
            ]
        },
        "extra": {
            "release_info": [
                {
                    "commit": "",
                    "release": "v2.2.123",
                    "create_at": 1668483578,
                    "env": "test"
                }
            ]
        },
        "info": [
            {
                "change": "1",
                "count": "1",
                "unit": "ms",
                "id": "count",
                "name": "白屏数"
            }
        ]
    },
    "error_no": 0
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "ReqOverviewTrend",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}