視頻監(jiān)控系統(tǒng)運(yùn)維技術(shù)規(guī)范 第2部分：接口

1視頻監(jiān)控系統(tǒng)運(yùn)維技術(shù)規(guī)范第2部分：接口本文件規(guī)定了視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)的接口分類與協(xié)議結(jié)構(gòu)、接口功能、接口資源描述、接口消息、關(guān)鍵消息交互流程等技術(shù)要求。本文件適用于地方視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)的規(guī)劃設(shè)計(jì)、軟件開發(fā)及接口協(xié)議的符合性測試。2規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，僅該日期對(duì)應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T28181公共安全視頻監(jiān)控聯(lián)網(wǎng)系統(tǒng)消息傳輸、交換、控制技術(shù)要求GA/T1400.4公安視頻圖像信息應(yīng)用系統(tǒng)第4部分：接口協(xié)議要求3術(shù)語和定義GB/T28181、GA/T1400.4、DB3502/TXXX-XXXX界定的以及下列術(shù)語和定義適用于本文件。3.1行業(yè)視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)operationandmaintenancemanagementplatformofindustryvideosurveillancesystem用于各行業(yè)視頻監(jiān)控系統(tǒng)中的設(shè)備、鏈路和軟件運(yùn)行狀態(tài)以及視頻圖像質(zhì)量等進(jìn)行監(jiān)測，發(fā)現(xiàn)故障、跟蹤處理情況，展現(xiàn)運(yùn)維結(jié)果，提高運(yùn)維效能和質(zhì)量的硬件和軟件。4縮略語下列縮略語適用于本文件。REST:表述性狀態(tài)傳遞（RepresentationalStateTransfer）SNMP:簡單網(wǎng)絡(luò)管理協(xié)議（SimpleNetworkManagementProtocol）URI：統(tǒng)一資源標(biāo)識(shí)符(UniformResourceIdentifier)5接口分類與協(xié)議結(jié)構(gòu)5.1接口分類視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)接口為運(yùn)維平臺(tái)和各應(yīng)用系統(tǒng)的對(duì)接接口。一機(jī)一檔作為監(jiān)控聯(lián)網(wǎng)系統(tǒng)資源匯聚中心，提供統(tǒng)一設(shè)備開放接口，各類接口交互實(shí)體關(guān)系見圖1，接口分類說明如下：2——運(yùn)維系統(tǒng)對(duì)接接口用于視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)和本級(jí)一機(jī)一檔管理系統(tǒng)、下級(jí)視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)、電箱系統(tǒng)及其他應(yīng)用系統(tǒng)之間的數(shù)據(jù)交互；——統(tǒng)一運(yùn)維對(duì)象開放接口用于一機(jī)一檔管理系統(tǒng)和視頻監(jiān)控系統(tǒng)運(yùn)維管理平臺(tái)、電箱系統(tǒng)及其他應(yīng)用系統(tǒng)之間的數(shù)據(jù)交換。圖1接口交互實(shí)體關(guān)系圖5.2協(xié)議結(jié)構(gòu)5.2.1所有接口交互信息定義為REST架構(gòu)下的資源，使用URI唯一標(biāo)識(shí)。5.2.2接口交互連接方式應(yīng)支持HTTP長連接和短連接，實(shí)現(xiàn)機(jī)制應(yīng)符合IETFRFC2616中的相關(guān)規(guī)定。5.2.3應(yīng)用系統(tǒng)接口訪問形式應(yīng)符合附錄A中的A.3。6接口功能6.1公共功能6.1.1功能要求應(yīng)用系統(tǒng)對(duì)接運(yùn)維平臺(tái)應(yīng)支持注冊(cè)、心跳、告警通知、狀態(tài)訂閱、狀態(tài)訂閱通知等公共功能。專有設(shè)備管理系統(tǒng)對(duì)接運(yùn)維平臺(tái)，應(yīng)支持公共功能。其中：——注冊(cè)失敗時(shí)，應(yīng)延遲300s內(nèi)的隨機(jī)時(shí)間后重新注冊(cè)；——注冊(cè)成功后，在10秒內(nèi)未交互信息則進(jìn)行心跳?；?；——應(yīng)用系統(tǒng)匯聚本系統(tǒng)相關(guān)的服務(wù)器、服務(wù)實(shí)例、子系統(tǒng)的異常告警及前端設(shè)備告警，應(yīng)上報(bào)運(yùn)維平臺(tái)。6.1.2告警3應(yīng)用系統(tǒng)作為各應(yīng)用的運(yùn)維節(jié)點(diǎn)，匯聚對(duì)接應(yīng)用系統(tǒng)的告警異常，應(yīng)對(duì)通用應(yīng)用服務(wù)異常告警進(jìn)行抽象定義，本文件定義部分通用告警類型：——應(yīng)用系統(tǒng)代理多個(gè)子系統(tǒng)時(shí)，各子系統(tǒng)對(duì)告警類型定義不完全一致情況下，和運(yùn)維平臺(tái)對(duì)接時(shí)，應(yīng)用系統(tǒng)在保證告警碼在系統(tǒng)內(nèi)唯一的前提下，可上報(bào)自定義的告警類型；——通用告警類型見附錄B中的B.1；——告警級(jí)別見附錄B中的B.2；——告警屬性見附錄B中的B.3；——告警來源分為應(yīng)用系統(tǒng)運(yùn)維節(jié)點(diǎn)內(nèi)告警和鄰近系統(tǒng)告警。6.2專用功能6.2.1運(yùn)維系統(tǒng)對(duì)接接口對(duì)于一般應(yīng)用系統(tǒng)，應(yīng)支持服務(wù)實(shí)例維護(hù)，專有設(shè)備管理系統(tǒng)可不支持服務(wù)實(shí)例維護(hù)。應(yīng)用系統(tǒng)內(nèi)部服務(wù)進(jìn)程有變更時(shí)，應(yīng)調(diào)用服務(wù)實(shí)例增加、刪除或修改接口。宜按需提供應(yīng)用系統(tǒng)之間系統(tǒng)告警訂閱、系統(tǒng)間告警訂閱通知、系統(tǒng)間狀態(tài)訂閱及系統(tǒng)間告警訂閱通知。6.2.2電箱系統(tǒng)對(duì)接接口應(yīng)支持設(shè)備列表查詢功能，運(yùn)維系統(tǒng)通過接口查詢電箱系統(tǒng)關(guān)聯(lián)的電箱列表，和一機(jī)一檔設(shè)備信息進(jìn)行比對(duì)分析，查找是否存在設(shè)備沖突。應(yīng)支持電箱控制功能，對(duì)電箱系統(tǒng)管理的電箱進(jìn)行重啟、開關(guān)電等操作。6.2.3統(tǒng)一運(yùn)維對(duì)象開放接口應(yīng)支持向一機(jī)一檔查詢?cè)O(shè)備信息，響應(yīng)一機(jī)一檔狀態(tài)結(jié)果通知。7接口資源描述7.1資源URI7.1.1運(yùn)維系統(tǒng)資源URI見附錄C中的C.1。7.1.2應(yīng)用系統(tǒng)資源URI見附錄C中的C.2。7.1.3一機(jī)一檔資源URI見附錄C中的C.2。8接口8.1運(yùn)維系統(tǒng)對(duì)接接口8.1.1注冊(cè)交互流程注冊(cè)交互流程見圖2，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)POST發(fā)送/nms/v1/register請(qǐng)求。應(yīng)用系統(tǒng)可以是電箱系統(tǒng)、下級(jí)運(yùn)維平臺(tái)、專有設(shè)備管理系統(tǒng)等應(yīng)用系統(tǒng)；b)S2：2：運(yùn)維平臺(tái)將注冊(cè)成功與否的響應(yīng)返回給發(fā)起者。圖2注冊(cè)交互流程圖注冊(cè)功能描述注冊(cè)功能描述見表1。表1注冊(cè)功能描述表{}{}{45}在過期時(shí)間之前調(diào)用方需要重新調(diào)用register接口獲取Token值放入后續(xù)請(qǐng)求header的authorization字段中8.1.2心跳交互流程心跳交互流程見圖3，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)定時(shí)向運(yùn)維平臺(tái)POST發(fā)送/nms/v1/heartbeat/{id}請(qǐng)求；b)S2：2：運(yùn)維平臺(tái)將心跳成功與否的響應(yīng)返回給發(fā)起者。圖3心跳交互流程圖心跳功能描述心跳功能描述見表2。表2心跳功能描述表無{6}8.1.3服務(wù)實(shí)例維護(hù)交互流程服務(wù)實(shí)例維護(hù)交互流程見圖4，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)發(fā)送/nms/v1/serviceInstance增加、修改、刪除請(qǐng)求；b)S2：2：運(yùn)維平臺(tái)將操作成功與否的響應(yīng)返回給發(fā)起者。圖4服務(wù)實(shí)例維護(hù)交互流程圖增加服務(wù)實(shí)例功能描述增加服務(wù)實(shí)例功能描述見表3。表3增加服務(wù)實(shí)例功能描述表"subsystemId":"adfad7{"subsystemId":"adfad}修改服務(wù)實(shí)例功能描述修改服務(wù)實(shí)例功能描述見表4。表4修改服務(wù)實(shí)例功能描述表修改服務(wù)實(shí)例，只允許修改hardwareID、subsystemI"subsystemId":"adfad8{}刪除服務(wù)實(shí)例功能描述刪除服務(wù)實(shí)例功能描述描述表見表5。表5刪除服務(wù)實(shí)例功能描述表/nms/v1/serviceInstan{}"xxxxxxxx"8.1.4告警通知交互流程告警通知交互流程見圖5，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)發(fā)送/nms/v1/alarm告警通知；b)S2：2：運(yùn)維平臺(tái)將操作成功與否的響應(yīng)返回給發(fā)起者。9圖5告警通知交互流程圖告警通知功能描述告警通知功能描述見表6。表6告警通知功能描述表{}{}"xxxxxxxx"8.1.5狀態(tài)訂閱交互流程狀態(tài)訂閱交互流程見圖6，信令流程描述如下：a)S1：1：運(yùn)維平臺(tái)向應(yīng)用系統(tǒng)向發(fā)送/subsystem/v1/subscirbe訂閱請(qǐng)求；b)S2：2：應(yīng)用系統(tǒng)將操作成功與否的響應(yīng)返回給運(yùn)維平臺(tái)。圖6狀態(tài)訂閱交互流程圖狀態(tài)訂閱功能描述狀態(tài)訂閱功能描述見表7。表7狀態(tài)訂閱功能描述表{"notifyURI":"http://ip:port/xxxx}{}8.1.6狀態(tài)訂閱通知交互流程狀態(tài)訂閱交互流程見圖7，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)發(fā)送運(yùn)維平臺(tái)自定義狀態(tài)通知接口請(qǐng)求，實(shí)時(shí)通知應(yīng)用系統(tǒng)狀態(tài)，包括應(yīng)用系統(tǒng)關(guān)聯(lián)的服務(wù)器、服務(wù)實(shí)例或管理設(shè)備的狀態(tài)；b)S2：2：運(yùn)維系統(tǒng)將操作成功與否的響應(yīng)返回給應(yīng)用系統(tǒng)。圖7狀態(tài)訂閱交互流程圖狀態(tài)訂閱通知功能描述狀態(tài)訂閱通知功能描述表見表8。表8狀態(tài)訂閱通知功能描述表"notifyURI":"http://ip:port/xxxx{}8.1.7系統(tǒng)間告警訂閱交互流程系統(tǒng)間告警訂閱交互流程見圖8，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)發(fā)送運(yùn)維平臺(tái)/nms/v1/subscirbe/alarm請(qǐng)求；b)S2：2：運(yùn)維系統(tǒng)將操作成功與否的響應(yīng)返回給應(yīng)用系統(tǒng)。圖8系統(tǒng)間告警訂閱交互流程圖系統(tǒng)間告警訂閱功能描述系統(tǒng)間告警訂閱功能描述見表9。表9系統(tǒng)間告警訂閱功能描述表{"notifyURI":"http://ip:port/xxxx}{}8.1.8系統(tǒng)間告警訂閱通知交互流程系統(tǒng)間告警訂閱交互流程見圖9，信令流程描述如下：a)S1：1：運(yùn)維平臺(tái)向應(yīng)用系統(tǒng)發(fā)送應(yīng)用系統(tǒng)自定義訂閱通知請(qǐng)求；b)S2：2：應(yīng)用系統(tǒng)將操作成功與否的響應(yīng)返回給運(yùn)維平臺(tái)。圖9系統(tǒng)間告警訂閱交互流程圖系統(tǒng)間告警訂閱通知功能描述系統(tǒng)間告警訂閱通知功能描述見表10。表10系統(tǒng)間告警訂閱通知功能描述表"notifyURI":"http://ip:port/xxxx{}{}8.1.9系統(tǒng)間狀態(tài)訂閱交互流程系統(tǒng)間狀態(tài)訂閱交互流程見圖10，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向運(yùn)維平臺(tái)發(fā)送運(yùn)維平臺(tái)/nms/v1/subscribe/status請(qǐng)求；b)S2：2：運(yùn)維系統(tǒng)將操作成功與否的響應(yīng)返回給應(yīng)用系統(tǒng)。圖10系統(tǒng)間狀態(tài)訂閱交互流程圖系統(tǒng)間狀態(tài)訂閱功能描述系統(tǒng)間狀態(tài)訂閱功能描述見表11。系統(tǒng)間狀態(tài)訂閱功能描述表{"notifyUrl":"http://ip:port/xxxx}），{}8.1.10系統(tǒng)間狀態(tài)訂閱通知交互流程系統(tǒng)間告警訂閱交互流程見圖11，信令流程描述如下：a)S1：1：運(yùn)維平臺(tái)向應(yīng)用系統(tǒng)發(fā)送應(yīng)用系統(tǒng)自定義訂閱通知請(qǐng)求；b)S2：2：應(yīng)用系統(tǒng)將操作成功與否的響應(yīng)返回給運(yùn)維平臺(tái)。圖11系統(tǒng)間告警訂閱交互流程圖系統(tǒng)間狀態(tài)訂閱通知功能描述系統(tǒng)間狀態(tài)訂閱通知功能描述見表12。表12系統(tǒng)間狀態(tài)訂閱通知功能描述表"notifyUrl":"http://ip:port/xxxx{}8.2電箱系統(tǒng)對(duì)接接口8.2.1設(shè)備列表查詢交互流程設(shè)備列表查詢交互流程見圖12，信令流程描述如下：a)S1：1：運(yùn)維平臺(tái)向電箱系統(tǒng)發(fā)送/subsystem/v1/device-list請(qǐng)求；b)S2：2：電箱系統(tǒng)將操作成功與否的響應(yīng)返回給運(yùn)維平臺(tái)。圖12設(shè)備列表查詢交互流程圖設(shè)備列表查詢功能描述設(shè)備列表查詢功能描述見表13。表13設(shè)備列表查詢功能描述表/subsystem/v1/device-list?pagenum=1&pagesi無{"id":"c798deacbf82496d9531e"softwareVersion":"v"id":"e7ed2213017c4326be777"ip":"2"}}8.2.2電箱控制交互流程電箱控制交互流程見圖13，信令流程描述如下：a)S1：1：運(yùn)維平臺(tái)向電箱系統(tǒng)發(fā)送/subsystem/v1/device/{id}請(qǐng)求；b)S2：2：電箱系統(tǒng)將操作成功與否的響應(yīng)返回給運(yùn)維平臺(tái)。圖13電箱控制交互流程圖電箱控制功能描述電箱控制功能描述見表14。表14電箱控制功能描述表{}{}8.3統(tǒng)一運(yùn)維對(duì)象開放接口8.3.1查詢?cè)O(shè)備信息交互流程統(tǒng)一設(shè)備開放接口交互流程見圖14，信令流程描述如下：a)S1：1：應(yīng)用系統(tǒng)向一機(jī)一檔發(fā)送/kiop-gateway-core/現(xiàn)場網(wǎng)關(guān)/queryDeviceInfo請(qǐng)求；b)S2：2：一機(jī)一檔將操作成功與否的響應(yīng)返回給應(yīng)用系統(tǒng)。圖14統(tǒng)一設(shè)備開放接口交互流程圖查詢?cè)O(shè)備信息功能描述查詢?cè)O(shè)備信息功能描述見表15。表15查詢?cè)O(shè)備信息功能描述表/kiop-gateway-core/現(xiàn)場網(wǎng)關(guān)/queryDe{}{"f_eq_deviceAttr.ipc.securityboxId":'db9b47bedab747c0a249"f_in_civilCode":"35"f_not_gbid"："350200000}(1)f_eq_deviceAttr.ipc.securityboxId……wheredeviceAttr.ipc.securityboxId='db9b47bedab747c……wherenamelike'%測試……wheregbid!='35注：deviceAttr.ipc.securityboxId字段是網(wǎng)絡(luò)攝像機(jī)（視圖傳感器）設(shè)備類型的私有字中的ipc為該設(shè)備類型標(biāo)識(shí)的toLowerCase()形式。所有以deviceAttr開頭的字段均為某個(gè)指定設(shè)備類型的私有字段，deviceAttr后面跟著的就是該設(shè)備類型的標(biāo)識(shí)的全小{}}}}放在deviceAttr中的為設(shè)備私有屬性，ipc為網(wǎng)絡(luò)攝像機(jī)（視圖傳感器）的設(shè)備類型標(biāo)識(shí)8.3.2狀態(tài)結(jié)果通知交互流程狀態(tài)結(jié)果通知交互流程見圖15，信令流程描述如下：a)S1：1：一機(jī)一檔向應(yīng)用系統(tǒng)發(fā)送狀態(tài)通知請(qǐng)求，URI由一機(jī)一檔配置；b)S2：2：應(yīng)用系統(tǒng)將操作成功與否的響應(yīng)返回給一機(jī)一檔。圖15狀態(tài)結(jié)果通知交互流程圖狀態(tài)結(jié)果通知功能描述狀態(tài)結(jié)果通知功能描述見表16。表16狀態(tài)結(jié)果通知功能描述表{"id":"fcf9e2f27e8d4defa3a0b}(R)deviceMsgs.status：狀態(tài)（0:在用/在線；{}（資料性）REST架構(gòu)協(xié)議模型A.1REST概述REST是一種通過采用統(tǒng)一方式將所有信息抽象為資源來創(chuàng)建服務(wù)的方法，任何能夠被命名的信息都能夠作為一個(gè)資源。REST使用一個(gè)資源標(biāo)識(shí)符（URI）來標(biāo)識(shí)組件之間交互所涉及到的特定資源。REST組件通過以下方式在一個(gè)資源上執(zhí)行動(dòng)作：使用一個(gè)資源表述來捕獲資源的當(dāng)前或預(yù)期的狀態(tài)、在組件之間傳遞該表述，一個(gè)表述是一個(gè)字節(jié)序列，以及描述這些字節(jié)序列的表述元數(shù)據(jù)。A.2REST和HTTP方法REST服務(wù)通過HTTP的方法動(dòng)詞來實(shí)現(xiàn)，見表A.1。說明如下：a)GET調(diào)用不能改變系統(tǒng)狀態(tài)，這表示該調(diào)用只返回?cái)?shù)據(jù)給請(qǐng)求者而不會(huì)產(chǎn)生任何副作用；b)POST只能用于添加原先不存在的資源的場合；c)PUT一般用于更新已經(jīng)存在資源的場合，但如果指定的資源不存在，也可以創(chuàng)建該資源。表A.1HTTP方法動(dòng)詞表A.3接口訪問形式HTTPURL格式的一般形式為：<Protocol>://<Hostname>:<Port><URI>(?P1=v1&p2=v2...&pn=vn)。其中：Protocol應(yīng)支持HTTP，宜支持HTTPS；Hostname指應(yīng)用系統(tǒng)中IP設(shè)備的主機(jī)名稱、IP地址或域名；Port指端口號(hào)；URI指資源URI；(?P1=v1&p2=v2...&pn=vn)指查詢字符串，每個(gè)資源都會(huì)定義需要的或可選的查詢字符串參數(shù)，查詢字符串參數(shù)以名字/值對(duì)形式出現(xiàn)。A.4REST和HTTP相應(yīng)狀態(tài)碼REST和HTTP響應(yīng)狀態(tài)碼見表A.2。表A.2REST和HTTP響應(yīng)狀態(tài)碼表××消息體(Body)說明：響應(yīng)消息體返回一×××דFound”(找到)-所請(qǐng)求資源應(yīng)該通過該位置訪問，但實(shí)際上該資源位于דBadRequest”(壞請(qǐng)求)-請(qǐng)求消息構(gòu)建不對(duì)，這通常用于創(chuàng)建或更新一頭部(Header)說明：通過HTTP狀態(tài)頭部發(fā)送的原因說明(Reason-Phrase)消息體(Body)說明：響應(yīng)消息體可以包含更多的除頭部“原因說明”以外×××機(jī)制。通過HTTP狀態(tài)頭部發(fā)送的原因說明(Reason-