1. 1 设备运维

设备运维

1.1. 重启

基础信息

路径: /v1/api/device/ops/reboot

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 设备uuid

Body示例:

{
  "uuid": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.2. 恢复出厂设置

基础信息

路径: /v1/api/device/ops/restore

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 设备uuid

Body示例:

{
  "uuid": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.3. 校时

基础信息

路径: /v1/api/device/ops/timing

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
type integer 是 校时方式 1-ntp 2-手动
uuid string 是 设备uuid
ntpConfig object 否 ntp校时参数
  |─serverAddr string 否 NTP服务器地址
  |─serverPort integer 否 NTP服务器端口
  |─interval integer 否 NTP校时间隔，单位分钟
manualConfig object 否 手动校时参数
  |─timestamp string 否 UTC时间戳（秒）
  |─timezone integer 否 时区

Body示例:

{
  "type": 0,
  "uuid": "",
  "ntpConfig": {
    "serverAddr": "",
    "serverPort": 0,
    "interval": 0
  },
  "manualConfig": {
    "timestamp": "",
    "timezone": 0
  }
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.4. 日志指令列表(日志导出列表）

基础信息

路径: /v1/api/device/ops/log/queryLogCmdList

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
deviceUuid string 是 设备uuid
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "deviceUuid": "",
  "pageNum": 0,
  "pageSize": 0
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─pageNum integer 是 页码，从1开始
当前页码
  |─pageSize integer 是 页面大小
分页大小
  |─total integer 是 总记录数
总数
  |─list array 否
    |─ object
      |─createTime integer 否 创建时间
      |─startTime integer 否 开始时间
      |─endTime integer 否 结束时间
      |─type integer 否 指令类型
      |─logTypeList array 否 日志类型 1-内核日志 2-业务日志 3-debug日志
        |─ integer

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNum": 0,
    "pageSize": 0,
    "total": 0,
    "list": [
      {
        "createTime": 0,
        "startTime": 0,
        "endTime": 0,
        "type": 0,
        "logTypeList": [
          0
        ]
      }
    ]
  }
}

1.5. 日志列表（运维数据列表)

基础信息

路径: /v1/api/device/ops/log/queryLogList

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
deviceUuid string 是 设备uuid
logType integer 否 日志类型 1-内核日志 2-业务日志 3-debug日志
startTime integer 是 开始时间(ms)
endTime integer 是 结束时间(ms)
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "deviceUuid": "",
  "logType": 0,
  "startTime": 0,
  "endTime": 0,
  "pageNum": 0,
  "pageSize": 0
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─pageNum integer 是 页码，从1开始
当前页码
  |─pageSize integer 是 页面大小
分页大小
  |─total integer 是 总记录数
总数
  |─list array 否
    |─ object
      |─createTime integer 否 创建时间
      |─logType integer 否 日志类型 1-内核日志 2-业务日志 3-debug日志
      |─fileUri string 否 日志文件uri
      |─uploadTime integer 否 上传时间
      |─deviceType integer 否 设备类型

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNum": 0,
    "pageSize": 0,
    "total": 0,
    "list": [
      {
        "createTime": 0,
        "logType": 0,
        "fileUri": "",
        "uploadTime": 0,
        "deviceType": 0
      }
    ]
  }
}

1.6. 发送日志导出指令

基础信息

路径: /v1/api/device/ops/log/sendExportLogCmd

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
deviceUuid string 是 设备uuid
logTypeList array 是 日志类型 1-内核日志 2-业务日志 3-debug日志
  |─ integer
startTime integer 是 开始时间(ms)
endTime integer 是 结束时间(ms)
logAgeing integer 是 日志时效 1-当前日志 2-历史日志

Body示例:

{
  "deviceUuid": "",
  "logTypeList": [
    0
  ],
  "startTime": 0,
  "endTime": 0,
  "logAgeing": 0
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.7. 获取设备支持的运维操作类型

基础信息

路径: /v1/api/device/ops/support

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
deviceUuid string 是 设备uuid

Body示例:

{
  "deviceUuid": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─supports array 否 支持的操作类型
    |─ integer

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "supports": [
      0
    ]
  }
}

1.8. 通知掌纹设备开启采集模式

基础信息

路径: /v1/api/device/ops/gather

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
deviceUuid string 是 uuid
gatherPersonList array 是 待采集的人员信息
  |─ object
    |─personUuid string 否 人员Uuid，添加场景时需要调用方保证uuid唯一
    |─code string 否 员工编码
    |─name string 否 人员姓名
type integer 是 采集场景 1：添加人员 2：批量采集

Body示例:

{
  "deviceUuid": "",
  "gatherPersonList": [
    {
      "personUuid": "",
      "code": "",
      "name": ""
    }
  ],
  "type": 1
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.9. 闸机重启

基础信息

路径: /v1/api/device/ops/gate/reboot

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 设备uuid

Body示例:

{
  "uuid": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

1.10. 闸机恢复出厂设置

基础信息

路径: /v1/api/device/ops/gate/restore

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 设备uuid

Body示例:

{
  "uuid": ""
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "",
  "data": null
}

results matching ""

    No results matching ""