更新时间:2023.04.11 16:29:03
调用ViewDetail接口获取指定view下的性能和资源加载情况。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
time_filter | object of time_filter | 是 | - | 时间区间。 |
event_id | string | 是 |
| 上报数据的唯一标识,从DataList.MetricMap中获取。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境,填""时为全部。 |
os | string | 否 |
| 服务类型,可选值为webpro,app,minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间,单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度,单位s。 |
end_time | i32 | 是 |
| 终止时间,单位s。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
data | object of data | - | 指定view下性能情况及资源加载情况。 |
error_msg | string | - | 错误信息,成功为空。 |
error_no | i32 |
| 错误码,成功为0。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
rum_metric | object of rum_metric | - | 性能相关指标值。 |
navigation | object of navigation | - | 性能耗时甘特图。 |
resources_waterfall | object of resources_waterfall | - | 资源加载情况。 |
POST https://open.volcengineapi.com/?Action=ViewDetail&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 }, "event_id": "http:[web_monitor]{webpro#session#649b8a7b-5db4-4989-b9a5-994e53da82ee#12345}:1663186696013#fc102ce5612345edb2bd00163e352627" }
{ "error_no": 0, "error_msg": "", "data": { "navigation": { "fields": [ { "dataType": "string", "id": "date", "aggregate": "", "name": "日期" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] }, "resources_waterfall": { "data": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "name": "日期", "id": "date", "aggregate": "", "dataType": "string" } ] } } } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "ViewDetail", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }