You need to enable JavaScript to run this app.
导航
GetDatumLinekeys
最近更新时间:2023.12.26 18:54:57首次发布时间:2022.11.18 15:32:34

调用GetDatumLinekeys接口获取性能监控指标基准线。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

GetDatumLinekeys

请求名称。

Version

String

2022-10-12

请求版本。

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

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

返回参数

参数

类型

示例值

描述

data

array of data

-

指标基准线。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

name

string

累计布局偏移(CLS)

指标名。

key

string

browser_perf.cls.avg

指标key。

unit

string

ms

指标值单位。

down_base_line

double

1000

指标基准线下限。

up_base_line

double

2000

指标基准线上限。

is_little_better

boolean

true

指标值是否越小越好。

请求示例

POST https://open.volcengineapi.com/?Action=GetDatumLinekeys&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    }
}

返回示例

正常返回示例

{
    "error_msg": "",
    "data": [
        {
            "down_base_line": 1000,
            "is_little_better": true,
            "name": "累计布局偏移(CLS)",
            "ev_type": "",
            "unit": "ms",
            "num_type": "",
            "up_base_line": 2000,
            "key": "browser_perf.cls.avg"
        }
    ],
    "error_no": 0
}

异常返回示例

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