参数114dns

IPCHTTPCGI说明书ver1.
0.
01网络摄像机HTTPCGI说明书IPCameraHTTPCGISpecificationsVER.
1.
0.
3IPCHTTPCGI说明书ver1.
0.
02修改记录ReviseRecord版本VER.
日期Date描述Description1.
0.
02017年12月12日Dec.
8,2017创建IPCHTTPCGI说明书ver1.
0.
0CreatetheIPCHTTPCGIspecificationver1.
0.
01.
0.
12019年2月26日Feb.
26,2019添加移动侦测GET和SET的CGI接口AddCGIinterfaceformotiondetectionofGETandSET1.
0.
22019年9月27日Set.
27,2019增加1、用户管理API,2、获取设备型号API,3、恢复出厂,保留网络配置API,4、设备升级功能,5、截图保存功能API.
Add1,usermanagementAPI,2,acquisitionofdevicemodelAPI,3,restorethefactory,retainnetworkconfigurationAPI,4,equipmentupgradefunction,5,screenshotpreservationAPI.
IPCHTTPCGI说明书ver1.
0.
03目录Index1.
TheformatoftheHTTPrequestandresponse.
52.
CGI接口列表.
62.
Theinterfacelist.
63.
接口说明.
83.
Interfacespecification.
83.
1获取userid.
83.
1Getuserid.
83.
2心跳.
93.
2Keepalive.
93.
3获取设备信息.
103.
3Versioninformation.
103.
4能力集.
113.
4Getcapabilities.
113.
5重启.
113.
5Reboot.
113.
6恢复出厂设置.
133.
6RestoredefaultSettings.
133.
7网络配置.
143.
7Network.
143.
8时间.
153.
8Time.
153.
9视频编码能力集.
183.
9Videoencodingcapabilities.
183.
10视频编码配置.
193.
10Videoencodingconfiguration.
193.
11音频编码能力集.
213.
11Audioencodingcapabilities.
213.
12音频编码配置.
223.
12Audioencodingconfiguration.
223.
13OSD.
233.
13OSD.
233.
14图像.
273.
14Image.
273.
15PTZ控制.
283.
15PTZ.
283.
16移动侦测配置.
303.
16MotionDetectconfiguration.
303.
17获取设备型号(OEM)333.
17ObtainEquipmentModel.
333.
18用户管理.
34IPCHTTPCGI说明书ver1.
0.
043.
18UserManagement.
343.
19抓图上传.
373.
19snapshotupload.
373.
20固件升级.
393.
20UpgradeFirmware.
394.
使用XMLHttpRequest调用WEB服务器的CGI程序.
414.
UsingXMLHttpRequesttocallCGIprogramofwebserver.
41IPCHTTPCGI说明书ver1.
0.
051.
HTTP请求与响应的格式1.
TheformatoftheHTTPrequestandresponse1)HTTPGET请求,把请求的内容填充在HTTPURL中.
1)TorequestwithHTTPGET,writethecontentsoftherequestintheHTTPURL.
2)如果之后不带配置参数则是查询配置,返回当前配置信息;如果之后带配置参数则是设置,设置成功之后返回生效的配置参数.
例如查询配置/cgi-bin/networkuid=XXXXXXXX设置配置/cgi-bin/networkdhcp=0&uid=XXXXXXXX2)Ifthereisnoconfigurationparameterbehindthequestionmark,itisthequeryconfigurationtoreturnthecurrentconfigurationinformation;Iftheconfigurationparameterbehindthequestionmarkisset,theconfigurationparameterreturnedtotakeeffectafterthesuccessisset.
ForexampleQueryconfiguration/cgi-bin/networkuid=XXXXXXXXSettheconfiguration/cgi-bin/networkdhcp=0&uid=XXXXXXXX3)请求失败时在响应的报文中返回错误的原因,格式为:describethevaluedescribethereason3)Thecauseoftheerrorreturnedintheresponsemessagewhentherequestfailed.
MessageformatforexampledescribethevaluedescribethereasonIPCHTTPCGI说明书ver1.
0.
062.
CGI接口列表2.
Theinterfacelist序号No.
请求的URLTherequestedURL描述Description1/cgi-bin/getuidusername=xxxx&password=xxxx获取useridRequestuserid2/cgi-bin/keep_aliveuid=XXXXXXXX心跳Keepalive3/cgi-bin/getinfouid=XXXXXXXX设备信息Versioninformation4/cgi-bin/getcapabilitiesuid=XXXXXXXX能力集capabilities5/cgi-bin/rebootuid=XXXXXXXX重启reboot6/cgi-bin/factory_resetuid=XXXXXXXX恢复出厂设置RestoredefaultSettings7/cgi-bin/networkuid=XXXXXXXX网络配置network8/cgi-bin/timeuid=XXXXXXXX时间time9/cgi-bin/videoencoder/getcapabilitiesuid=XXXXXXXX视频编码能力集Videoencodingcapabilities10/cgi-bin/videoencoderuid=XXXXXXXX视频编码配置Videoencodingconfiguration11/cgi-bin/audioencoder/getcapabilitiesuid=XXXXXXXX音频编码能力集Audioencodingcapabilities12/cgi-bin/audioencoderuid=XXXXXXXX音频编码配置Audioencodingconfiguration13/cgi-bin/osduid=XXXXXXXXOSD14/cgi-bin/imageuid=XXXXXXXX图像image15/cgi-bin/ptz_ctrlstop=1&uid=XXXXXXXX云台控制PTZ16/cgi-bin/motionuid=XXXXXXXX移动侦测Motion17/cgi-bin/getmodeluid=XXXXXXXX获取设备型号Model18/cgi-bin/user_managementuid=XXXXXX用户管理IPCHTTPCGI说明书ver1.
0.
07UserManagement19/cgi-bin/snapshot.
cgiuid=XXXXXXX抓图上传snapshotupload20POST/cgi-bin/OnvifFirmwareUpgradeHTTP/1.
1固件升级UpgradeFirmwareIPCHTTPCGI说明书ver1.
0.
083.
接口说明3.
Interfacespecification首先需要使用/cgi-bin/getuid接口获取userid,其他接口都需要验证userid.
Userid60秒超时,失效之后需要重新请求userid.
每次成功请求cgi接口之后重新计算超时时间,如果长时间没有请求但又希望userid不失效,可以使用/cgi-bin/keep_alive接口保持心跳.
Firstyouneedtogettheuseridusingthe/cgi-bin/getuidinterface.
Theotherinterfacesneedtoauthenticatetheuserid.
Useridtimeoutfor60seconds,useridneedstoberequestedagainafterexpiration.
Aftereachsuccessfulrequestcgiinterfacetorecalculatethetimeout,ifthereisnorequestforalongtimeandhopeuseriddoesnotexpire,youcanusethe/cgi-bin/keep_aliveinterfacetokeeptheheartbeat.
3.
1获取userid3.
1Getuserid/cgi-bin/getuidusername=xxxx&password=xxxx参数名称Parametername参数值Parametervalue描述Descriptionusername字母和数字LettersandNumbersIPC用户名IPCusernamepassword字母和数字LettersandNumbersIPC密码IPCpassword响应的报文Responsemessage状态码Statuscode内容Content描述Description200XXXXXXXX请求成功,uid是XXXXXXXXTherequestwassuccessful,uidisXXXXXXXX400/cgi-bin/getuiderror,parseparameters获取参数失败Failedtogetparameters400/cgi-bin/getuiderror,parseusername获取用户名失败FailedtogetusernameIPCHTTPCGI说明书ver1.
0.
09400/cgi-bin/getuiderror,parsepassword获取密码失败Failedtogetpassword400/cgi-bin/getuidpassworderror密码错误Wrongpassword3.
2心跳3.
2Keepalive/cgi-bin/keep_aliveuid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200true请求成功Therequestwassuccessful400/cgi-bin/keep_aliveerror,parseparameters获取参数失败(此响应消息在其他CGI接口请求出错时也可能出现,下文不做重复解释)Failedtogetparameters(ThisresponsemessagemayalsoappearintherequestofotherCGIinterfaceerror,thefollowingwillnotberepeatedexplanation)IPCHTTPCGI说明书ver1.
0.
010400/cgi-bin/keep_aliveerror,parseuid获取uid失败(此响应消息在其他CGI接口请求出错时也可能出现,下文不做重复解释)Failedtogetuid(ThisresponsemessagemayalsoappearintherequestofotherCGIinterfaceerror,thefollowingwillnotberepeatedexplanation)400/cgi-bin/keep_aliveuiderroruid错误或者已经超时失效(此响应消息在其他CGI接口请求出错时也可能出现,下文不做重复解释)uiderrororinvalidtimeout(ThisresponsemessagemayalsoappearintherequestofotherCGIinterfaceerror,thefollowingwillnotberepeatedexplanation)3.
3获取设备信息3.
3Versioninformation/cgi-bin/getinfouid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:kernel:内核版本filesystem:文件系统版本sn:产品序列号IPCHTTPCGI说明书ver1.
0.
011Therequestwassuccessful.
Thevalueoftheparameteris:kernel:Kernelversionfilesystem:Filesystemversionsn:Productserialnumber3.
4能力集3.
4Getcapabilities/cgi-bin/getcapabilitiesuid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值1支持,0不支持.
video:是否支持视频audio:是否支持音频ptz:是否支持云台控制Therequestwassuccessful.
Thevalueofparameter1issupported,0isnotsupported.
video:Whethertosupportvideoaudio:Whethertosupportaudioptz:WhethertosupportPTZ3.
5重启3.
5Reboot/cgi-bin/rebootuid=XXXXXXXX参数名称参数值描述IPCHTTPCGI说明书ver1.
0.
012ParameternameParametervalueDescriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200true请求成功Therequestwassuccessful.
IPCHTTPCGI说明书ver1.
0.
0133.
6恢复出厂设置3.
6RestoredefaultSettings/cgi-bin/factory_resetuid=XXXXXXXX/cgi-bin/factory_resetretain_network=1&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
retain_network数字1Number11:表示恢复出厂会保留设备的网络配置.
1:Representsthatrestoringthefactorywillretainthenetworkconfigurationofthedevice.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200true请求成功Therequestwassuccessful.
400/cgi-bin/factory_resetretain_network0or1获取参数失败retain_network参数只能是1,是其余的参数出错.
Theretainnetworkparametercanonlybe1.
Therestoftheparametersarewrong.
400/cgi-bin/factory_resetretain_network:NULL获取参数失败retain_network参数为空的时候,上报错误.
Whentheretain_networkparameterisempty,anerrorisreported.
IPCHTTPCGI说明书ver1.
0.
0143.
7网络配置3.
7Network/cgi-bin/networkuid=XXXXXXXX/cgi-bin/networkdhcp=0&uid=XXXXXXXX/cgi-bin/networkipaddr=192.
168.
4.
65&netmask=255.
255.
255.
0&gateway=192.
168.
4.
1&uid=XXXXXXXX/cgi-bin/networkdns1=114.
114.
114.
114&dns2=8.
8.
8.
8&uid=XXXXXXXX/cgi-bin/networkport=80&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
dhcp选项(Option):101启用DHCP,0禁用DHCP1EnableDHCP,0DisableDHCPipaddrIP地址IPaddressnetmask子网掩码Subnetmaskgateway网关地址Gatewayaddressdns1首先DNSPreferredDNSdns2备用DNSStandbyDNSport数字80或从1000至65535Numbers80orfrom1000to65535端口Serverport响应的报文Responsemessage状态码Statuscode内容Content描述Description200netmask:子网掩码gateway:网关地址dns1:首先DNSdns2:备用DNSport:端口Therequestwassuccessful.
Thevalueoftheparameteris:macaddr:MACaddressdhcp:1EnableDHCP,0DisableDHCPipaddr:IPaddressnetmask:Subnetmaskgateway:Gatewayaddressdns1:PreferredDNSdns2:StandbyDNSport:Serverport400/cgi-bin/networkdhcp:0or1参数dhcp错误(其他参数的错误提示类似,不重复解释)Parameterdhcperror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)3.
8时间3.
8Time/cgi-bin/timeuid=XXXXXXXX/cgi-bin/timetimezone=GMT+08:00&uid=XXXXXXXX/cgi-bin/timeupdate_method=MANUAL&year=2017&month=11&day=30&hour=8&min=0&sec=0&uid=XXXXXXXX/cgi-bin/timeupdate_method=ntp&ntpaddr=pool.
ntp.
org&port=123&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
timezone选项(Option):GMT+00:00GMT+01:00GMT+02:00时区TimezoneIPCHTTPCGI说明书ver1.
0.
016GMT+03:00GMT+03:30GMT+04:00GMT+04:30GMT+05:00GMT+05:30GMT+05:45GMT+06:00GMT+06:30GMT+07:00GMT+08:00GMT+09:00GMT+09:30GMT+10:00GMT+11:00GMT+12:00GMT+13:00GMT-01:00GMT-02:00GMT-03:00GMT-03:30GMT-04:00GMT-04:30GMT-05:00GMT-06:00GMT-07:00GMT-08:00GMT-09:00GMT-10:00GMT-11:00GMT-12:00update_method选项(Option):MANUALNTPP2P更新方式Updatemethodyear数字Numbers年yearmonth数字Numbers月份monthday数字Numbers日期dayhour数字Numbers小时hourIPCHTTPCGI说明书ver1.
0.
017min数字Numbers分钟minutesec数字Numbers秒钟SecondsntpaddrNTP服务器地址NTPserveraddressport数字80或从1000至65535Numbers80orfrom1000to65535NTP服务器端口NTPserverport响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:timezone:时区update_method:更新方式ntpaddr:NTP服务器地址port:NTP服务器端口current_time:当前时间Therequestwassuccessful.
Thevalueoftheparameteris:timezone:Timezoneupdate_method:Updatemethodntpaddr:NTPserveraddressport:NTPserverportcurrent_time:Currenttime400/cgi-bin/timetimezoneerror参数timezone错误(其他参数的错误提示类似,不重复解释)Parametertimezoneerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)IPCHTTPCGI说明书ver1.
0.
0183.
9视频编码能力集3.
9Videoencodingcapabilities/cgi-bin/videoencoder/getcapabilitiesuid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description2001-15500-80001-30500-60001-15500-60001-30500-4000请求成功.
参数的值是:stream1:主码流stream2:子码流encode_mode:编码模式resolution:分辨率framerate_range:帧率范围bitrate_range:码率范围Therequestwassuccessful.
Thevalueoftheparameteris:stream1:Mainstreamstream2:Substreamencode_mode:Encodemoderesolution:Resolutionframerate_range:Frameraterangebitrate_range:BitraterangeIPCHTTPCGI说明书ver1.
0.
0191-3050-20001-3050-20001-3050-20001-3050-20003.
10视频编码配置3.
10Videoencodingconfiguration/cgi-bin/videoencoderuid=XXXXXXXX/cgi-bin/videoencoder/stream1encode_mode=H265&resolution=1080P&framerate=25&govlength=100&bitrate=2500&bitrate_control=CBR&uid=XXXXXXXX/cgi-bin/videoencoder/stream2encode_mode=H265&resolution=480X360&framerate=25&govlength=100&bitrate=200&bitrate_control=CBR&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
encode_mode编码模式,通过/cgi-bin/videoencoder/getcapabilities接口得到的选项Encode_mode.
Optionsavailablethroughthe/cgi-bin/videoencoder/getcapabilitiesinterfaceresolution分辨率,通过/cgi-bin/videoencoder/getcapabilities接口得到的选项Resolution.
Optionsavailablethroughthe/cgi-bin/videoencoder/getcapabilitiesinterfaceIPCHTTPCGI说明书ver1.
0.
020framerate帧率,通过/cgi-bin/videoencoder/getcapabilities接口得到的选项Framerate.
Optionsavailablethroughthe/cgi-bin/videoencoder/getcapabilitiesinterfacegovlengthI帧间隔Govlengthbitrate码率,通过/cgi-bin/videoencoder/getcapabilities接口得到的选项Bitrate.
Optionsavailablethroughthe/cgi-bin/videoencoder/getcapabilitiesinterfacebitrate_control选项(Option):CBRVBR码率控制类型Bitratecontroltype响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:stream1:主码流stream2:子码流encode_mode:编码模式resolution:分辨率framerate_range:帧率范围govlength:I帧间隔bitrate_range:码率范围bitrate_control:码率控制类型Therequestwassuccessful.
Thevalueoftheparameteris:stream1:Mainstreamstream2:Substreamencode_mode:Encodemoderesolution:Resolutionframerate_range:Frameraterangegovlength:Govlengthbitrate_range:Bitraterangebitrate_control:Bitratecontroltype400/cgi-bin/videoencoder/stream1参数encode_mode错误(其他参数的错误提示类似,不重复解释)IPCHTTPCGI说明书ver1.
0.
021encode_modeerrorParameterencode_modeerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)3.
11音频编码能力集3.
11Audioencodingcapabilities/cgi-bin/audioencoder/getcapabilitiesuid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200640006400016000请求成功.
参数的值是:encode_type:编码类型samplerate:采样率bitrate:比特率Therequestwassuccessful.
Thevalueoftheparameteris:encode_type:Encodetypesamplerate:Sampleratebitrate:BitrateIPCHTTPCGI说明书ver1.
0.
0223.
12音频编码配置3.
12Audioencodingconfiguration/cgi-bin/audioencoderuid=XXXXXXXX/cgi-bin/audioencoderenable=0&uid=XXXXXXXX/cgi-bin/audioencoderenable=1&uid=XXXXXXXX/cgi-bin/audioencoderenable=1&encode_type=G.
711&samplerate=8000&bitrate=64000&uid=XXXXXXXX/cgi-bin/audioencoderinput_volume=60&output_volume=80&lify=1&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
enable选项(Option):101启用音频,0禁用音频1Enableaudio,0Disableaudioencode_type编码类型,通过/cgi-bin/audioencoder/getcapabilities接口得到的选项Encodetype.
Optionsavailablethroughthe/cgi-bin/audioencoder/getcapabilitiesinterfacesamplerate采样率,通过/cgi-bin/audioencoder/getcapabilities接口得到的选项Samplerate.
Optionsavailablethroughthe/cgi-bin/audioencoder/getcapabilitiesinterfacebitrate比特率,通过/cgi-bin/audioencoder/getcapabilities接口得到的选项Bitrate.
Optionsavailablethroughthe/cgi-bin/audioencoder/getcapabilitiesinterfaceinput_volume数字1至100Numbersfrom1to100输入音量Inputvolumeoutput_volume数字1至100Numbersfrom1to100输出音量Outputvolumeamplify选项(Option):101启用音频功放,0禁用音频功放1Enableaudioamplifier,0DisableaudioamplifierIPCHTTPCGI说明书ver1.
0.
023响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:enable:启用或禁用音频encode_type:编码类型samplerate:采样率bitrate:比特率input_volume:输入音量output_volume:输出音量amplify:启用或禁用音频功放Therequestwassuccessful.
Thevalueoftheparameteris:enable:Enableordisableaudioencode_type:Encodetypesamplerate:Sampleratebitrate:Bitrateinput_volume:Inputvolumeoutput_volume:Outputvolumeamplify:Enableordisableaudioamplifier400/cgi-bin/audioencoderenable:0or1参数enable错误(其他参数的错误提示类似,不重复解释)Parameterenableerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)3.
13OSD3.
13OSD/cgi-bin/osduid=XXXXXXXX/cgi-bin/osdenable=0&uid=XXXXXXXX/cgi-bin/osdenable=1&uid=XXXXXXXX/cgi-bin/osdtitle_utf8=XXXXXXXX&uid=XXXXXXXX/cgi-bin/osdenable=1&color=1&fontsize=1&title_pos_type=1&title_pos_x=1&title_pos_y=0&shIPCHTTPCGI说明书ver1.
0.
024ow_res_bit=0&time_pos_type=1&time_pos_x=1&time_pos_y=0&show_week=1&time_format=yyyy-mm-dd_hh:mm:ss&title_utf8=XXXXXXXX&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
enable选项(Option):011启用OSD,0禁用OSD1EnableOSD,0DisableOSDcolor选项(Option):0123OSD颜色,0黑色字白色背景,1白色字黑色背景,2黑字白框透明背景,3白字黑框透明背景OSDcolor.
0Blacktextonwhitebackground,1Whitetextonblackbackground,2Blacktextwhiteborderontransparentbackground,3Whitetextblackborderontransparentbackgroundfontsize选项(Option):012字体尺寸,0小,1中,2大Fontsize.
0Small,1Medium,2Largetitle_pos_type选项(Option):01标题位置类型,0方向,1坐标Titlepositiontype.
0Direction,1Coordinatetitle_pos_x数字Numbers标题x轴位置,title_pos_type=0时取值0至2,title_pos_type=1时取值0至100Titlex-axisposition.
Values0to2fortitle_pos_type=0and0to100fortitle_pos_type=1title_pos_y数字Numbers标题y轴位置,title_pos_type=0时取值0至2,title_pos_type=1时取值0至100Titley-axisposition.
Values0to2fortitle_pos_type=0and0to100fortitle_pos_type=1show_res_bit选项(Option):01230不显示分辨率和码率,1显示分辨率不显示码率,2显示码率不显示分辨率,3显示分辨率和码率0doesnotdisplayresolutionandcoderate,1displayresolutiondoesnotdisplaycoderate,2displaycoderatedoesnotdisplayresolution,3displayresolutionandcoderate.
time_pos_type选项(Option):01时间位置类型,0方向,1坐标Timepositiontype.
0Direction,1Coordinatetime_pos_x数字Numbers时间x轴位置,time_pos_type=0时取值0至2,time_pos_type=1时取值0至100IPCHTTPCGI说明书ver1.
0.
025Timex-axisposition.
Values0to2fortime_pos_type=0and0to100fortime_pos_type=1time_pos_y数字Numbers时间y轴位置,time_pos_type=0时取值0至2,time_pos_type=1时取值0至100Timey-axisposition.
Values0to2fortime_pos_type=0and0to100fortime_pos_type=1show_week选项(Option):011显示星期,0不显示星期1showstheweek,0doesnotshowtheweektime_format选项(Option):yyyy-mm-dd_hh:mm:ssyyyy/mm/dd_hh:mm:ssyy-mm-dd_hh:mm:ssyy/mm/dd_hh:mm:sshh:mm:ss_dd/mm/yyyyhh:mm:ss_dd-mm-yyyyhh:mm:ss_mm/dd/yyyyhh:mm:ss_mm-dd-yyyymm/dd/yyyy_hh:mm:ssmm-dd-yyyy_hh:mm:ss时间格式由于CGIURL不能包含空格字符'',所以在设置参数时把时间格式的空格换成了下划线'_',而响应消息的报文中保留的时间格式的空格字符.
比如设置参数时yyyy-mm-dd_hh:mm:ss响应消息报文中yyyy-mm-ddhh:mm:ssTimeformatBecausetheCGIURLcannotcontainthespacecharacter'',thetimeformatspaceisreplacedbytheunderscore'_'whensettingtheparameters,andthespacecharactersinthetimeformatreservedintheresponsemessage'smessage.
Forexample,whensettingparameters:yyyy-mm-dd_hh:mm:ssResponsemessageparameters:yyyy-mm-ddhh:mm:sstitle_utf8标题内容按照HTTPURL的规范,如果title_utf8的值都是字母和数字则不需要转换,如果包含其他字符则需要转换为utf8编码的字符串.
例如:ipcameratitle_utf8=ipcamera你好title_utf8=%E4%BD%A0%E5%A5%BD你好ipcameratitle_utf8=%E4%BD%A0%E5%A5%BDipcameraTitlecontentThetitle_utf8parameterspecification:accordingtotheHTTPURLspecification,ifthevalueoftitle_utf8isbothalphanumericandthenumberdoesnotneedtobeconverted,ifitcontainsothercharacters,itneedstobeconvertedtoautf8encodedstring.
Forexample:ipcameraIPCHTTPCGI说明书ver1.
0.
026title_utf8=ipcamera你好title_utf8=%E4%BD%A0%E5%A5%BD你好ipcameratitle_utf8=%E4%BD%A0%E5%A5%BDipcamera响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:enable:启用或禁用OSDcolor:颜色fontsize:字体尺寸title_pos_type:标题位置类型title_pos_x:标题x轴位置title_pos_y:标题y轴位置show_res_bit:是否显示分辨率和码率time_pos_type:时间位置类型time_pos_x:时间x轴位置time_pos_y:时间y轴位置show_week:是否显示星期time_format:时间格式title_utf8:标题内容Therequestwassuccessful.
Thevalueoftheparameteris:enable:EnableordisableOSDcolor:Colorfontsize:Fontsizetitle_pos_type:Titlepositiontypetitle_pos_x:Titlex-axispositiontitle_pos_y:Titley-axispositionshow_res_bit:Whethertodisplaytheresolutionandbitratetime_pos_type:Timepositiontypetime_pos_x:Timex-axispositiontime_pos_y:Timey-axispositionshow_week:Whethertoshowtheweektime_format:TimeformatIPCHTTPCGI说明书ver1.
0.
027title_utf8:Titlecontent400/cgi-bin/osdenable:0or1参数enable错误(其他参数的错误提示类似,不重复解释)Parameterenableerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)3.
14图像3.
14Image/cgi-bin/imageuid=XXXXXXXX/cgi-bin/imagebrightness=128&contrast=128&saturation=128&sharpness=128&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
brightness数字0至255Numbersfrom0to255亮度Brightnesscontrast数字0至255Numbersfrom0to255对比度Contrastsaturation数字0至255Numbersfrom0to255饱和度Saturationsharpness数字0至255Numbersfrom0to255锐度Sharpness响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:IPCHTTPCGI说明书ver1.
0.
028brightness:亮度contrast:对比度saturation:饱和度sharpness:锐度Therequestwassuccessful.
Thevalueoftheparameteris:brightness:Brightnesscontrast:Contrastsaturation:Saturationsharpness:Sharpness400/cgi-bin/imagebrightnessrange:0-255参数brightness错误(其他参数的错误提示类似,不重复解释)Parameterbrightnesserror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)3.
15PTZ控制3.
15PTZ停止(stop)/cgi-bin/ptz_ctrlstop=1&uid=XXXXXXXX左(left)/cgi-bin/ptz_ctrlmove_x=-1&move_y=0&speed=5&uid=XXXXXXXX右(rifht)/cgi-bin/ptz_ctrlmove_x=1&move_y=0&speed=5&uid=XXXXXXXX上(up)/cgi-bin/ptz_ctrlmove_x=0&move_y=1&speed=5&uid=XXXXXXXX下(down)/cgi-bin/ptz_ctrlmove_x=0&move_y=-1&speed=5&uid=XXXXXXXX左上(upperleft)/cgi-bin/ptz_ctrlmove_x=-1&move_y=1&speed=5&uid=XXXXXXXX左下(lowerleft)/cgi-bin/ptz_ctrlmove_x=-1&move_y=-1&speed=5&uid=XXXXXXXX右上(upperright)/cgi-bin/ptz_ctrlmove_x=1&move_y=1&speed=5&uid=XXXXXXXX右下(lowerright)/cgi-bin/ptz_ctrlmove_x=1&move_y=-1&speed=5&uid=XXXXXXXX放大(zoomnarrow)/cgi-bin/ptz_ctrlzoom=1&uid=XXXXXXXXIPCHTTPCGI说明书ver1.
0.
029缩小(zoomwide)/cgi-bin/ptz_ctrlzoom=-1&uid=XXXXXXXX近焦(focusnear)/cgi-bin/ptz_ctrlfocus=1&uid=XXXXXXXX远焦(focusfar)/cgi-bin/ptz_ctrlfocus=-1&uid=XXXXXXXX光圈变大(irisopen)/cgi-bin/ptz_ctrliris=1&uid=XXXXXXXX光圈变小(irisclose)/cgi-bin/ptz_ctrliris=-1&uid=XXXXXXXX调用预置点(callpreset)/cgi-bin/ptz_ctrlcall_preset=1&uid=XXXXXXXX添加预置点(addpreset)/cgi-bin/ptz_ctrladd_preset=1&uid=XXXXXXXX删除预置点(deletepreset)/cgi-bin/ptz_ctrldelete_preset=1&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
speed数字1至10Numbersfrom1to10速度Speed其他参数不列举,按照上文列举的URL使用Otherparametersarenotlisted,accordingtotheURLlistedabove响应的报文Responsemessage状态码Statuscode内容Content描述Description200true请求成功.
Therequestwassuccessful.
400/cgi-bin/ptz_ctrlmove_xrange:-1,0,1参数move_x错误(其他参数的错误提示类似,不重复解释)Parametermove_xerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)IPCHTTPCGI说明书ver1.
0.
0303.
16移动侦测配置3.
16MotionDetectconfiguration/cgi-bin/motionuid=XXXXXXXX/cgi-bin/motionenable=0&uid=XXXXXXXX/cgi-bin/motionenable=1&uid=XXXXXXXX/cgi-bin/motionenable=1&blockcount=22x18&areavalue=XXXXXXXX&uid=XXXXXXXX/cgi-bin/motionenable=1&sensitivity=80&alarmthreshold=20&enable_nighttime=1&night_sensitivity=80&night_alarmthreshold=20&blockcount=22x18&areavalue=XXXXXXXX&uid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
enable选项(Option)10移动侦测使能1启动移动侦测0关闭移动侦测Motiondetectionenable1Startmotiondetection0Turnoffmotiondetection.
sensitivity数字1至100灵敏度sensitivityalarmthreshold数字1至100报警门限值alarmthreshold.
enable_nighttime选项(Option)10夜间参数使能1启用夜间参数0停用夜间参数夜间参数包括:night_sensitivity,night_alarmthreshold.
Nightparameterenable1Enablenighttimeparameters0Disablenighttimeparameters.
Nightparametersinclude:night_sensitivity,night_alarmthreshold.
night_sensitivity数字1至100夜间灵敏度Nightsensitivitynight_alarmthreshold数字1至100夜间报警门限值NightalarmthresholdIPCHTTPCGI说明书ver1.
0.
031blockcount字符串行块数x列块数移动侦测的区域块数Numberofareablocksformotiondetectionareavalue移动侦测区域值说明:区域块数从左往右每8块按位填充到一个字节里面,多余位填充0(1代表被选中块,0代表没有被选中块),并对这些字节进行16进制字符串的编码,就是最终的移动侦测区域值.
例如:4x4的区域全部选中,移动侦测区域值为:ffff,全部不选中,则为0000.
MotiondetectionareavalueDescription:Each8blocksfromlefttorightarefilledinabytebitbybit,andtheextrabitisfilledin0(1representstheselectedblock,0representstheunselectedblock),andthesebytesareencodedinahexadecimalstring,whichisthefinalvalueofthemobiledetectionregion.
Forexample:All4x4areasareselected,themotiondetectionareavalueis:ffff,andallareunchecked,itis0000.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200请求成功.
参数的值是:enable:启用或禁用移动侦测sensitivity:灵敏度alarmthreshold:报警门限值enable_nighttime:启用或停用夜间参数night_sensitivity:夜间灵敏度night_alarmthreshold:夜间报警门限值blockcount:移动侦测的区域块数areavalue:移动侦测区域值IPCHTTPCGI说明书ver1.
0.
032400/cgi-bin/motionenable:0or1参数enable错误(其他参数的错误提示类似,不重复解释)Parameterenableerror(Otherparameterssimilartothewrongtipsdonotrepeattheexplanation)IPCHTTPCGI说明书ver1.
0.
0333.
17获取设备型号(OEM)3.
17ObtainEquipmentModel/cgi-bin/getmodeluid=XXXXXXXX参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
响应的报文Responsemessage状态码Statuscode内容Content描述Description200MC200J6假设是MC200J6型号进行操作并请求成功.
model:OEM设备型号MC200J6SupposetheMC200J6modeloperatesandrequestssuccess.
model:OEMEquipmenttype:MC200J6IPCHTTPCGI说明书ver1.
0.
0343.
18用户管理3.
18UserManagement/cgi-bin/user_managementaction=add&name=XXXX&newpasswd=XXX&privilege=User&enable=Enable&uid=XXXXXX/cgi-bin/user_managementaction=delete&name=XXXX&uid=XXXXXX/cgi-bin/user_managementaction=edit&name=XXXX&newpasswd=XXX&privilege=User&enable=Disable&uid=XXXXXX/cgi-bin/user_managementaction=edit&name=XXXX&newpasswd=XXX&uid=XXXXXX/cgi-bin/user_managementaction=get_user&uid=XXXXXX1.
使用get_user指令可以获取当前设备中的所有的用户的XML信息.
用户管理即是权限管理.
2.
普通用户User:只能查看IPC的配置,不能修改配置的用户.
3.
操作用户Operator:拥有除了用户管理外的所有权限4.
管理员用户Administrator:拥有IPC的所有的权限除了相关操作的用户名和密码之外的参数-add方法要求:name、newpasswd、privilege、enable-delete方法要求:name-edit方法要求:name-edit方法可选:newpasswd、privilege、enable1.
Theget_userinstructioncanbeusedtoobtaintheXMLinformationofallusersinthecurrentdevice.
Usermanagementisauthoritymanagement.
2.
OrdinaryUser:UserwhocanonlyviewtheconfigurationofIPC,cannotmodifytheconfiguration.
3.
OperatorforOperator:Allrightsexceptusermanagement4.
Administrator:HasallthepermissionsofIPCParametersinadditiontousernameandpasswordfortheassociatedaction-AddRequires:name,password,privilege,enable-DeleteRequires:name-EditRequires:name-EditOptional:password,privilege,enable参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
TheidpassedthroughtheIPCHTTPCGI说明书ver1.
0.
035/cgi-bin/getuidinterface.
action(must)1:add2:delete3:edit4:get_user1、add是添加用户操作2、delete是删除用户操作3、edit是编辑用户操作4、get_user是获取用户所有的XML1.
Addistoadduseractions2.
deleteisadeleteuseroperation3.
Editisanedituseroperation4.
get_useristogetalltheuser'sXMLname(must)字符串Char*用户名PS:最大允许40个字节的长度.
UsernamePS:Maximumallowablelengthof40bytes.
newpasswd字符串Char*Password:Toedittheuser'spasswordprivilege字符串Char*1、User2、Administrator3、Operator权限问题:1.
User只能查看配置,不能修改配置2.
Administrator拥有所有权限3.
Operator拥有除了用户管理外的所有权限1.
UserConfigurationcanonlybeviewed,butconfigurationcannotbemodified.
2.
AdministratorOwnership3.
OperatorHaveallrightsexceptusermanagementenable字符串Char*1、Enable2、DisableEnable:使能用户Disable:失能用户Enable:enablingusersDisable:DisabledUsers响应的报文Responsemessage状态码Statuscode内容Content描述Description200OK请求成功.
参数user_management显示为OKIPCHTTPCGI说明书ver1.
0.
036400/cgi-bin/user_managementaction:addoreditordeleteaction参数不是addoreditordelete报错Theparameterisnotaddoreditordeleteanerror.
400/cgi-bin/user_managementerrorusernamedelete参数输入的用户名不存在的时候上报此错误.
(不能够删除不存在的用户)Reportthiserrorwhentheusernameenteredbytheparameterdoesnotexist.
(Can'tdeletenon-existentusers)400/cgi-bin/user_managementerrorusernameduplicatedadd参数输入相同的用户名的时候上报此错误.
(不能够创建已经存在的用户)Reportthiserrorwhentheusernameenteredbytheparameterisexist.
(unabletocreateexistingusers)400/cgi-bin/user_managementusernamenoneexisttoeditedit参数输入不同的用户名的时候上报错误.
(不能够编辑不存在的用户)Reportthiserrorwhentheusernameenteredbytheparameterdoesnotexist.
(unabletoeditnon-existentusers)400/cgi-bin/user_managementprivilege:UserorAdministratororOperatorPrivilege参数输入错误,需要输入UserorAdministratororOperatorPrivilegeparameterinputerror,needtoenterUserorAdministratororOperator400/cgi-bin/user_managementenable:EnableorDisableenable参数输入错误,需要输入EnableorDisableenableparameterinputerror,needtoenterEnableorDisable400/cgi-bin/user_managementTheparametersmustCorrectincludename,newpasswd,privilege,enableAdd方法参数缺少错误,需要输入全部4个的所有参数才能创建新用户.
TheAddparameterismissingerrors,andallfourparametersneedtobeenteredtocreateanewuser.
400用户权限不是管理员,无法进行用户管理配置项.
IPCHTTPCGI说明书ver1.
0.
037/cgi-bin/user_managementNon-administratorscannoteditusersUserprivilegesarenotadministrators.
Usermanagementconfigurationitemscannotbemodified.
400/cgi-bin/user_managementusernamenotexisttoedit登录用户不存在Loginuserdoesnotexist3.
19抓图上传3.
19snapshotupload/cgi-bin/snapshot.
cgi&username=XXXXXX&password=XXXXXX/cgi-bin/snapshot.
cgistream=0&username=XXXXXX&password=XXXXXX/cgi-bin/snapshot.
cgistream=0&upload=0&username=XXXXXX&password=XXXXXX/cgi-bin/snapshot.
cgistream=1&upload=1&username=XXXXXX&password=XXXXXX1、开启onvif认证之后,就需要输入username参数和password参数.
2、缺省stream参数后,跟着username的一定要使用&,否则上报错误.
3、缺省stream参数后,默认为stream0.
4、缺省upload参数后,不上报错误.
1.
Aftertheonvifauthenticationisenabled,youneedtoentertheusernameparameterandpasswordparameter.
2.
Afterthedefaultstreamparameter,followtheusername'stouse&,otherwise,reporttheerror.
3.
Afterthedefaultstreamparameter,thedefaultvalueisstream0.
4.
Afterthedefaultuploadparameter,noerrorisreported.
参数名称Parametername参数值Parametervalue描述Descriptionuid会话的用户id,通过/cgi-bin/getuid接口得到的idUseridforthesession.
Theidpassedthroughthe/cgi-bin/getuidinterface.
stream(must)数字0-1Number0-1参数值为0代表:子码流抓图参数值为1代表:主码流抓图Parametervalueof0represents:subcodestreamsnapshotTheparametervalueof1represents:MasterIPCHTTPCGI说明书ver1.
0.
038bitstreamsnapshotupload(optional)数字0-3Number0-3参数值为0代表:抓图后上传到SD卡参数值为1代表:抓图后上传到FTP参数值为2代表:抓图后上传到Email参数值为3代表:抓图后上传到远程的NFS服务器Parametervalueis0:uploadtoSDcardaftercapturingparametervalueis1,whichmeans:uploadtoFTPaftercapturingParametervalueis2:uploadtoemailaftercapturingParametervalueis3:uploadtoremoteNFSserveraftersnapshot响应的报文Responsemessage状态码Statuscode内容Content描述Description200OK请求成功.
参数的值是:提示抓图完全并上传成功Therequestsucceeded.
Thevalueoftheparameteris:Successfulupload400/cgi-bin/snapshotsdnotmountSD卡没有插入或者SD卡没有部署成功.
TheSDcardwasnotinsertedordeployedsuccessfully.
400/cgi-bin/snapshotupload0or1or2or3Upload的参数不是0-3的数值就会上报此错误.
ThiserrorwillbereportediftheparameterofUploadisnot0-3.
400/cgi-bin/snapshotFtpnotdeployFTP的服务器没有部署FTPserversarenotdeployed.
IPCHTTPCGI说明书ver1.
0.
039400/cgi-bin/snapshotsdcardnotmountedSD卡没有插入,或者SD卡损坏,或者没有部署.
TheSDcardisnotinserted,damagedordeployed.
400/cgi-bin/snapshotNFSServernotmountedNFS没有挂载NFSServernotmounted3.
20固件升级3.
20UpgradeFirmware详细的信息请查看upload.
html文档.
JS使用异步的调用方式:1.
2.
3.
4.
IPCamera5.
6.
7.