跳至主内容

获取报告列表

该方法根据接收的参数返回预定报告的列表。

结果中仅显示由 GravityZone 生成请求所用API密钥的用户创建的报告。

服务

调用此方法需在API URL中填入 {服务} 名称。允许的服务包括:

  • computers(计算机) 对应"计算机与虚拟机"

  • virtualmachines(虚拟机) 对应"虚拟机"

例如,调用 虚拟机 服务的请求URL为:

https://您的域名/api/v1.0/jsonrpc/reports/virtualmachines

参数

参数名

类型

可选性

说明

name

字符串

报告名称

type

数值

报告类型。可选类型包括:

  • 1 - 反钓鱼活动

  • 2 - 被拦截应用程序

  • 3 - 被拦截网站

  • 4 - 客户状态概览

  • 5 - 数据保护

  • 6 - 设备控制活动

  • 7 - 终端模块状态

  • 8 - 终端防护状态

  • 9 - 防火墙活动

  • 10 - 许可证状态

  • 12 - 恶意软件状态

  • 14 - 网络状态

  • 15 - 按需扫描

  • 16 - 策略合规性

  • 17 - 安全审计

  • 18 - 安全服务器状态

  • 19 - 检测到的十大恶意软件

  • 20 - 感染最严重的十大公司

  • 21 - 感染最严重的十大终端

  • 22 - 更新状态

  • 25 - 虚拟机网络状态

  • 30 - 终端加密状态

  • 31 - HyperDetect活动

  • 32 - 网络补丁状态

  • 33 - 沙箱分析器提交失败记录

  • 34 - 网络事件

  • 36 - 完整性监控活动

  • 37 - 完整性监控配置变更

页码

数字

结果页编号。默认页码为 1 .

每页条数

数字

单页显示的项目数量。上限为每页100项。默认值:每页30项。

返回值

此方法返回包含报告信息的对象。返回对象包含:

  • 当前页 - 当前显示的页码

  • 总页数 - 可用页面总数

  • 每页条数 - 每页返回的项目总数

  • 项目列表 - 报告列表。列表中每个条目包含以下字段:

    • ID ,报告的唯一标识符

    • 名称 ,报告的名称

    • 类型 ,报告类型,详见参数表

    • 执行周期 ,报告运行的时间间隔。可选值包括:2-每小时,3-每日,4-每周或5-每月。请注意值1(即时报告)不属于有效选项。

  • 总数 - 条目总数

示例

请求 :

{
       "params": {
           "type": 2,
           "page": 2,
           "perPage": 4
       },
       "jsonrpc": "2.0",
       "method": "getReportsList",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

响应 :

{
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": {
           "page": 2,
           "pagesCount": 11,
           "perPage": 5,
           "total": 54
           "items": [
               {
                   'id': '5638cdceb1a43d46137b23c6',
                   'name': '我的报告1',
                   'occurrence': 2,
                   'type': 2
               },
               {
                   'id': '5638d7f8b1a43d49137b23c9',
                   'name': '我的报告2',
                   'occurrence': 4,
                   'type': 2
               },
               {
                   'id': u'563b271bb1a43d21077b23c8',
                   'name': '我的报告3',
                   'occurrence': 4,
                   'type': 2
               },
               {
                   'id': '563a289eb1a43d2f617b23c6',
                   'name': '我的报告4',
                   'occurrence': 2,
                   'type': 2
               }
           ]
      }
  }