返回

ISAPI 接口指引

5.1.2 系统维护

 

5.1.2.1 获取设备系统能力

 

Request URL

GET /ISAPI/System/capabilities

 

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<DeviceCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, req, object, 设备系统能力, attr:version{opt, string, 版本信息}-->

<isSupportReboot>

<!--ro, opt, bool, 是否支持重启, desc:交通产线必填且为true-->true

</isSupportReboot>

<isSupportDeviceInfo>

<!--ro, opt, bool, 是否支持获取设备信息, desc:交通产线必填且为true-->true

</isSupportDeviceInfo>

<isSupportTime>

<!--ro, opt, bool, 表示是否支持时间配置, desc:交通产线必填且为true,其他产线使用的是

isSupportTimeCap-->true

</isSupportTime>

<SysCap>

<!--ro, opt, object, 系统能力-->

<isSupportDst>

<!--ro, opt, bool, 是否支持夏令时-->true

</isSupportDst>

<NetworkCap>

<!--ro, opt, object, 网络能力, desc:接口:/ISAPI/System/Network/capabilities-

->

<isSupportWireless>

<!--ro, req, bool, 是否支持无线网-->true

</isSupportWireless>

<isSupportWired>

<!--ro, opt, bool, 是否支持有线网-->true

</isSupportWired>

<isSupportWAN>

<!--ro, opt, bool, 是否支持广域网-->true

</isSupportWAN>

<isSupportPPPoE>

<!--ro, req, bool, 是否支持以太网点对点协议-->true

</isSupportPPPoE>

<isSupportBond>

<!--ro, req, bool, 是否支持网卡绑定-->true

</isSupportBond>

<isSupport802_1x>

<!--ro, req, bool, 是否支持802.1x协议-->true

</isSupport802_1x>

<isSupportDdns>

<!--ro, opt, bool, 是否支持动态域名服务-->true

</isSupportDdns>

<isSupportSSH>

<!--ro, opt, bool, 是否支持SSH-->true

</isSupportSSH>

</NetworkCap>

<isSupportTimeCap>

<!--ro, opt, bool, 是否支持时间配置, desc:接

口:/ISAPI/System/time/capabilities-->true

</isSupportTimeCap>

<DeployCap>

<!--ro, opt, object, 布防非订阅参数能力-->

<deployID opt="1,2">

<!--ro, opt, enum, 布防类型, subType:int, [0#客户端布防,1#实时布防],

attr:opt{req, string, 取值范围}-->0

</deployID>

</DeployCap>

</DeviceCap>

 

5.1.2.2 获取网络服务能力

 

Request URL

GET /ISAPI/System/Network/capabilities

 

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<NetworkCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, req, object, 获取网络服务能力, attr:version{opt, string, 协议版本}-->

<isSupportWireless>

<!--ro, req, bool, 是否支持无线网-->true

</isSupportWireless>

<isSupportWired>

<!--ro, opt, bool, 是否支持有线网-->true

</isSupportWired>

<isSupportWAN>

<!--ro, opt, bool, 是否支持广域网-->true

</isSupportWAN>

<isSupportPPPoE>

<!--ro, req, bool, 是否支持以太网点对点协议-->true

</isSupportPPPoE>

<isSupportBond>

<!--ro, req, bool, 是否支持网卡绑定-->true

</isSupportBond>

<isSupport802_1x>

<!--ro, req, bool, 是否支持802.1x协议-->true

</isSupport802_1x>

<isSupportDdns>

<!--ro, opt, bool, 是否支持动态域名服务-->true

</isSupportDdns>

<isSupportSSH>

<!--ro, opt, bool, 是否支持SSH-->true

</isSupportSSH>

</NetworkCap>

 

5.1.2.3 设备重启

 

Request URL

PUT /ISAPI/System/reboot?childDevID=<devIndex>&module=<module>&loginPassword=

<loginPassword>

 

查询参数

 

参数名称 参数类型 描述
devIndex string

可指定子设备ID进行子设备的重启。当前设备所接入的子设备ID可通过该接口进行查询：/ISAPI/IoTGateway/Childmanage/SearchChild?format=json
module enum

module指定对模块重启，无需重启设备，对应能力/ISAPI/System/capabilities的deviceReboot->module，1、algorithmProgram：交通终端雷视算法程序，支持算法程序单独启动，2、radar：雷视相机的雷达模块重启
loginPassword string ——

 

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<ResponseStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, req, object, 响应消息, attr:version{ro, req, string, 版本}-->

<requestURL>

<!--ro, opt, string, 请求的URL, range:[0,1024]-->null

</requestURL>

<statusCode>

<!--ro, req, enum, 状态码, subType:int, [0#OK,1#OK,2#Device Busy,3#Device

Error,4#Invalid Operation,5#Invalid XML Format,6#Invalid XML Content,7#Reboot

Required]-->0

</statusCode>

<statusString>

<!--ro, req, enum, 状态信息, subType:string, [OK#成功,Device Busy#设备忙,Device

Error#设备异常,Invalid Operation#无效的操作,Invalid XML Format#无效的XML格式,Invalid

XML Content#无效的XML内容,Reboot Required#设备重启]-->OK

</statusString>

<subStatusCode>

<!--ro, req, string, 详细错误码英文描述, desc:详细错误码的英文描述-->OK

</subStatusCode>

<description>

<!--ro, opt, string, 自定义错误信息描述, range:[0,1024], desc:设备应用程序返回的自

定义详细错误信息，用于快速定位评查问题-->badXmlFormat

</description>

<MErrCode>

<!--ro, opt, string, 功能模块化错误码, desc:通用错误码都在此字段范围中-->0x00000000

</MErrCode>

<MErrDevSelfEx>

<!--ro, opt, string, 功能模块化错误码, desc:此字段是MErrCode自定义模块化错误码的扩展

字段，自定义模块化错误码一共有MErrCode 的后20bit和此字段的32bit-->0x00000000

</MErrDevSelfEx>

</ResponseStatus>

 

5.1.2.4 获取设备状态

 

URL

GET /ISAPI/System/status

 

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<DeviceStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, opt, object, 设备状态, attr:version{opt, string, 域名空间}-->

<CPUList>

<!--ro, opt, array, CPU数据列表, subType:object-->

<CPU>

<!--ro, opt, object, CPU数据-->

<cpuDescription>

<!--ro, req, string, 描述-->test

</cpuDescription>

<cpuUtilization>

<!--ro, req, int, CPU使用率, range:[0,100], desc:前端相机设备返回的是int型，

交通相机设备本参数返回的是float型小数，建议平台按照实际收到的数据类型解析-->1

</cpuUtilization>

<cpuTemperature>

<!--ro, opt, int, CPU温度, range:[-40,80], unit:℃, unitType:温度-->1

</cpuTemperature>

</CPU>

</CPUList>

<NetPortStatusList>

<!--ro, opt, array, 网络端口状态列表, subType:object-->

<NetPortStatus>

<!--ro, opt, object, 网络端口状态-->

<id>

<!--ro, req, int, 索引-->1

</id>

<netPortDescription>

<!--ro, req, enum, 端口描述, subType:string, [ctrl#控制端口,data1#数据

1,data2#数据2]-->ctrl

</netPortDescription>

<linkStatus>

<!--ro, opt, enum, 连接状态, subType:string, [connected#已连

接,disconnected#未连接]-->connected

</linkStatus>

</NetPortStatus>

</NetPortStatusList>

<MemoryList>

<!--ro, opt, array, 内存列表, subType:object-->

<Memory>

<!--ro, opt, object, 内存-->

<memoryDescription>

<!--ro, req, string, 描述-->test

</memoryDescription>

<memoryUsage>

<!--ro, req, float, 已用内存大小, unit:MB, unitType:信息量-->1.0

</memoryUsage>

<memoryAvailable>

<!--ro, req, float, 可用内存大小, unit:MB, unitType:信息量-->1.0

</memoryAvailable>

</Memory>

</MemoryList>

<HardDiskStatusList>

<!--ro, opt, array, 硬盘状态列表, subType:object-->

<HardDiskStatus>

<!--ro, opt, object, 硬盘状态-->

<description>

<!--ro, req, string, 描述-->test

</description>

<status>

<!--ro, req, enum, 状态, subType:string, [full#满,normal#正常,abnormal#异

常,formatting#格式化中]-->full

</status>

<hardDiskUsage>

<!--ro, req, float, 磁盘使用空间, range:[0.000,1048576.000], unit:MB,

unitType:信息量-->0.000

</hardDiskUsage>

<hardDiskAvailable>

<!--ro, req, float, 磁盘剩余空间, range:[0.000,1048576.000], unit:MB,

unitType:信息量-->0.000

</hardDiskAvailable>

</HardDiskStatus>

</HardDiskStatusList>

</DeviceStatus>

 

5.1.2.4 获取系统安全能力

 

URL

GET /ISAPI/Security/capabilities?username=&deviceIndex=

 

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<SecurityCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, req, object, 系统安全能力, attr:version{req, string, 协议版本}-->

<supportUserNums>

<!--ro, opt, int, 支持用户最大数-->0

</supportUserNums>

<isSupCertificate>

<!--ro, opt, bool, 是否支持认证-->true

</isSupCertificate>

</SecurityCap>

 

……

申请完整协议文件
如需要完整协议开发文档，请填写以下申请信息，我们会在收到信息的一周内与您联系并提供完整内容
地址
    向右滑动完成验证
    contact us
    联系支持
    联系我们
    售后服务
    close
    qrCode
    微信小程序
    扫码登录微信小程序，可轻松查阅海量资料与视频