1. 设备运维

设备运维

1.1. 重启

基础信息

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

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
    "uuid": "5b99d4e34c2745eb803ab63e8520ae54"
}

返回数据

Headers:

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

Body:

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

响应示例:

{
    "code":0,
    "msg":"成功"
}

1.2. 恢复出厂设置

基础信息

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

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
    "uuid": "5b99d4e34c2745eb803ab63e8520ae54"
}

返回数据

Headers:

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

Body:

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

响应示例:

{
    "code":0,
    "msg":"成功"
}

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": 1,
    "uuid": "DE-2b68e9e5f1a84175909960a971059590",
    "ntpConfig": {
        "serverAddr": "10.171.5.193",
        "serverPort": 123,
        "interval": 1
    }
}

返回数据

Headers:

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

Body:

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

响应示例:

{
    "code":0,
    "msg":"成功"
}

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示例:

{
    "pageNum": 1,
    "pageSize": 2,
    "deviceUuid": "DE-2b68e9e5f1a84175909960a971059590"
}

返回数据

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,
    "data":{
        "list":[
            {
                "createTime":1679409360045,
                "endTime":1679380559892,
                "logTypeList":[
                    3
                ],
                "startTime":1679380549892,
                "type":1
            },
            {
                "createTime":1679409456376,
                "endTime":1679380656248,
                "logTypeList":[
                    3
                ],
                "startTime":1679380646248,
                "type":1
            }
        ],
        "pageNum":1,
        "pageSize":2,
        "total":4
    },
    "msg":"成功"
}

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示例:

{
    "pageNum": 1,
    "pageSize": 2,
    "deviceUuid": "DE-2b68e9e5f1a84175909960a971059590",
    "startTime": 1679241600000,
    "endTime": 1679414400000
}

返回数据

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,
    "data":{
        "list":[
            {
                "createTime":1679409372930,
                "deviceType":7,
                "fileUri":"http://10.171.5.193:80/v1/storage/download/Z3NwOi8vd3Vrb25n-c1ee852a0d07f5ca50bc62b62977974c.gz",
                "logType":3,
                "uploadTime":1679380572825
            },
            {
                "createTime":1679409468500,
                "deviceType":7,
                "fileUri":"http://10.171.5.193:80/v1/storage/download/Z3NwOi8vd3Vrb25n-2c51b382023ea9cd60ddf8760058d394.gz",
                "logType":3,
                "uploadTime":1679380668378
            }
        ],
        "pageNum":1,
        "pageSize":2,
        "total":4
    },
    "msg":"成功"
}

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": "DE-2b68e9e5f1a84175909960a971059590",
    "logTypeList": [3],
    "logAgeing": 1,
    "startTime": 1679380646248,
    "endTime": 1679380656248
}

返回数据

Headers:

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

Body:

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

响应示例:

{
    "code":0,
    "msg":"成功"
}

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

基础信息

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

请求方法: POST

请求参数

Headers:

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

Body:

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

Body示例:

{
  "deviceUuid": "DE-2b68e9e5f1a84175909960a971059590"
}

返回数据

Headers:

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

Body:

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

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "supports": [1,2,3,4,5,6,7]
  }
}

results matching ""

    No results matching ""