获取性能监控指标基准线。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=GetDatumLinekeys&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetDatumLinekeys | 接口名称。当前 API 的名称为 GetDatumLinekeys。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Array of DatumLine | - | 指标基准线。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
DatumLine
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | browser_perf.cls.avg | 指标key。 |
| name | String | 累计布局偏移(CLS) | 指标名。 |
| unit | String | ms | 指标值单位。 |
| up_base_line | Double | 2000 | 指标基准线上限。 |
| down_base_line | Double | 1000 | 指标基准线下限。 |
| 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
}
错误码
本接口无特有的错误码。更多信息请参见错误码。