接口功能介绍
查看报表列表
接口约束
传参规范
URI
GET /vfw/v2_report_list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| firewallId | 是 | String | 防火墙id | dca4f9ffaca2447aa24310c1e62c4690 | |
| startTime | 是 | String | 开始时间 | 2024-09-25T05:36:13Z | |
| endTime | 是 | String | 结束时间 | 2024-09-25T05:36:13Z | |
| reportType | 是 | String | 报表类型 | DAY | |
| selectedTime | 否 | String | 选择时间 | 2024-09-25T05:36:13Z | |
| page | 否 | Integer | 页码 | 1 | |
| size | 否 | Integer | 条数 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | 1 | |
| list | Array of Objects | 结果集 | ReportDetail | |
| pageNum | Integer | 当前页的页码 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| size | Integer | 当前页的数量 | 1 | |
| startRow | Long | 当前页面第一个元素在数据库中的行号 | 1 | |
| endRow | Long | 当前页面最后一个元素在数据库中的行号 | 1 | |
| pages | Integer | 总页数 | 1 | |
| prePage | Integer | 前一页 | 0 | |
| nextPage | Integer | 下一页 | 0 | |
| isFirstPage | Boolean | 是否为首页 | true | |
| isLastPage | Boolean | 是否为末页 | true | |
| hasPreviousPage | Boolean | 是否有前一页 | false | |
| hasNextPage | Boolean | 是否有下一页 | false | |
| navigatePages | Integer | 导航页码数 | 8 | |
| navigatepageNums | Array of Integers | 所有导航页号 | [1] | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | String | 导航条上的最后一页 | 1 |
表 ReportDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| reportId | String | 报表id | f9d5b6bd-408f-48c2-a3d9-86c6f0fa1d0b | |
| reportName | String | 报表名称 | 10月24号日报(2024) | |
| reportType | String | 报表类型 | DAY | |
| reportStartTime | String | 报表开始时间 | 2024-10-23T16:00:00Z | |
| reportEndTime | String | 报表结束时间 | 2024-10-24T15:59:59Z | |
| createdTime | String | 报表创建时间 | 2024-10-24T16:00:24Z |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 20,
"list": [
{
"reportId": "f9d5b6bd-408f-48c2-a3d9-86c6f0fa1d0b",
"reportName": "10月24号日报(2024)",
"reportType": "DAY",
"reportStartTime": "2024-10-23T16:00:00Z",
"reportEndTime": "2024-10-24T15:59:59Z",
"createdTime": "2024-10-24T16:00:24Z"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 10,
"startRow": 1,
"endRow": 10,
"pages": 2,
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [
1,
2
],
"navigateFirstPage": 1,
"navigateLastPage": 2
}
}
状态码
请参考 状态码
错误码
请参考 错误码
