GetAppHttpTrend--应用性能监控全链路版-火山引擎

文档中心

导航

GetAppHttpTrend

最近更新时间：2024.07.15 16:31:29首次发布时间：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

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

Body

参数	类型	是否必选	示例值	描述
start_time	Integer	否	`1617225600`	查询起始时间（Unix时间戳）。
end_time	Integer	否	`1617312000`	查询结束时间（Unix时间戳）。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
last_group_filters	Array of Condition	否	`-`	之前的分组被选中的条件。
group_field	String	否	`os_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
granularity	Integer	否	`5`	聚合粒度，单位是分钟。
top_n	Integer	否	`10`	分组topN的数量，没有分组时传0。

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	JSON Map	`-`	分组的时候map key是指标名称，base.TrendLine.name是分组的字段值，没有分组的时候是空字符串。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。

Data

参数	类型	示例值	描述
key	String	`1`	指标名称。
value	Array of TrendLine	`-`	趋势值。

TrendLine

参数	类型	示例值	描述
name	String	`test123`	线的名称，在分组的情况下，name应该是分组维度的取值，比如用来显示曲线的图标。
points	Array of TrendPoint	`-`	曲线上的点。
total	Double		总数

TrendPoint

参数	类型	示例值	描述
alert	Object of AlertPoint	`-`	提示信息。
value	Double	`123`	指标值。
timestamp	Long	`1665417600`	指标发生时间（Unix时间戳）。
readable_timestamp	String	`2022-10-11`	指标发生时间（自然时间）。

AlertPoint

参数	类型	示例值	描述
msg	String	`No error`	提示信息。
alert	Boolean	`true`	是否需要提示。

请求示例

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
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

Data

TrendLine

TrendPoint

AlertPoint

请求示例

返回示例

错误码