跳至主内容

getScanTasksList

该方法返回扫描任务列表。

参数

参数

类型

可选

描述

name

字符串

是

任务名称。按任务名称筛选任务列表。在关键词前使用星号(*)可搜索名称中任意位置出现该关键词的结果。若省略，则仅返回名称以关键词开头的任务。

status

数字

是

任务状态。可选值为：1 - 待处理；2 - 进行中；3 - 已完成。

页码

数字

是

结果页码。默认页码为1。

每页条数

数字

是

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

返回值

此方法返回一个包含任务信息的对象。返回对象包含：

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

  • 总页数 - 可用页面的总数

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

  • 总数 - 项目总数

  • 项目列表 - 任务列表。列表中的每个条目包含以下字段：

    • 任务ID , 任务的唯一标识符,

    • 任务名称 , 任务的名称,

    • 任务状态 , 任务的状态（如上所述）,

    • 开始日期 ，任务的开始日期

示例

请求 : 

{
       "params": {
           "status": 1,
           "page": 2,
           "perPage": 5
       },
       "jsonrpc": "2.0",
       "method": "getScanTasksList",
       "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": "21a295eeb1a43d8b497b23b7",
                "name": "任务1",
                "status": 1,
                "startDate": "2015-08-21T23:48:16"
            },
            {
                "id": "21a295eeb1a43d8b497b23b8",
                "name": "任务2",
                "status": 1,
                "startDate": "2015-08-21T10:21:15"
            },
        ]
    }
}
本节内容 :