You need to enable JavaScript to run this app.
导航
GetAppHttpTrend
最近更新时间:2024.06.18 17:22:41首次发布时间:2024.04.25 17:57:49

获取网络Http监控的各项指标趋势。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=GetAppHttpTrend&Version=2024-04-09
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetAppHttpTrend接口名称。当前 API 的名称为 GetAppHttpTrend
VersionString2024-04-09接口版本。当前 API 的版本为 2024-04-09

Body

参数类型是否必选示例值描述
start_timeInteger1617225600查询起始时间(Unix时间戳)。
end_timeInteger1617312000查询结束时间(Unix时间戳)。
filtersObject of Condition-筛选条件,可以指定多个键值对来筛选数据。
last_group_filtersArray of Condition-之前的分组被选中的条件。
group_fieldStringos_version要对结果进行分组的字段名称,没有分组时传空字符串。

metrics

Array of String

all_report_cnt_v2

需要查询的指标名称。

  • all_report_cnt_v2:上报数
  • req_cnt_v2:请求数
  • req_cnt_rate_v2:请求率
  • req_success_cnt_v2:请求成功数
  • req_success_rate_v2:请求成功率
  • reused_cnt_v2:链接复用数
  • reused_rate_v2:链接复用率
  • reused_success_rate_v2:链接复用成功率
  • req_err_cnt_v2:请求错误数
  • req_all_err_cnt_v2:所有请求错误数
  • req_err_rate_v2:请求错误率
  • req_total_cost_v2:所有请求数
  • req_user_cnt_v2:请求用户数
  • req_success_user_cnt_v2:请求成功用户数
  • req_success_user_rate_v2:请求成功用户率

domain_tag

String

all

主机标签。

  • all:全部
  • self:自身服务
  • other:第三方

statistic_scale

String

avg

统计口径。

  • avg
  • pct50
  • pct75
  • pct95
  • pct99
granularityInteger5聚合粒度,单位是分钟。
top_nInteger10分组topN的数量,没有分组时传0。

Condition

参数类型是否必选示例值描述

op

String

in

操作符。

  • gt:大于
  • gte:大于等于
  • lt:小于
  • lte:小于等于
  • eq:等于
  • neq:不等于
  • in:包含
  • not_in:不包含
  • lk:like
  • nlk:not like
  • regex:正则匹配
  • not_null:非正则匹配

type

String

expression

筛选条件类型。

  • expression:当前condition是一个表达式
  • and:当前condition是一个复合表达式,多个sub_condition的逻辑关系是and
  • or:当前condition是一个复合表达式,多个sub_condition的逻辑关系是or
  • map:当前condition是map类型
valueString123456筛选值。
valuesArray of String[123456]筛选值,支持多个。
map_keyStringkey_1map类型key,当type为map时必填。
dimensionStringaid条件的名称。
sub_conditionsArray of Condition-子条件。

返回参数

参数类型示例值描述
dataJSON Map-分组的时候map key是指标名称,base.TrendLine.name是分组的字段值,没有分组的时候是空字符串。
error_msgString-错误信息。
error_noInteger0错误码。

Data

参数类型示例值描述
keyString1指标名称。
valueArray of TrendLine-趋势值。

TrendLine

参数类型示例值描述
nameStringtest123线的名称,在分组的情况下,name应该是分组维度的取值,比如用来显示曲线的图标。
pointsArray of TrendPoint-曲线上的点。

TrendPoint

参数类型示例值描述
alertObject of AlertPoint-提示信息。
valueDouble123指标值。
timestampLong1665417600指标发生时间(Unix时间戳)。
readable_timestampString2022-10-11指标发生时间(自然时间)。

AlertPoint

参数类型示例值描述
msgStringNo error提示信息。
alertBooleantrue是否需要提示。

请求示例

POST https://open.volcengineapi.com?Action=GetAppHttpTrend&Version=2024-04-09
{
    "start_time": 1617225600,
    "end_time": 1617312000,
    "filters": {
        "type": "and",
        "sub_conditions": [
            {
                "dimension": "apm_version",
                "type": "expression",
                "op": "in",
                "values": [
                    "1.4.5"
                ]
            },
            {
                "dimension": "device_model",
                "type": "expression",
                "op": "in",
                "values": [
                    "MI 5X"
                ]
            }
        ]
    },
    "last_group_filters": [

    ],
    "group_field": "os_version",
    "metrics": [
        "req_receive_cost_v2_success"
    ],
    "domain_tag": "all",
    "statistic_scale": "avg",
    "granularity": 5,
    "top_n": 10
}

返回示例

{
    "err_detail": "",
    "data": {
        "req_cnt_v2": [
            {
                "name": "",
                "points": [
                    {
                        "timestamp": 1713942000,
                        "readable_timestamp": "2024-04-24 15:00:00",
                        "value": 0
                    },
                    {
                        "timestamp": 1713945600,
                        "readable_timestamp": "2024-04-24 16:00:00",
                        "value": 0
                    },
                    {
                        "timestamp": 1713949200,
                        "readable_timestamp": "2024-04-24 17:00:00",
                        "value": 0
                    },
                    {
                        "timestamp": 1713952800,
                        "readable_timestamp": "2024-04-24 18:00:00",
                        "value": 0
                    },
                    {
                        "timestamp": 1713956400,
                        "readable_timestamp": "2024-04-24 19:00:00",
                        "value": 0
                    }
                ],
                "total": 0
            }
        ]
    },
    "error_msg": "",
    "error_no": 0
}

错误码

本接口无特有的错误码。更多信息请参见错误码