API文档目录

大数据任务通用服务

大数据任务暂停

  • 接口说明

大数据通用任务暂停

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/taskPause

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array false
  taskInfo[0] Object false
   taskId String false 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array List数据 false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    taskMsg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “taskMsg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

大数据任务恢复

  • 接口说明

大数据通用任务恢复

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/taskResume

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array false
  taskInfo[0] Object false
   taskId String false 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array List数据 false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    taskMsg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “taskMsg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

大数据任务删除

  • 接口说明

用户可以删除不需要的大数据分析任务

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/taskDelete

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array false
  taskInfo[0] Object false
   taskId String false 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array 任务删除信息列表 false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    taskMsg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “taskMsg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

大数据任务状态查询

  • 接口说明

用户可以查询已经提交的大数据分析任务的状态

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/taskStatus

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array false
  taskInfo[0] Object false
   taskId String false 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array false
   list[0] Object false
    taskCode String 任务状态码(参考状态码列表) false fdb4465d7aa5495884845127a8bbbe3c
    taskMsg String 错误详细信息 false success
    taskStatus Number 任务状态(1-未调度 Not Dispatched,2-等待 Waiting,3-正在执行 Executing,4-已完成 Completed,11-暂停 Paused,12-暂停中 Pausing,13-任务失败 Failed) false 1
    taskStatusName String 任务状态 false 未调度 Not Dispatched
    taskId String 任务ID false temp_301230caa5534d0d9de6f9c020936019
    progress Number 任务执行进度(取值范围:0-100) false 1
    remainTime Number 任务预估时间(单位:秒。-1:该任务不支持返回预估时间) false 100
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “fdb4465d7aa5495884845127a8bbbe3c”,
         “taskMsg”: “success”,
         “taskStatus”: 1,
         “taskStatusName”: “未调度 Not Dispatched”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
         “progress”: 1,
         “remainTime”: 100
      }
    ]
  }
}

布控任务通用服务

布控任务暂停

  • 接口说明

用户可以暂停处于布防状态中的指定的人脸、车辆布控任务。即停止布控。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/controlTaskPause

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array true
  taskInfo[0] Object true
   taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    msg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “msg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

布控任务恢复

  • 接口说明

用户可以恢复处于暂停状态或错误状态的人脸、车辆布控任务

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/controlTaskResume

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array true
  taskInfo[0] Object true
   taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    msg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “msg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

布控任务删除

  • 接口说明

用户删除不需要的人脸、车辆布控任务

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/controlTaskDelete

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array true
  taskInfo[0] Object true
   taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array false
   list[0] Object false
    taskCode String 错误码(0表示成功,其他表示失败) false 0
    msg String 错误详细信息 false success
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskCode”: “0”,
         “msg”: “success”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
      }
    ]
  }
}

布控任务状态查询

  • 接口说明

查询人脸、车辆布控任务的执行状态

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/controlTaskStatus

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskInfo Array true
  taskInfo[0] Object true
   taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “taskInfo”: [
     {
       “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  list Array false
   list[0] Object false
    taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
    taskStatus Number 任务状态(1-未调度 Not Dispatched,2-等待 Waiting,3-正在执行 Executing,4-已完成 Completed,5-已删除 Deleted,6-节点不在线 Offline,7-服务器宕机 Server Down,8-正在停止 Stopping,9-已停止 Stopped,10-节点重启 Rebooting,11-暂停 Paused,12-暂停中 Pausing,13-任务失败 Failed,14-taskID不存在) false 1
    taskStatusName String 任务状态说明 false 未调度
    taskCode String 任务状态码(参考状态码列表) false 0x1302
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “list”: [
       {
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
         “taskStatus”: 1,
         “taskStatusName”: “未调度”,
         “taskCode”: “0x1302”
      }
    ]
  }
}