获取静态资源慢加载top10列表。
请求说明
- 请求方式:POST
- 请求地址:https://open.volcengineapi.com/?Action=ResourceSlowList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | ResourceSlowList | 接口名称。当前 API 的名称为 ResourceSlowList 。 |
Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12 。 |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
common | Object of CommonParams | 是 | - | 通用参数。 |
time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
filter_conditions | Object of FilterCondition | 否 | - | 筛选条件。 |
slow_duration | Long | 是 | 3000 | 慢加载阈值。 |
order_by | String | 否 | count | 排序依据。支持按照slow_rate、slow_value、count、avg、pct25、pct50、pct70、pct90和pct99排序。 |
pick_type | String | 是 | avg | 加载总耗时聚合方式。支持按照avg、pct25、pct50、pct70、pct90和pct99聚合。 |
CommonParams
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
aid | Long | 是 | 12345 | 应用ID。 |
site_type | String | 是 | web | 站点类型。 |
env | String | 是 | online | 环境,填""时为全部。 |
os | String | 否 | webpro | 服务类型,可选值为webpro,app,minipro。 |
user | String | 否 | test_user | 用户名。 |
TimeFilter
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
start_time | Integer | 是 | 1665485413 | 起始时间,单位s。 |
end_time | Integer | 是 | 1665744613 | 终止时间,单位s。 |
granularity | Integer | 否 | 3600 | 聚合时间粒度,单位s。 |
FilterCondition
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
type | String | 是 | and | 筛选条件类型,可选值为and和rule,只支持两层,第一层的type必须为and,第二层的type必须为rule。 |
field | String | 否 | pid | 条件字段key,可选值集合由GetFieldKeys 方法获取。 |
op | String | 否 | in | 条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。 |
groupKey | String | 否 | context | map类型字段key,可选值集合由GetFieldKeys 方法获取。 |
values | Array of String | 否 | [数据探索] | 条件值,可选值集合由GetFieldValues 方法获取。 |
children | Array of FilterCondition | 否 | - | 如果下层还有条件,则放入该处,即type为and时必填。这一层与field,op,groupkey以及values不能同时存在。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
---|
data | Array of ResourceSlowListItem | - | Top10慢请求。 |
error_no | Integer | 0 | 错误码,成功为0。 |
error_msg | String | - | 错误信息,成功为空。 |
ResourceSlowListItem
参数 | 类型 | 示例值 | 描述 |
---|
name | String | data:image/svg+xml | 静态资源地址。 |
type | String | resource | 静态资源类型。 |
duration | Long | - | 请求耗时,单位ms。 |
slow_rate | String | - | 慢请求率。 |
user_rate | String | - | 慢请求影响用户率。 |
rate_trend | Object of ChartData | - | 请求耗时趋势。 |
user_trend | Object of ChartData | - | 慢请求影响用户率趋势。 |
duration_trend | Object of ChartData | - | 慢请求率趋势。 |
ChartData
参数 | 类型 | 示例值 | 描述 |
---|
fields | Array of Field | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
Field
参数 | 类型 | 示例值 | 描述 |
---|
id | String | date | 维度key。 |
name | String | 日期 | 维度名。 |
dataType | String | string | 维度类型。 |
aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com/?Action=ResourceSlowList&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
},
"slow_duration": 3000,
"pick_type": "avg,pct25,pct50,pct70,pct90,pct99",
"filter_conditions": {
"type": "and",
"field": "pid",
"values": "[数据探索]",
"op": "in",
"groupKey": "context",
"children": [
{
"type": "and",
"field": "pid",
"values": "[数据探索]",
"children": [],
"op": "in",
"groupKey": "context"
}
]
},
"order_by": "count,slow_rate,slow_value,avg,pct25,pct50,pct70,pct90,pct99"
}
返回示例
{
"error_no": 0,
"data": [
{
"user_trend": {
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
],
"fields": [
{
"dataType": "string",
"name": "日期",
"id": "date",
"aggregate": ""
}
]
},
"type": "resource",
"slow_rate": "at",
"duration": 723,
"rate_trend": {
"fields": [
{
"name": "日期",
"dataType": "string",
"id": "date",
"aggregate": ""
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
},
"user_rate": "",
"name": "data:image/svg+xml",
"duration_trend": {
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
],
"fields": [
{
"name": "日期",
"dataType": "string",
"aggregate": "",
"id": "date"
}
]
}
}
],
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。