You need to enable JavaScript to run this app.
导航
PerfMetricsList
最近更新时间:2024.07.12 17:21:38首次发布时间:2022.11.18 15:32:34

获取性能指标变化趋势。

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionStringPerfMetricsList接口名称。当前 API 的名称为 PerfMetricsList
VersionString2022-10-12接口版本。当前 API 的版本为 2022-10-12

Body

参数类型是否必选示例值描述
commonObject of CommonParams-通用参数。
time_filterObject of TimeFilter-时间区间。
filter_conditionsObject of FilterCondition-筛选条件。

CommonParams

参数类型是否必选示例值描述
aidLong12345应用ID。
site_typeStringweb站点类型。
envStringonline环境,填""时为全部。
osStringwebpro服务类型,可选值为webproappminipro
userStringtest_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger1665485413起始时间,单位s。
end_timeInteger1665744613终止时间,单位s。
granularityInteger3600聚合时间粒度,单位s。

FilterCondition

参数类型是否必选示例值描述
typeStringand筛选条件类型,可选值为andrule,只支持两层,第一层的type必须为and,第二层的type必须为rule。
fieldStringpid条件字段key,可选值集合由GetFieldKeys方法获取。
opStringin条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。
groupKeyStringcontextmap类型字段key,可选值集合由GetFieldKeys方法获取。
valuesArray of String[数据探索]条件值,可选值集合由GetFieldValues方法获取。
childrenArray of FilterCondition-如果下层还有条件,则放入该处,即type为and时必填。这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数类型示例值描述
dataArray of PerfListChartDataWithExtra-性能达标率变化趋势及未达标pid个数。
error_msgString-错误信息,成功为空。
error_noInteger0错误码,成功为0。

PerfListChartDataWithExtra

参数类型示例值描述
dataObject of ChartData-性能达标率变化趋势。
extraObject of PerfListExtraData-未达标pid个数。

ChartData

参数类型示例值描述
fieldsArray of Field-折线图/饼图维度,len(fields)=len(source[i])。
sourceArray of String[["1668355200","js_error","0","0"]]趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

PerfListExtraData

参数类型示例值描述
typeStringrate指标类型,数值指标还是率值指标。
metricStringFP 达标率指标达标率名。
unreached_countLong1未达标pid个数。

Field

参数类型示例值描述
idStringdate维度key。
nameString日期维度名。
dataTypeStringstring维度类型。
aggregateString-聚合方式。

请求示例

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

返回示例

{
    "error_no": 0,
    "data": [
        {
            "data": {
                "source": [
                    [
                        "1668355200",
                        "js_error",
                        "0",
                        "0"
                    ]
                ],
                "fields": [
                    {
                        "id": "date",
                        "aggregate": "",
                        "name": "日期",
                        "dataType": "string"
                    }
                ]
            },
            "extra": {
                "type": "rate",
                "metric": "FP 达标率",
                "unreached_count": 1
            }
        }
    ],
    "error_msg": ""
}

错误码

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