获取请求列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=ReqList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | ReqList | 接口名称。当前 API 的名称为 ReqList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| slow_duration | Long | 是 | 3000 | 慢请求阈值，单位为ms。 |
| pgno | Long | 是 | 1 | 页号。 |
| pgsz | Long | 是 | 10 | 每页项数。 |
| filter_conditions | Object of FilterCondition | 否 | - | 筛选条件。 |
| order_by | String | 否 | slow_value | 排序方式。支持按照slow_rate、slow_value、count、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不能同时存在。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
| data | Object of ReqListData | - | 请求列表。 |
ReqListData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Array of ReqListItem | - | 请求列表。 |
| total | Long | - | 请求聚类总数。 |
ReqListItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| path | String | - | 请求路径。 |
| value | String | 2000 | 请求耗时。 |
| domain | String | www.test.com | 请求域名。 |
| method | String | POST | 请求方法。 |
| indicators | Array of ReqListItemIndicator | - | 请求指标总览值。 |
ReqListItemIndicator
| 参数 | 类型 | 示例值 | 描述 |
|---|
| label | String | 慢请求数 | 请求指标名。 |
| value | Long | 1000 | 请求指标名。 |
请求示例
POST https://open.volcengineapi.com/?Action=ReqList&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"os": "webpro",
"user": "test_user"
},
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"slow_duration": 3000,
"pgno": 1,
"pgsz": 10,
"filter_conditions": {
"type": "and",
"op": "in",
"values": "[数据探索]",
"field": "pid",
"groupKey": "context",
"children": [
{
"type": "and",
"groupKey": "context",
"children": [],
"op": "in",
"field": "pid",
"values": "[数据探索]"
}
]
},
"order_by": "slow_value, slow_rate, count, avg, pct25,pct50,pct70,pct90,pct99"
}
返回示例
{
"data": {
"data": [
{
"value": "2000",
"domain": "www.test.com",
"indicators": [
{
"value": 1000,
"label": "慢请求数"
}
],
"method": "POST",
"path": "",
"from_cache": false
}
],
"total": 606
},
"error_msg": "",
"error_no": 0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。