X-Link API 文档-V4.0.0

简体中文

English

简体中文

English

Appearance

终端升级 ​

设备升级管理,支持设备离线下发,支持批量下发,立即下发只支持在线设备,下发任务后调用获取升级状态接口,获取升级详细状态,建议10秒以上调用一次

接口信息

请求地址: /web_api/v1/dev_manage/dev_upgrade ​

请求类型: POST ​

Content-Type:application/json ​

请求参数 ​

名称类型必选说明
vehicleNosarray(string)是车牌号列表
immediatebool否是否立即下发到终端,只支持在线
upgradeTypeinteger是升级类型,1:XL:私有协议升级,2:XL HTTP URL(未实现),3:XL HTTP 文件名(未实现)
xlSelfInfoobject否XL 升级请求信息 升级类型为1有效,查看表1
httpUpgradeInfostring否http升级信息, 只有升级类型为2,3有效
upgradeConditionobject否升级条件,满足条件才能触发升级,immediate:false有效,查看表2

表1: XL 升级请求信息 ​

名称类型必选说明
fileNamestring是文件名,需要带扩展名
serverIPstring是升级服务器IP
serverPortinteger是升级服务器Port

表2: 升级条件 ​

名称类型必选说明
netSignalinteger否网络信号类型,0:所有,1:良以及以上,2:优以及以上
speedinteger否当前速度大于多少才开始升级,0:不限制,单位 KM/H
accStatusinteger否点火状态,0:所有,1:点火,2:熄火

响应Data (类型:array(string)) ​

失败的车牌号列表

示例 ​

请求示例 ​

json
http://localhost:8080/web_api/v1/dev_manage/dev_upgrade   
{
    "vehicleNos": ["1300000001","1300000002"],
    "upgradeType":1,
    "immediate":false,
    "xlSelfInfo":{
        "serverPort": 30000,
        "serverIP":"127.0.0.1",
        "fileName":"S51_V1.0.0.img"
    },
    "upgradeCondition":{
        "netSignal":0,
        "speed":0,
        "accStatus":0
    }
}
http://localhost:8080/web_api/v1/dev_manage/dev_upgrade   
{
    "vehicleNos": ["1300000001","1300000002"],
    "upgradeType":1,
    "immediate":false,
    "xlSelfInfo":{
        "serverPort": 30000,
        "serverIP":"127.0.0.1",
        "fileName":"S51_V1.0.0.img"
    },
    "upgradeCondition":{
        "netSignal":0,
        "speed":0,
        "accStatus":0
    }
}

响应示例 ​

json
{
    "hdr":{
        "code":200,
        "message":"success"
    },
    "data":["1300000001"] //失败的车牌号列表
}
{
    "hdr":{
        "code":200,
        "message":"success"
    },
    "data":["1300000001"] //失败的车牌号列表
}

获取终端升级状态 ​

定时调用此接口获取升级状态,建议10秒以上调用一次

接口信息

请求地址: /web_api/v1/dev_manage/get_dev_upgrade_progress ​

请求类型: POST ​

Content-Type:application/json ​

请求参数 ​

名称类型必选说明
vehicleNosarray(string)是车牌号列表

响应Data (类型:array(object)) ​

名称类型说明
createTimeinteger升级创建时间
startTimeinteger升级开始时间
endTimeinteger结束时间
upgradeStatusinteger升级状态,1:待升级;2:正在下载;3:正在升级;4:升级成功;10:升级失败;11:下载文件失败;12:连接升级服务器失败;13:升级文件错误;14:设备不支持;15:升级超时
progressinteger进度,0-100
UpgradeBaseInfoobject升级基本信息,查看表3

表3: 升级基本信息 ​

名称类型说明
vehicleGuidinteger车辆ID
deviceNostring终端号
vehicleNostring车牌号
upgradeTypeinteger升级类型,1:XL:私有协议升级,2:XL HTTP URL(未实现),3:XL HTTP 文件名(未实现)
xlSelfInfoobjectXL 升级请求信息 升级类型为1有效,查看表1
httpUpgradeInfostringhttp升级信息, 只有升级类型为2,3有效
upgradeConditionobject升级条件,满足条件才能触发升级,immediate:false有效,查看表2

示例 ​

请求示例 ​

json
http://localhost:8080/web_api/v1/dev_manage/get_dev_upgrade_progress   
{
    "vehicleNos": ["1300000001","1300000002"]
}
http://localhost:8080/web_api/v1/dev_manage/get_dev_upgrade_progress   
{
    "vehicleNos": ["1300000001","1300000002"]
}

响应示例 ​

json
{
    "hdr":{
        "code":200,
        "message":"success"
    },
    "data":[{
        "createTime":1703676981,
        "startTime":1703676981,
        "endTime":1703677000,
        "upgradeStatus":3,
        "progress":50,
        "UpgradeBaseInfo":{
            "vehicleGuid":1,
            "deviceNo":"1300000001",
            "vehicleNo":"1300000001",
            "upgradeType":1,
            "xlSelfInfo":{
                "serverPort": 30000,
                "serverIP":"127.0.0.1",
                "fileName":"S51_V1.0.0.img"
            },
            "httpUpgradeInfo":"",
            "upgradeCondition":{
                "netSignal":0,
                "speed":0,
                "accStatus":0
            }
        }
    },{
     "createTime":1703676981,
        "startTime":1703676981,
        "endTime":1703677000,
        "upgradeStatus":3,
        "progress":50,
        "UpgradeBaseInfo":{
            "vehicleGuid":1,
            "deviceNo":"1300000002",
            "vehicleNo":"1300000002",
            "upgradeType":1,
            "xlSelfInfo":{
                "serverPort": 30000,
                "serverIP":"127.0.0.1",
                "fileName":"S51_V1.0.0.img"
            },
            "httpUpgradeInfo":"",
            "upgradeCondition":{
                "netSignal":0,
                "speed":0,
                "accStatus":0
            }
        }
    }]
}
{
    "hdr":{
        "code":200,
        "message":"success"
    },
    "data":[{
        "createTime":1703676981,
        "startTime":1703676981,
        "endTime":1703677000,
        "upgradeStatus":3,
        "progress":50,
        "UpgradeBaseInfo":{
            "vehicleGuid":1,
            "deviceNo":"1300000001",
            "vehicleNo":"1300000001",
            "upgradeType":1,
            "xlSelfInfo":{
                "serverPort": 30000,
                "serverIP":"127.0.0.1",
                "fileName":"S51_V1.0.0.img"
            },
            "httpUpgradeInfo":"",
            "upgradeCondition":{
                "netSignal":0,
                "speed":0,
                "accStatus":0
            }
        }
    },{
     "createTime":1703676981,
        "startTime":1703676981,
        "endTime":1703677000,
        "upgradeStatus":3,
        "progress":50,
        "UpgradeBaseInfo":{
            "vehicleGuid":1,
            "deviceNo":"1300000002",
            "vehicleNo":"1300000002",
            "upgradeType":1,
            "xlSelfInfo":{
                "serverPort": 30000,
                "serverIP":"127.0.0.1",
                "fileName":"S51_V1.0.0.img"
            },
            "httpUpgradeInfo":"",
            "upgradeCondition":{
                "netSignal":0,
                "speed":0,
                "accStatus":0
            }
        }
    }]
}