流量数据报表
February 26, 2024About 5 min
流量数据报表
示例接口
示例接口描述
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| foo | String | | 请求属性示例 | @ctitle | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| string | String | | 字符串属性示例 | ★ | 1-10 |
| number | Number | | 数字属性示例 | 1 | 1-100 |
| boolean | Boolean | | 布尔属性示例 | true | 1-2 |
| regexp | RegExp | | 正则属性示例 | /[a-z][A-Z][0-9]/ | |
| function | Function | | 函数属性示例 | () => Math.random() | |
| array | Array | | 数组属性示例 | | 1-10 |
| foo | Number | | 数组元素示例 | 1 | +1 |
| bar | String | | 数组元素示例 | ★ | 1-10 |
| items | Array | | 自定义数组元素示例 | [1, true, 'hello', /\w{10}/] | |
| object | Object | | 对象属性示例 | | |
| foo | Number | | 对象属性示例 | 1 | +1 |
| bar | String | | 对象属性示例 | ★ | 1-10 |
| placeholder | String | | 占位符示例 | @title | |
报表规则 - 新建
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| rule_name | String | | 规则名 | | |
| rule_uuids | String | | 涉及规则uuid列表 | | |
| policy_type | Number | | 策略类型，0：一次性，1：周期性 | 0 | |
| stat_start | Number | | 一次性时间窗口开始时间 | 1765432870 | |
| stat_end | Number | | 一次性时间窗口结束时间 | 1765932820 | |
| mail_switch | Number | | 邮件开关，0：关，1：开 | | |
| mail_address | Array | | | | |
| email | String | | 邮箱 | | |
| name | String | | 收件人 | | |
| policies | Array | | 周期性时间策略 | | 2 |
| month | String | | 月 | 7 | |
| day | String | | 日 | 12 | |
| time | String | | 天 | 12:00 | |
| range | Number | | 时间区间：0：日，1：周，2：月，3：年 | | |
Response
报表规则 - 修改
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| rule_uuid | String | | 规则uuid | @guid | |
| rule_name | String | | 规则名 | | |
| rule_uuids | String | | 涉及规则uuid列表 | | |
| policy_type | String | | 策略类型，一次性one_time，周期性：periodic | | |
| stat_start | String | | 一次性时间窗口开始时间 | 1765432870 | |
| stat_end | String | | 一次性时间窗口结束时间 | 1765932820 | |
| mail_switch | Number | | 邮件开关，0：关，1：开 | | |
| mail_address | Array | | | | |
| address | String | | 邮箱 | | |
| name | String | | 收件人 | | |
| policies | Object | | 周期性时间策略 | | |
| time | String | | 时间点 | 14:30 | |
| day | Number | | 日，表示每月的固定天 | 31 | |
| month | Number | | 月，表示每年的固定月 | 12 | |
| range | Number | | 时间区间：最近一日：0，最近一周：1，最近一月：2，最近一年：3 | 0 | |
Response
报表规则 - 列表
SDK方法名：listReportRule
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| limit | Number | | | | |
| page | Number | | | | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | Number | | | | |
| msg | String | | | | |
| data | Object | | | | |
| info_list | Array | | | | |
| rule_name | String | | | | |
| username | String | | | | |
| policy_type | String | | | | |
| status | String | | 状态：EXPORT：导出中、成功：SUCCESS、失败：FAILED;
等待：WAIT | EXPORT | |
| next_time | Number | | 下次执行时间 | 1988720321 | |
| rule_uuid | String | | | D42BF707-C971-EEA9-521F-BB0F3F7A92FC | |
报表规则 - 操作
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| rule_uuids | String | | 规则uuid（一次性规则操作） | | |
| task_uuids | Array | | 报表uuid（进入查看报表页面操作） | | |
| operate | String | | 下载：download；
邮件推送：mail_send；
重新导出：redo_export；
立即导出：do_export； | | |
| suffix | String | | 导出文件后缀csv，xlsx(暂不支持) | | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | String | | | | |
| msg | String | | | | |
| data | Object | | | | |
| code | String | | | | |
| message | String | | | | |
报表规则 - 删除
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| rule_uuids | String | | | | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | String | | | | |
| msg | String | | | | |
| data | Object | | | | |
| code | String | | | | |
| message | String | | | | |
| sucess_list | Array | | | | |
| code | String | | | | |
| message | String | | | | |
| fail_list | Array | | | | |
| all_list | Array | | | | |
报表规则 - 查看报表
SDK方法名：listReportRuleStatistics
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| limit | String | | | | |
| page | String | | | | |
| search_field | String | | 模糊查询字段 | rule_name | |
| where_args[rule_uuid] | String | | 查询报表规则uuid（从一次性报表规则跳转） | @guid | |
| where_args[task_uuid] | String | | 查询导出历史uuid（从定时报表规则导出历史跳转） | @guid | |
| search_value | String | | 模糊查询字段值 | test | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | Number | | | | |
| msg | String | | | | |
| data | Object | | | | |
| info_list | Array | | | | |
| rule_name | String | | 对应同步规则名 | | |
| rule_uuid | String | | 对应同步规则uuid | D42BF707-C971-EEA9-521F-BB0F3F7A92FC | |
| next_time | Number | | 下次执行时间 | 1988720321 | |
| start_time | Number | | | | |
| end_time | Number | | | | |
| traffic_sum | Number | | 流量 | | |
| uuid | String | | 报表uuid | | |
| task_uuid | String | | 对应周期性执行的导出历史uuid | | |
| start_time | String | | | | |
| duration | String | | | | |
| rule_sum | Number | | | | |
| traffic_total | Number | | | | |
报表规则 - 导出历史
SDK方法名：listReportRuleHistory
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| limit | String | | | | |
| page | String | | | | |
| where_args[rule_uuid] | String | | 查询报表规则uuid | @guid | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | Number | | | | |
| msg | String | | | | |
| data | Object | | | | |
| info_list | Array | | | | |
| start_time | Number | | 开始时间 | | |
| traffic_sum | Number | | 数据总量 | | |
| rule_sum | Number | | 规则总数 | | |
| duration | Number | | 用时（秒） | | |
| task_uuid | String | | 报表uuid（跳转查看时的入参） | | |
报表规则 - 删除导出历史记录
SDK方法名：
URL
Method
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| task_uuids | Array | | 历史记录uuid | | |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
| ret | String | | | | |
| msg | String | | | | |
| data | Object | | | | |
| code | String | | | | |
| message | String | | | | |
| sucess_list | Array | | | | |
| code | String | | | | |
| message | String | | | | |
| fail_list | Array | | | | |
| all_list | Array | | | | |
