DB31T+1492-2024智能物聯(lián)　城市智聯(lián)平臺數(shù)據(jù)接口技術要求

ICS35.240CCSL79

31上 海 市 地 方 標 準DB31/T1492—2024智能物聯(lián)城市智聯(lián)平臺數(shù)據(jù)接口技術要求IntelligentIoTIntelligentIoT—Technicalrequirementsofdatainterfaceforurbandigitalserviceplatform2024070520241101上海市市場監(jiān)督管理局發(fā)布DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024目 次前言 II引言 III1圍 12范引文件 13語定義 14略語 25聯(lián)臺口本求 2接分類 2接約束 36輸求 5網傳帶寬 5網傳質量 5網可性求 5業(yè)接平時延 57用接要求 5應類用口求 6對一通接求 8對行應接求 15對一統(tǒng)接求 208接邊協(xié)通口要求 22接列表 22接交流程 23接定義 279用景邊協(xié)口要求 39應場的互程 39應場通數(shù)義 40應場業(yè)數(shù)義 40附錄A（范）數(shù)字典 41附錄B（范）行編碼則 44附錄C（料）應場景例 45參考獻 48I前 言本文件按照GB/T1.1—2020《標準化工作導則第1部分：標準化文件的結構和起草規(guī)則》的規(guī)定起草。本文件由上海市信息標準化技術委員會歸口。（（）集團IIII引 言庫（IIIIIIDB31/T1492—2024DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024智能物聯(lián)城市智聯(lián)平臺數(shù)據(jù)接口技術要求范圍本文件適用于接入城市智聯(lián)平臺的應用場景的數(shù)據(jù)接口設計與開發(fā)。（GB/T2260中華人民共和國行政區(qū)劃代碼GB7588電梯制造與安裝安全規(guī)范GB21240—2007液壓電梯制造與安裝安全規(guī)范GB7588和GB21240—2007界定的以及下列術語和定義適用于本文件。城市智聯(lián)平臺urbanintelligentIoTdigitalserviceplatform智聯(lián)平臺智能網關intelligentgateway智能終端設備intelligentenddevice通過標準協(xié)議與智能網關及智聯(lián)平臺通信的前端數(shù)據(jù)采集、識別、存儲的設備。事件event智聯(lián)平臺運行中引發(fā)業(yè)務狀態(tài)或軟硬件設備健康狀態(tài)變化的過程。云邊端協(xié)同cloud-edge-endcollaboration（（1業(yè)務影子businessshadow用來保證云邊端業(yè)務相關信息的及時性和最終一致性的一種面向業(yè)務應用的設備持久化配置。縮略語下列縮略語適用于本文件。AES：高級加密標準(AdvancedEncryptionStandard)AK/SK：訪問標識/訪問密鑰(AccessKeyId/SecretAccessKey)CA：證書頒發(fā)機構(CertificationAuthority)HAMC：哈希消息認證碼(Hash-basedMessageAuthenticationCode)HTTP：超文本傳輸協(xié)議(HypertextTransferProtocol)HTTPS：超文本傳輸安全協(xié)議(HyperTextTransferProtocoloverSecureSocketLayer)IAM：身份識別與訪問管理(IdentityandAccessManagement)IP：網際互聯(lián)協(xié)議(InternetProtocol)JSON：JavaScript對象標記(JavaScriptObjectNotation)MD5：消息摘要算法(Message-DigestAlgorithm)MQTTMessageQueuingTelemetryTransport)RESTful(RepresentationalStateTransfer)SHASecureHashAlgorithm)TCP：傳輸控制協(xié)議(TransmissionControlProtocol)TLS：傳輸層安全協(xié)議(TransportLayerSecurity)URI：統(tǒng)一資源標識符(UniformResourceIdentifier，URI)TCP：傳輸控制協(xié)議(TransmissionControlProtocol)TLS：傳輸層安全協(xié)議(TransportLayerSecurity)URI：統(tǒng)一資源標識符(UniformResourceIdentifier，URI)5智聯(lián)平臺接口基本要求接口分類5.1.1接口關系智聯(lián)平臺接口由云邊端協(xié)同接口與應用接口組成。接口關系見圖1。2圖1接口關系圖下行、文件上傳下載等接口，規(guī)定了端與邊之間、邊與云之間的數(shù)據(jù)交互協(xié)議。C下行、文件上傳下載等接口，規(guī)定了端與邊之間、邊與云之間的數(shù)據(jù)交互協(xié)議。CCBB端應用接口包括行業(yè)應用業(yè)務相關接口，規(guī)定了智聯(lián)平臺與行業(yè)應用平臺之間的數(shù)據(jù)交互協(xié)議。GG接口約束5.2.1接口協(xié)議要求31表1網絡層級關系對應表TCP/IP網絡層次協(xié)議應用層MQTT/HTTP/HTTPSTCP/IP網絡層次協(xié)議傳輸層TCP網絡層IPMQTTMQTTRESTfulHTTP/HTTPSRESTfulIETFRFC2616string2string2表2string規(guī)則表2)字段缺省值符合表3的規(guī)定；表3字段缺省值表3)字段定義要求：包括字段名稱、數(shù)據(jù)類型、是否為可選參數(shù)、字段的注釋性描述；4類型描述string(int64)字符串表示的數(shù)字類型，受JSON中Number（2^31以上），應以字符串形式表示，如"1000000"string(byte)字符串表示的二進制數(shù)據(jù)類型，將二進制數(shù)據(jù)以Base64編碼后，以字符串形式表示，如"5Ya35Yaw"類型缺省值描述string""空字符串int32/int640數(shù)值0float0.0數(shù)值0.0boolfalse條件假objectnull空對象array[]空數(shù)組c)字符集：符合IETFRFC3629中的規(guī)定。采集個人敏感數(shù)據(jù)：采用AES256MQTT/HTTPTLSAK/SK、CA聯(lián)網系統(tǒng)傳輸帶寬應符合以下要求：100MB/s；100MB/s；聯(lián)網系統(tǒng)IP網絡傳輸質量(如傳輸時延、包丟失率、包誤差率等)應符合以下要求：400ms；ms；1×10-3（99.9%應用場景的業(yè)務數(shù)據(jù)報送智聯(lián)平臺應符合如下要求：s；RESTfuls；10s5認證與鑒權流程見圖2。發(fā)起API請求發(fā)起API請求身份認證IAM鑒權鑒權通過訪問數(shù)據(jù)服務返回數(shù)據(jù)業(yè)務接口服務（IAM）接入網關場景應用平臺認證與鑒權流程包括：HAMC認證與鑒權流程包括：HAMC401IAM401認證與鑒權算法A/S“dte“athoizaio”HAMCURI、HTTP7.1.2接口列表通用接口列表應符合表4的規(guī)定。表4通用接口列表7.1.3交互流程6分類接口編碼用途通用接口APP-COM01設置數(shù)據(jù)回調接口，用于接收準實時數(shù)據(jù)，如事件告警、設備狀態(tài)更新等APP-COM02取消數(shù)據(jù)回調接口，用于取消數(shù)據(jù)回調接口的設置設置、取消數(shù)據(jù)回調接口交互流程見圖3。HTTPS：設置回調地址HTTPS：設置回調地址回調設置結果HTTPS：取消回調地址設置取消結果各應用平臺智聯(lián)平臺圖3設置、取消數(shù)據(jù)回調接口交互流程圖設置實時數(shù)據(jù)回調接口定義應符合表5的規(guī)定。表5設置準實時數(shù)據(jù)回調接口表編號APP-COM01名稱設置數(shù)據(jù)回調接口協(xié)議HTTPS方法POSTURI/v1/app/com/callback序列化格式JSON說明用于接收準實時數(shù)據(jù)，如事件告警、設備狀態(tài)更新等，支持的類型應符合附錄A.7。回調請求超時時間為5s，超時后重試，重試5次后若仍超時則終止該接口調用。消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidcallback_urlstringN回調地址，支持HTTP/HTTPS響應codeinteger(int32)N響應碼msgstringN響應消息注：可空的取值為“N”表示此參數(shù)不可為空，為“Y”表示此參數(shù)可為空，余同。取消準實時數(shù)據(jù)回調接口定義取消準實時數(shù)據(jù)回調接口定義取消準實時數(shù)據(jù)回調接口定義應符合表6的規(guī)定。 7表6取消準實時數(shù)據(jù)回調接口表編號APP-COM02名稱取消數(shù)據(jù)回調接口協(xié)議HTTPS方法DELETEURI/v1/app/com/callback序列化格式JSON說明取消數(shù)據(jù)回調接口的設置消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuid響應codeinteger(int32)N響應碼msgstringN響應消息7.2.1接口列表表7對接一網通辦接口列表7.2.2交互流程對接一網通辦接口交互流程見圖4。87.1.1表7對接一網通辦接口列表7.2.2交互流程對接一網通辦接口交互流程見圖4。8分類接口編碼用途對接一網通辦接口APP-YWTB01上報公告數(shù)據(jù)接口，用于上報公告數(shù)據(jù)APP-YWTB02上報社區(qū)數(shù)據(jù)接口，用于上報社區(qū)數(shù)據(jù)APP-YWTB03上報業(yè)主數(shù)據(jù)接口，用于上報業(yè)主數(shù)據(jù)APP-YWTB04上報項目數(shù)據(jù)接口，用于上報項目數(shù)據(jù)對接一網通辦接口 APP-YWTB05更新項目階段接口，用于更新項目階段圖4對接一網通辦接口交互流程圖圖4對接一網通辦接口交互流程圖上報公告數(shù)據(jù)接口應符合表8的規(guī)定。表8上報公告數(shù)據(jù)接口表9智聯(lián)平臺智聯(lián)平臺一網通辦平臺HTTPS：上報公告數(shù)據(jù)接口上報結果HTTPS：上報結果HTTPS：上報結果上報結果HTTPS：更新項目階段數(shù)據(jù)接口更新結果編號APP-YWTB01名稱上報公告數(shù)據(jù)協(xié)議HTTPS方法POSTURI/v1/app/ywtb/vote/announcements序列化格式JSON說明上報公告數(shù)據(jù)，每次不宜超過100條消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuiditemsarray(Announcement)N公告列表AnnouncementDB31/T1492—2024DB31/T1492—20248（續(xù)）DB31/T1492—2024DB31/T1492—2024消息體字段名稱數(shù)據(jù)類型可空描述請求codestringN公告編號typeinteger(int32)N公告類型1:通知2:公示3:投票4:申請titlestringN公告標題announce_datestringN發(fā)布日期如:2020-12-1400:00:00expiration_datestringN有效期,格式:yyyy-MM-dd,-1為永久有效如:2020-12-14vote_start_datestringY2020-12-1400:00:00；type為3該字段有值vote_end_datestringY投票結束日期如:2020-12-1400:00:00；type為3即投票類型的公告時，該字段有值area_codestringN行政區(qū)劃編碼，應符合附錄B，如：310101002001001016areastringN/市轄區(qū)黃浦區(qū)/南京東路街道/云南中路居委會/XX小區(qū)/16號樓addressstringN地址，如：梅隴路555弄totalinteger(int32)Y應參與戶數(shù)；type為3即投票類型并且status為3(已發(fā)布)時該字段有值participantinteger(int32)Y實參與戶數(shù)；type為3即投票類型并且status為3(已發(fā)布)時該字段有值vote_house_percentstringY投票的戶數(shù)占應參與投票的戶數(shù)的百分點，四舍五入，保留兩位小數(shù)；type為3即投票類型并且status為3(已發(fā)布)時該字段有值vote_agree_house_percentstringY投票贊同的戶數(shù)占應參與投票的戶數(shù)的為3即投票類型并且status為3(已發(fā)布)時該字段有值vote_area_percentstringY投票的房屋面積占應參與投票的總面積為3即投票類型并且status為3(已發(fā)布)時該字段有值1010表8（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述請求vote_agree_area_percentstringY投票贊成的房屋面積占應參與投票的總面積的百分點,百分點，四舍五入，保留兩位小數(shù)；type為3即投票類型并且status為3(已發(fā)布)時該字段有值validstringY投票是否有效,投票的戶數(shù)和房屋面積都2/3type為3類型并且status為3(已發(fā)布)時該字段有值passedbooleanY投票是否通過,投票贊同的戶數(shù)和房屋面3/4type為3投票類型并且status為3(已發(fā)布)時該字段有值browsestringN瀏覽數(shù)feedbackstringN反饋數(shù)statusstringN公告狀態(tài)1:待審核2:待發(fā)布3:已發(fā)布4:駁回5:取消optionsarray(Option)Y投票選項統(tǒng)計,統(tǒng)計詳細信息；type為3投票類型并且status為3(已發(fā)布)時該字段有值OptiontitlestringN對”,“申請”,“棄權”等valuestringN選項的值,可以理解為該選項在數(shù)據(jù)庫中的標識personsarray(Person)N選擇該選項的用戶列表Personidinteger(int32)N用戶標識如:56room_numberstringN戶號,如:202namestringN用戶名稱,如:張*國，脫敏card_numberstringY人員身份證號碼,前六位用*代替如:******197201181637；未登記身份證號時該字段值為空，脫敏join_datestringN加入時間如:2021-02-0316:00:00vote_datestringN投票日期如:2021-01-1919:23:12響應codeinteger(int32)N響應碼msgstringN響應消息itemsarray(Result)N上傳結果，僅攜帶上傳失敗的記錄Result1111上報業(yè)主數(shù)據(jù)接口上報業(yè)主數(shù)據(jù)接口應符合表10的規(guī)定。上報業(yè)主數(shù)據(jù)接口上報業(yè)主數(shù)據(jù)接口應符合表10的規(guī)定。表10上報業(yè)主數(shù)據(jù)接口表12消息體字段名稱數(shù)據(jù)類型可空描述響應codestringN公告編碼reasonstringN上傳失敗原因上報社區(qū)數(shù)據(jù)接口上報社區(qū)數(shù)據(jù)接口應符合表9的規(guī)定。表9上報社區(qū)數(shù)據(jù)接口表編號APP-YWTB02名稱上報社區(qū)數(shù)據(jù)協(xié)議HTTPS方法POSTURI/v1/app/ywtb/vote/communities序列化格式JSON說明上報社區(qū)數(shù)據(jù)，每次不宜超過100條消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuiditemsarray(community)N社區(qū)列表communityarea_codestringN行政區(qū)劃編碼，應符合附錄B，如：310101002001001016areastringN/市轄區(qū)/黃浦區(qū)/南京東路街道/云南中路居委會/XX小區(qū)/16號樓addressstringN地址，如：梅隴路555弄響應codeinteger(int32)N響應碼msgstringN響應消息itemsarray(Result)N上傳結果，僅攜帶上傳失敗的記錄Resultarea_codestringN社區(qū)編碼reasonstringN上傳失敗原因編號APP-YWTB03名稱上報業(yè)主數(shù)據(jù)協(xié)議HTTPSDB31/T1492—2024表DB31/T1492—2024表PAGE10（續(xù)）DB31/T1492—2024DB31/T1492—20上報項目數(shù)據(jù)接口表上報項目數(shù)據(jù)接口應符合表11的規(guī)定。上報項目數(shù)據(jù)接口表上報項目數(shù)據(jù)接口應符合表11的規(guī)定。表11上報項目數(shù)據(jù)接口表13方法POSTURI/v1/ywtb/vote/owners序列化格式JSON說明上報業(yè)主數(shù)據(jù)，每次不宜超過100條消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuiditemsarray(Owner)N業(yè)主列表Owneridinteger(int32)N用戶標識如:56namestringN業(yè)主姓名如:張*國，脫敏mobilestringN移動電話如:188****8888，脫敏area_codestringN行政區(qū)劃編碼，應符合附錄B，如：310101002001001016areastringN/市轄區(qū)黃浦區(qū)/南京東路街道/云南中路居委會/XX小區(qū)/16號樓addressstringN地址，如：梅隴路555弄typeinteger(int32)N類型1：所有權人2：共住人card_numberstringY人員身份證號碼，前六位用*代替如:******197201181637；未登記身份證號時該字段值為空join_datestringN加入時間如:2021-02-0316:00:00unitinteger(int32)Y單元，如：1floorinteger(int32)Y樓層，如：2room_numberinteger(int32)Y戶號/房間號如：201photo_urlstringY照片鏈接響應codeinteger(int32)N響應碼msgstringN響應消息itemsarray(Result)N上傳結果，僅攜帶上傳失敗的記錄Resultidinteger(int32)N業(yè)主標識reasonstringN上傳失敗原因編號APP-YWTB04名稱上報項目數(shù)據(jù)更新項目階段接口更新項目階段接口應符合表12的規(guī)定。更新項目階段接口更新項目階段接口應符合表12的規(guī)定。表12更新項目階段接口表14表11（續(xù)）協(xié)議HTTPS方法POSTURI/v1/app/ywtb/vote/projects序列化格式JSON說明上報項目數(shù)據(jù)，每次不宜超過100條消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuiditemsarray(Project)N項目列表Projectidinteger(int32)N項目標識codestringN項目編碼namestringN項目名稱，如：XXX項目descstringN項目描述start_datestringN啟動時間如：2021-02-0300:00:00end_datestringN結束時間如：2021-06-0300:00:00area_codestringN行政區(qū)劃編碼，應符合附錄B，如：310101002001001016areastringN/市轄區(qū)/黃浦區(qū)/南京東路街道/云南中路居委會/XX小區(qū)/16號樓addressstringN地址，如：梅隴路555弄amountstringN總金額（元），如：1212312.12stageinteger(int32)N項目階段1：立項2：施工安裝3：完工響應codeinteger(int32)N響應碼msgstringN響應消息itemsarray(Result)N上傳結果，僅攜帶上傳失敗的記錄ResultidstringN項目標識codestringN項目編碼reasonstringN上傳失敗原因編號APP-YWTB05名稱更新項目階段協(xié)議HTTPS對接行業(yè)應用接口要求7.3.1接口列表對接行業(yè)應用接口要求7.3.1接口列表.4表13行業(yè)應用接口列表7.3.2交互流程對接行業(yè)應用接口交互流程見圖5。15方法PUTURI/v1/app/ywtb/vote/projects/stage序列化格式JSON說明更新項目階段數(shù)據(jù)，每次不宜超過100條消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuiditemsarray(Project)N項目列表Projectidinteger(int32)N項目標識codestringN項目編碼stageinteger(int32)N項目階段1：立項2：施工安裝3：完工響應codeinteger(int32)N響應碼msgstringN響應消息itemsarray(Result)N更新結果，僅更新失敗的記錄ResultidstringN項目標識codestringN項目編碼reasonstringN更新失敗原因分類接口編碼用途設備管理類APP-IA-DM01獲取設備數(shù)據(jù)接口，用于獲取設備數(shù)據(jù)APP-IA-DM02獲取設備狀態(tài)數(shù)據(jù)接口，用于獲取設備狀態(tài)數(shù)據(jù)行業(yè)業(yè)務數(shù)據(jù)類APP-IA-BD01獲取通行記錄數(shù)據(jù)接口，用于獲取通行記錄數(shù)據(jù)APP-IA-BD02獲取事件檢測數(shù)據(jù)接口，用于獲取事件檢測數(shù)據(jù)設備管理類設備管理類場景業(yè)務數(shù)據(jù)類場景業(yè)務數(shù)據(jù)類HTTPS：獲取設備列表接口設備列表HTTPS：獲取設備列表接口設備列表HTTPS：獲取設備狀態(tài)接口設備狀態(tài)HTTPS：獲取通行記錄接口通行記錄HTTPS：獲取事件檢測數(shù)據(jù)接口事件數(shù)據(jù)智聯(lián)平臺行業(yè)應用平臺獲取設備列表接口獲取設備列表接口應符合表14的規(guī)定。表14獲取設備列表接口表獲取設備列表接口獲取設備列表接口應符合表14的規(guī)定。表14獲取設備列表接口表16編號APP-IA-DM01名稱獲取設備列表協(xié)議HTTPS方法GETURI/v1/app/ia/devices序列化格式JSON說明獲取權限范圍內的設備列表消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidpageinteger(int32)Y頁碼，默認1per_pageinteger(int32)Y每頁記錄數(shù)，默認100響應codeinteger(int32)N響應碼msgstringN響應消息dataDataObjN設備數(shù)據(jù)DataObjcountinteger(int32)N總數(shù)獲取設備狀態(tài)接口獲取設備狀態(tài)接口應符合表15的規(guī)定。獲取設備狀態(tài)接口獲取設備狀態(tài)接口應符合表15的規(guī)定。表15獲取設備狀態(tài)數(shù)據(jù)接口表17消息體字段名稱數(shù)據(jù)類型可空描述響應pageinteger(int32)N頁碼per_pageinteger(int32)N每頁記錄數(shù)listarray(Device)Y設備列表Devicedevice_idstringN設備標識parent_device_idstringY父級設備標識，默認空字符串device_kindstringN設備型號編碼device_typestringN設備類型device_namestringN設備名稱device_snstringYSN號addressstringN地址area_codestringN區(qū)劃編碼statusstringN設備狀態(tài)，字典參見附錄A.2create_timeinteger(int64)N注冊時間戳，精確到毫秒last_update_timeinteger(int64)N最近更新時間戳，精確到毫秒extra_infostringY擴展字段，自定義tagsarray(Tag)Y設備關聯(lián)標簽Tagtag_namestringN標簽名.可包含英文字母、數(shù)字下劃線“_”、短橫線“-”和點號“.”，長度不超過128個字符tag_valuestringN長度不超過128個字符編號APP-IA-DM02名稱獲取設備狀態(tài)數(shù)據(jù)協(xié)議HTTPS方法GETURI/v1/app/ia/devices/status序列化格式JSON說明獲取權限范圍內的設備狀態(tài)數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidDB31/T1492—2024表DB31/T1492—2024表PAGE15（續(xù)）DB31/T1492—2024DB31/T1492—2024消息體字段名稱數(shù)據(jù)類型可空描述請求pageinteger(int32)Y頁碼，默認1per_pageinteger(int32)Y每頁記錄數(shù)，默認100響應codeinteger(int32)N響應碼msgstringN響應消息dataDataObjN設備狀態(tài)數(shù)據(jù)DataObjcountinteger(int32)N總數(shù)pageinteger(int32)N頁碼per_pageinteger(int32)N每頁記錄數(shù)listarray(DeviceStatus)Y設備狀態(tài)列表DeviceStatusdevice_idstringN設備標識statusstringN設備狀態(tài)，字典參見附錄A.2last_update_timeinteger(int64)N最近更新時間戳，精確到毫秒extra_infostringY擴展字段，自定義獲取通行記錄數(shù)據(jù)接口獲取通行記錄數(shù)據(jù)接口應符合表16的規(guī)定。表16獲取通行記錄數(shù)據(jù)接口表獲取通行記錄數(shù)據(jù)接口獲取通行記錄數(shù)據(jù)接口應符合表16的規(guī)定。表16獲取通行記錄數(shù)據(jù)接口表18編號APP-IA-BD01名稱獲取通行記錄數(shù)據(jù)協(xié)議HTTPS方法GETURI/v1/app/ia/passes序列化格式JSON說明獲取設備通行記錄數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidtimestringN數(shù)據(jù)時間范圍（跨度小于等于180天），式：開始時間戳,結束時間戳pageinteger(int32)Y頁碼，默認1per_pageinteger(int32)Y每頁記錄數(shù)，默認100響應codeinteger(int32)N響應碼msgstringN響應消息獲取事件檢測數(shù)據(jù)接口獲取事件檢測數(shù)據(jù)接口應符合表17的規(guī)定。獲取事件檢測數(shù)據(jù)接口獲取事件檢測數(shù)據(jù)接口應符合表17的規(guī)定。表17獲取事件檢測記錄數(shù)據(jù)接口表19表16（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述響應dataDataObjN通行記錄數(shù)據(jù)DataObjcountinteger(int32)N總數(shù)pageinteger(int32)N頁碼per_pageinteger(int32)N每頁記錄數(shù)listarray(PassRecord)Y通行記錄數(shù)據(jù)PassRecordportrait_imagestringY（理）person_ageinteger(int32)N年齡person_namestringN姓名（脫敏后）panoramic_imagestringY背景大圖地址（人像打碼處理）scoreinteger(int32)N得分verticesstringN抓拍圖相對于背景圖坐標person_genderstringN0：女，1：男attributesstringY人臉屬性JSON字符串face_image_idstringY息extra_infostringY擴展字段，自定義timeinteger(int64)N通行時間戳，精確到毫秒編號APP-IA-BD02名稱獲取事件檢測記錄數(shù)據(jù)協(xié)議HTTPS方法GETURI/v1/app/ia/events序列化格式JSON說明獲取設備事件檢測數(shù)據(jù)，最大可獲取近1個月的數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidtimestringN數(shù)據(jù)時間范圍（跨度小于等于180天），式：開始時間戳，結束時間戳pageinteger(int32)Y頁碼，默認1對接一網統(tǒng)管接口要求7.4.1接口列表對接一網統(tǒng)管接口要求7.4.1接口列表7.118表18對接一網統(tǒng)管接口列表7.4.2交互流程對接一網統(tǒng)管接口交互流程見圖6。20消息體字段名稱數(shù)據(jù)類型可空描述請求per_pageinteger(int32)Y每頁記錄數(shù)，默認100響應codeinteger(int32)N響應碼msgstringN響應消息dataDataObjN事件記錄數(shù)據(jù)DataObjcountinteger(int32)N總數(shù)pageinteger(int32)N頁碼per_pageinteger(int32)N每頁記錄數(shù)listarray(EventRecord)Y事件記錄列表EventRecorddevice_idstringN設備唯一標識alarm_typestringN告警類型alarm_detailstringN告警描述photostringY事件抓拍圖存儲地址，人像打碼處理face_image_idstringY息extra_infostringY擴展字段，自定義timeinteger(int64)N事件時間戳，精確到毫秒分類接口編碼用途一網統(tǒng)管接口APP-YWTG01獲取事件檢測數(shù)據(jù)接口，用于獲取事件檢測數(shù)據(jù)HTTPS：獲取事件檢測數(shù)據(jù)接口HTTPS：獲取事件檢測數(shù)據(jù)接口事件數(shù)據(jù)一網統(tǒng)管平臺智聯(lián)平臺圖6對接一網統(tǒng)管接口交互流程圖7.4.3接口定義19表19獲取事件檢測記錄接口表編號APP-YWTG01名稱獲取事件檢測記錄數(shù)據(jù)協(xié)議HTTPS方法GETURI/v1/app/ywtg/envents序列化格式JSON說明獲取事件檢測數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求request_idstringN請求標識，uuidtimestringN數(shù)據(jù)時間范圍（跨度小于等于180天），式：開始時間戳,結束時間戳pageinteger(int32)Y頁碼，默認1per_pageinteger(int32)Y每頁記錄數(shù)，默認100響應codeinteger(int32)N響應碼msgstringN響應消息dataDataObjN事件記錄數(shù)據(jù)DataObjcountinteger(int32)N總數(shù)pageinteger(int32)N頁碼per_pageinteger(int32)N每頁記錄數(shù)listarray(EventRecord)Y事件記錄列表2121DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024DB31/T1492—20248對接云邊端協(xié)同通用接口要求接口列表8對接云邊端協(xié)同通用接口要求接口列表對接云邊端協(xié)同通用接口列表應符合表20的規(guī)定。表20對接云邊端協(xié)同通用接口列表22表19（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述響應EventRecorddevice_idstringN設備唯一標識device_namestringN設備名稱area_codestringN行政區(qū)劃編碼規(guī)則，應符合附錄B，如：310101002001001016areastringN/市轄區(qū)/黃浦區(qū)/南京東路街道/云南中路居委會/XX小區(qū)/16號樓addressstringY地址，如：梅隴路555弄alarm_typestringN告警類型alarm_detailstringN告警描述photostringY事件抓拍圖存儲地址，人像打碼處理face_image_idstringY息extra_infostringY擴展字段，自定義timeinteger(int64)N事件時間戳，精確到毫秒分類接口編碼用途設備注冊IOT-DM01設備注冊接口，用于端邊設備注冊到云，并獲取連接網關的密鑰業(yè)務影子同步IOT-BC01配置下發(fā)接口，用于云下發(fā)業(yè)務配置到邊端設備IOT-BC02配置響應接口，用于邊端設備回復配置結果IOT-BC03配置狀態(tài)上報接口，用于邊端設備業(yè)務配置狀態(tài)上報到云庫同步IOT-PD01庫列表訂閱接口，用于邊端設備訂閱庫列表，獲取全部庫列表信息IOT-PD02庫元數(shù)據(jù)訂閱接口，用于邊端設備訂閱庫元數(shù)據(jù)IOT-PD03全量數(shù)據(jù)獲取接口，用于邊端設備獲取最新的全量數(shù)據(jù)IOT-PD04指定范圍數(shù)據(jù)訂閱接口，用于邊端設備訂閱指定范圍的增量數(shù)據(jù)IOT-PD05增量數(shù)據(jù)訂閱接口，用于邊端設備訂閱增量的數(shù)據(jù)數(shù)據(jù)同步IOT-DS01數(shù)據(jù)下發(fā)接口，用于云下發(fā)數(shù)據(jù)到邊端設備IOT-DS02數(shù)據(jù)回傳接口，用于邊端設備回傳數(shù)據(jù)到云文件同步IOT-FM01小文件上傳接口，用于小于1MB的文件上傳IOT-FM02小文件下載接口，用于小于1MB的文件下載表20（續(xù)）分類接口編碼用途文件同步IOT-FM03大文件上傳接口，用于獲取大于或等于1MB的文件鏈接并上傳IOT-FM04大文件下載接口，用于獲取大于或等于1MB的文件鏈接并下載交互流程圖中對端、邊、云的定義如下：云邊端協(xié)同設備注冊交互流程見圖7。服務端服務端客戶端HTTPS:設備注冊設備信息（含MQTT連接秘鑰秘鑰+配置信息建立MQTT連接圖7云邊端協(xié)同設備注冊交互流程圖圖7云邊端協(xié)同設備注冊交互流程圖8.2.3云邊端協(xié)同業(yè)務影子同步交互流程云邊端協(xié)同業(yè)務影子同步交互流程見圖8。23MQTT：配置下發(fā)MQTT：配置下發(fā)業(yè)務配置MQTT：配置響應定時更新MQTT：配置狀態(tài)上報服務端客戶端圖8云邊端協(xié)同業(yè)務影子同步交互流程圖8.2.4云邊端協(xié)同庫同步交互流程云邊端協(xié)同庫同步交互流程見圖9。2424客戶端 服務端客戶端服務端MQTT：訂閱庫列表解析文件URIMQTT：下載文件MQTT：定于增量數(shù)據(jù)解析文件URIMQTT：下載文件MQTT：訂閱指定范圍增量數(shù)據(jù)MQTT：訂閱指定范圍增量數(shù)據(jù)解析文件URIMQTT：下載文件圖9云邊端協(xié)同庫同步交互流程圖8.2.5云邊端協(xié)同數(shù)據(jù)同步交互流程云邊端協(xié)同數(shù)據(jù)同步交互流程見圖10。25客戶端服務端客戶端服務端圖10云邊端協(xié)同數(shù)據(jù)同步交互流程圖8.2.6云邊端協(xié)同文件同步交互流程云邊端協(xié)同文件同步交互流程見圖11。圖11云邊端協(xié)同文件同步交互流程圖268.3.1設備注冊接口設備注冊接口應符合表21的規(guī)定。表21設備注冊接口表編號IOT-DM001名稱設備注冊協(xié)議HTTPS方法POSTURI/v1/registries/{registry_id}/devices序列化格式protobuf說明用于端邊設備注冊到云，并獲取連接網關的密鑰，需要提前預置CA證書。消息體字段名稱數(shù)據(jù)類型可空描述請求registry_idstringN租戶標識，預置namestringN設備名稱，預置device_kindstringN設備類型編碼metadataDeviceMetaDataN設備元數(shù)據(jù)rom_uuidstringYrom唯一標識，用于android設備public_keystring(byte)N設備公鑰，用于邊/端設備接入云側時做接入認證region_idinteger(int32)Y設備所屬區(qū)域唯一標識，0號id系統(tǒng)保留，范圍：[1,16383]tagsarray(Tag)Y設備關聯(lián)標簽Tagtag_namestringN和點號“.”，長度不超過128個字符tag_valuestringN標簽值，可包含中文、英文字母、數(shù)字下劃線“_橫線“-”和點號“.”，長度不超過128個字符DeviceMetaDatadevice_idstringN設備標識，由SHA256({COMPANY_NAME}-{PRODUCT_NAME}-{DEVICE_SN})生成；[a-f0-9]{64}device_snstringY設備SN，由廠家生成，沒有的設備可不填company_namestringN公司名稱，預置product_namestringN產品名稱，預置typestringN設備類型，取值應符合附錄A.3默認TT_UNKNOWNdevice_kindstringN產品型號2727DB31/T1492—2024DB31/T1492—202421（）DB31/T1492—2024DB31/T1492—202421（）消息體字段名稱數(shù)據(jù)類型可空描述請求metadataobjectN鍵值對，設備靜態(tài)屬性,最多128個鍵值對；key:[a-zA-Z][a-zA-Z0-9-_.+~%]+,length<128bytes；value:size<32KBdescriptionstringY設備描述響應extra_infostring(byte)Y擴展字段，自定義，base64字符串，可擴充其他字段deviceAtomDeviceN設備信息AtomDevicenamestringN設備名稱metadataDeviceMetaDataN設備元數(shù)據(jù)statusstringN設備狀態(tài)，字典應符合附錄A.2默認DS_UNACTIVEDdevice_configDeviceConfigN設備系統(tǒng)配置device_stateDeviceStateN設備系統(tǒng)配置狀態(tài)last_connected_atstring(date-time) N設備最近的在線時間disconnected_atstring(date-time) N設備離線時間created_atstring(date-time) N設備創(chuàng)建時間updated_atstring(date-time) N設備更新時間rom_uuidstringYrom唯一標識，用于android設備public_keystring(byte)N設備公鑰，用于邊/端設備接入網關側時做設備接入認證is_dynamic_registrationboolN設置region_idinteger(int32)Y設備所屬區(qū)域唯一標識，0號id系統(tǒng)保留，范圍：[1,16383]parent_device_idstringY設備類型為“TT_END_SUBDEVICE”。子設備可以與設備類型為“TT_EDGE_GATEWAY”以及“TT_EDGE_DEVICE”的設備進行綁定DeviceMetaDatadevice_idstringN設備標識，由SHA256({COMPANY_NAME}-{PRODUCT_NAME}-{DEVICE_SN})生成；[a-f0-9]{64}device_snstringY設備SN，由廠家生成，沒有的設備可不填company_namestringN公司名稱，預置product_namestringN產品名稱，預置typestringN設備類型，取值應符合附錄A.3默認TT_UNKNOWNdevice_kindstringN產品型號2828消息體字段名稱數(shù)據(jù)類型可空描述響應metadataobjectN鍵值對，設備靜態(tài)屬性，最多128個鍵值對；key:[a-zA-Z][a-zA-Z0-9-_.+~%]+,length<128bytes；value:size<32KBdescriptionstringY設備描述extra_infostring(byte)Y擴展字段，自定義，base64字符串，可擴充其他字段DeviceConfigipIPConfigN網絡IP配置。IP地址配置參數(shù)ntpNtpConfigNNTP配置natNatConfigNNAT配置time_zoneTzConfigN時區(qū)配置dnsDnsConfigNDNS配置logLogConfigN日志配置license_filestring(byte)Nlicense文件user_configsstringY附加配置，用于協(xié)議拓展和第三方集成sshSshConfigNSSH配置IPConfigipsarray(IpParam)NIP參數(shù)數(shù)組IpParamtypestringN地址配置類型。-IT_DHCP:DHCP動態(tài)配置；-IT_STATIC:靜態(tài)配置interface_namestringN添加地址和網關信息的接口的名稱addressstringNIP地址netmaskstringN子網掩碼gatewaystringN網關地址gateway_typestringNGT_DEFAULT：默認網關；GT_NORMAL：普通網關NtpConfigntpsarray(TableNTP)NNTP服務列表time_intervalinteger(int64)N時間同步間隔,單位為秒enableboolN是否使用NTP服務TableNTPurlstringNNTP服務地址portstringNNTP服務端口NatConfignatsarray(TableNAT)NNAT配置TableNATexternal_ipstringN對外地址2929配置下發(fā)接口應符合表22的規(guī)定。表22配置下發(fā)接口表30消息體字段名稱數(shù)據(jù)類型可空描述響應external_portstringN對外端口internal_ipstringN內部地址internal_portstringN內部端口protocolstringN協(xié)議statusstringN狀態(tài)碼，默認SC_OK，字典應符合附錄A.4DnsConfigprimarystringN主DNS地址TzConfigtime_zonestringN本地時區(qū)采用UTC（UniversalTimeCoordinated，世界調整時間）時區(qū)secondarystringY備DNS地址LogConfigpathstringN日志文件保存路徑sizestringN日志文件大小限制levelstringN日志文件記錄級別。-LOG_NONE：不輸出。字典應符合附錄A.5SshConfigsshTableSSHNSSHTableSSHenableboolN是否啟用portstringY端口編號IOT-BC001名稱配置下發(fā)協(xié)議MQTT序列化格式protobuf說明云下發(fā)業(yè)務影子配置到邊、端設備或邊下發(fā)業(yè)務影子配置到端消息體字段名稱數(shù)據(jù)類型可空描述請求headerDeclarativeConfigN數(shù)據(jù)報文頭datastring(byte)N業(yè)務配置數(shù)據(jù)，業(yè)務自定義，建議JSON或JSONArray格式DB31/T1492—2024DB31/T1492—202422（）DB31/T1492—2024DB31/T1492—202424（）配置狀態(tài)上報接口配置狀態(tài)上報接口配置狀態(tài)上報接口應符合表24的規(guī)定。表24 配狀上接表31消息體字段名稱數(shù)據(jù)類型可空描述請求DeclarativeConfignamestringN業(yè)務影子配置名稱，唯一標識updated_atstring(date-time)N更新時間device_acknowledged_atstring(date-time)N接收到來自設備的配置更新回執(zhí)的時間，未收到回執(zhí)則為空versionstring(int64)N配置的版本號，創(chuàng)建時初始化為1響應無配置響應接口配置響應接口應符合表23的規(guī)定。表23配置響應接口表編號IOT-BC002名稱配置響應協(xié)議MQTT序列化格式protobuf說明邊、端設備回復云業(yè)務影子的配置結果或端設備回復業(yè)務影子的配置結果到邊消息體字段名稱數(shù)據(jù)類型可空描述請求ackAckN回執(zhí)AcknamestringN業(yè)務影子配置名稱versionstring(int64)N配置的版本號statusstringN配置的狀態(tài)，默認CONFIG_UNINITIALIZEDA.6響應無編號IOT-BC003名稱配置狀態(tài)上報協(xié)議MQTT序列化格式protobuf說明邊、端設備將業(yè)務影子的配置狀態(tài)上報到云或端設備將業(yè)務影子的配置狀態(tài)上報到邊消息體字段名稱數(shù)據(jù)類型可空描述請求headerDeclarativeStateN數(shù)據(jù)報文頭庫元數(shù)據(jù)訂閱接口庫元數(shù)據(jù)訂閱接口庫元數(shù)據(jù)訂閱接口應符合表26的規(guī)定。表26庫列表訂閱接口表32消息體字段名稱數(shù)據(jù)類型可空描述請求datastring(byte)N業(yè)務配置數(shù)據(jù)，自定義DeclarativeStatenamestringN業(yè)務影子配置名稱updated_atstring(date-time)N更新時間status_codestringN響應無庫列表訂閱接口應符合表25的規(guī)定。表25庫列表訂閱接口表編號IOT-PD001名稱庫列表訂閱協(xié)議MQTT序列化格式protobuf說明邊、端設備訂閱庫列表，獲取全部庫列表信息消息體字段名稱數(shù)據(jù)類型可空描述請求無響應rsmsarray(RSMMeta)NRSM元信息列表RSMMetarsm_idstringNRSM唯一標識符，范圍：UUIDv4格式descriptionstringY描述信息created_atstring(date-time)N創(chuàng)建時間extra_infostring(byte)Y拓展信息，大小不應該超過10KB編號IOT-PD002名稱庫列表訂閱協(xié)議MQTT序列化格式protobuf說明邊、端設備訂閱單個庫元數(shù)據(jù)，獲取元數(shù)據(jù)更新DB31/T1492—2024DB31/T1492—202426（）DB31/T1492—2024表DB31/T1492—2024表28（續(xù)）指定范圍數(shù)據(jù)訂閱接口指定范圍數(shù)據(jù)訂閱接口應符合表28的規(guī)定。指定范圍數(shù)據(jù)訂閱接口指定范圍數(shù)據(jù)訂閱接口應符合表28的規(guī)定。表28指定范圍數(shù)據(jù)訂閱接口表33消息體字段名稱數(shù)據(jù)類型可空描述請求rsm_idstringNRSM唯一標識符，范圍：UUIDv4格式響應rsm_idstringNRSM唯一標識符，范圍：UUIDv4格式descriptionstringY描述信息created_atstring(date-time)N創(chuàng)建時間extra_infostring(byte)Y拓展信息，大小不應該超過10KB全量數(shù)據(jù)獲取接口全量數(shù)據(jù)獲取接口應符合表27的規(guī)定。表27全量數(shù)據(jù)獲取接口表編號IOT-PD003名稱全量數(shù)據(jù)獲取協(xié)議MQTT序列化格式protobuf說明邊、端設備獲取單個庫最新的全量數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求rsm_idstringNRMS唯一標識符響應last_snapshotstring(byte)N最近一次的快照數(shù)據(jù)注：實際傳輸時消息中的快照數(shù)據(jù)置于messageframecontent中,header中消息體并不包含last_snapshot數(shù)據(jù)last_snapshot_seq_idint64N最近一次快照對應的序列號created_atstring(date-time)N快照創(chuàng)建時間codestringN請求返回碼，默認SC_OK，字典應符合附錄A.4編號IOT-PD004名稱指定范圍數(shù)據(jù)訂閱協(xié)議MQTT序列化格式protobuf說明邊、端設備獲取全量數(shù)據(jù)后，可通過此接口訂閱單個庫指定范圍的增量數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求rsm_idstringNRMS唯一標識符增量數(shù)據(jù)訂閱接口增量數(shù)據(jù)訂閱接口應符合表29的規(guī)定。增量數(shù)據(jù)訂閱接口增量數(shù)據(jù)訂閱接口應符合表29的規(guī)定。表29增量數(shù)據(jù)訂閱接口表34消息體字段名稱數(shù)據(jù)類型可空描述請求seq_id_range_startint64N操作日志序列號起始號seq_id_range_int64N操作日志序列號終止號，0代表需要返回到最新的seq_idrsm_idstringNRMS唯一標識符響應logsarray(RSMOpLog)Nseq_id1因為返回數(shù)據(jù)需要小于1MB，可以多次請求獲取完整的操作日志。注2：實際傳輸時消息中的操作日志數(shù)據(jù)以RSMOpLogs消息體序列化后置于messageframecontent中，header中消息體并不包含logs數(shù)據(jù)codestringNA.4totalint64N請求范圍內的日志總數(shù)RSMOpLogheaderHeaderObjN操作日志結構體datastring(byte)N業(yè)務數(shù)據(jù)，自定義編號IOT-PD005名稱增量數(shù)據(jù)訂閱協(xié)議MQTT序列化格式protobuf說明邊、端設備獲取全量數(shù)據(jù)后，可通過此接口訂閱單個庫的增量數(shù)據(jù)消息體字段名稱數(shù)據(jù)類型可空描述請求rsm_idstringNRMS唯一標識符seq_idint64N日志序列號上限DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024DB31/T1492—2024表29（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述響應logRSMOpLogNseq_id1因為返回數(shù)據(jù)需要小于1MB，可以多次請求獲取完整的操作日志。注2：實際傳輸時消息中的操作日志數(shù)據(jù)以RSMOpLogs消息體序列化后置于messageframecontent中，header中消息體并不包含logs數(shù)據(jù)codestringN請求返回碼，默認SC_OK，字典應符合附錄A.4RSMOpLogheaderHeaderObjN操作日志結構體datastring(byte)N業(yè)務數(shù)據(jù)，自定義數(shù)據(jù)下發(fā)接口應符合表30的規(guī)定。表30數(shù)據(jù)下發(fā)接口表35數(shù)據(jù)下發(fā)接口應符合表30的規(guī)定。表30數(shù)據(jù)下發(fā)接口表35編號IOT-DS001名稱數(shù)據(jù)下發(fā)協(xié)議MQTT序列化格式protobuf說明云下發(fā)數(shù)據(jù)到邊端設備或邊下發(fā)數(shù)據(jù)到端設備消息體字段名稱數(shù)據(jù)類型可空描述請求registry_idstringN關聯(lián)設備從屬的租戶標識device_idstringN設備標識，范圍：SHA256({COMPANY_NAME}-{PRODUCT_NAME}-{DEVICE_SN})providerstringYRPC提供方callerstringNRPC調用方，預留字段，暫時放空namestringNRPC調用名稱kindstringNRPC調用類型。-RPC_BIDIRECTION：雙向請求。-RPC_ONEWAY：單向請求，不需要返回deadlinestringNRPC超時時長。0代表使用默認超時時間contentstring(byte)YJSON分不同的業(yè)務數(shù)據(jù)表30（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述響應codestringN請求返回碼，默認SC_OK，取值范圍應符合附錄A.4contentstring(byte)Y響應內容，業(yè)務定義，可選數(shù)據(jù)回傳接口應符合表31的規(guī)定。表31數(shù)據(jù)回傳接口表編號IOT-DS002名稱數(shù)據(jù)回傳協(xié)議MQTT序列化格式protobuf說明邊、端設備回傳數(shù)據(jù)到云或端回傳數(shù)據(jù)到邊消息體字段名稱數(shù)據(jù)類型可空描述請求headerCallCloudRPCReqHeaderNRPC請求頭datastring(byte)Y數(shù)據(jù)體實際傳輸以base64方式，自行定JSON型區(qū)分不同的業(yè)務數(shù)據(jù)CallCloudRPCReqHeaderrequest_idstringN請求標識，格式：UUIDv4providerstringYRPC提供方callerstringNRPC調用方,預留字段,暫時放空namestringNRPC調用名稱kindstringNRPCRPC_BIDIRECTION：雙RPC_ONEWAY要返回deadlinestringNRPC超時時長。0代表使用默認超時時間響應headerCallCloudRPCResHeaderNRPC響應頭datastring(byte)Ybase64方式，見Data結構Data結構codestringN調用結果碼，默認OK，OK-成功；ERROR-失敗msgstringY調用失敗后的消息。CallCloudRPCResHeaderrequest_idstringN請求標識，格式：UUIDv4codestringN請求返回碼，默認SC_OK，取值范圍應符合附錄A.43636小文件上傳接口應符合表32的規(guī)定。表32小文件上傳接口表編號IOT-FM001名稱小文件上傳協(xié)議MQTT序列化格式protobuf說明小文件上傳接口，用于邊、端設備上傳小于1MB的文件到云或端設備上傳小于1MB的文件到邊消息體字段名稱數(shù)據(jù)類型可空描述請求bucket_namestringN空間名稱blobstring(byte)N對象數(shù)據(jù)，范圍：任意二進制數(shù)據(jù)metadataMetadataN對象元數(shù)據(jù)。對象元信息，內容為S3和OSG的對象元信息object_namestringYS3口的存儲(如minio)可使用，注意：相同的object_name存儲(如OSGMetadatasizeinteger(int32)N對象數(shù)據(jù)大小，單位為byte置為對象數(shù)據(jù)實際大小，取值范圍：(0，1024*1024]etagstringY對象數(shù)據(jù)md5校驗值，如：aa41efe0a1b3eeb9bf303e4561ff892content_typestringY指定數(shù)據(jù)內容類型created_atstring(date-time)Y對象創(chuàng)建時間，使用UTC時區(qū).attrsstringY一組KV意，如{'camera_id':'123'}響應object_keystringN對象標識數(shù)組，格式：{bucket_name}/{object_name}小文件下載接口小文件下載接口小文件下載接口應符合表33的規(guī)定。 37大文件上傳接口大文件上傳接口應符合表34的規(guī)定。大文件上傳接口大文件上傳接口應符合表34的規(guī)定。表34大文件上傳接口表38表33小文件下載接口表編號IOT-FM002名稱小文件下載協(xié)議MQTT序列化格式protobuf說明小文件下載接口，用于從云下載小于1MB的文件到邊、端設備或邊下載小于1MB的文件到端設備消息體字段名稱數(shù)據(jù)類型可空描述請求bucket_namestringN空間名稱object_namestringN文件對象名稱響應blobstring(byte)N對象數(shù)據(jù)metadataMetadataN元數(shù)據(jù)Metadatasizeinteger(int32)N對象數(shù)據(jù)大小，單位為byte，上傳時由系統(tǒng)設置為對象數(shù)據(jù)實際大小，取值范圍：(0，1024*1024]etagstringY對象數(shù)據(jù)md5校驗值，如：aa41efe0a1b3eeb9bf303e4561ff892下建議提供此參數(shù)用于數(shù)據(jù)進行端對端的校驗content_typestringY指定數(shù)據(jù)內容類型created_atstring(date-time)Y對象創(chuàng)建時間，使用UTC時區(qū)attrsstringY一組KV意，如{'camera_id':'123'}編號IOT-FM003名稱大文件上傳協(xié)議MQTT序列化格式protobuf說明大文件上傳接口，獲取≥1MB到鏈接后在設備端需要在指定過期時間前完成上傳操作表34（續(xù)）消息體字段名稱數(shù)據(jù)類型可空描述請求bucket_namestringN空間名稱object_namestringN文件對象名稱expire_in_secstring(int64)Y可選，生成的上傳URL云側默認過期時間響應upload_urlstringN生成的預簽名上傳URL，設備可以通過此URLHTTP上傳文件expired_atstring(date-time)N生成的預簽名上傳URL過期絕對時間大文件下載接口大文件下載接口應符合表35的規(guī)定。表35大文件下載接口表編號IOT-FM004名稱大文件下載協(xié)議MQTT序列化格式protobuf說明大文件下載接口，獲取≥1MB到鏈接后在設備端需要在指定過期時間前完成下載操作消息體字段名稱數(shù)據(jù)類型可空描述請求bucket_namestringN空間名稱object_namestringN文件對象名稱響應download_urlstringN生成的預簽名下載URL，設備可以通過此URLHTTP下載文件expired_atstring(date-time)N生成的預簽名下載URL過期絕對時間9應用場景云邊端協(xié)同接口要求9應用場景云邊端協(xié)同接口要求應用場景的交互流程終端設備通過7.3.1設備注冊接口注冊到網關系統(tǒng)，認證通過后與網關系統(tǒng)建立MQTT連接。終端設備接入到網關系統(tǒng)后，可通過7.3.2、7.3.3、7.3.4數(shù)據(jù)接口完成業(yè)務配置、人像庫、數(shù)據(jù)和文件同步等接口完成業(yè)務數(shù)據(jù)下發(fā)、數(shù)據(jù)采集、應用升級等場景業(yè)務功能。應用場景數(shù)據(jù)交互圖見圖12。39HTTPS：設備注冊并建立MQTT連接HTTPS：設備注冊并建立MQTT連接響應MQTT：下行數(shù)據(jù)響應MQTT：終端設備網關系統(tǒng)圖12應用場景數(shù)據(jù)交互圖數(shù)據(jù)實體：EventInfo。屬性：設備標識、事件類型、事件內容、抓拍圖鏈接、事件時間戳等。數(shù)據(jù)實體：MessageInfo。屬性：工程標識、發(fā)布信息內容、發(fā)布時間戳等。應用場景業(yè)務數(shù)據(jù)定義根據(jù)具體應用場景進行定義，可參照附錄C的應用場景示例。40附錄A（規(guī)范性）數(shù)據(jù)字典設備狀態(tài)字典應符合表A.1的規(guī)定。表A.1設備狀態(tài)表編碼名稱DS_UNACTIVED未激活狀態(tài)DS_ACTIVED已激活狀態(tài)DS_ONLINE在線狀態(tài)DS_OFFLINE離線狀態(tài)DS_DISABLED禁用狀態(tài)設備類型字典應符合表A.2的規(guī)定。表A.2設備類型表A.4請求返回碼設備類型字典應符合表A.2的規(guī)定。表A.2設備類型表A.4請求返回碼請求返回碼字典應符合表A.3的規(guī)定。表A.3請求返回碼表41編碼名稱TT_UNKNOWN未知TT_EDGE_GATEWAY邊緣網關TT_EDGE_DEVICE邊緣設備TT_END_SUBDEVICE子設備編碼名稱SC_OK成功SC_SC_CANCELLED客戶端取消調用SC_UNKNOWN未知錯誤SC_INVALID_ARGUMENT無效參數(shù)SC_DEADLINE_EXCEEDED調用超時表A.3續(xù)）編碼名稱SC_NOT_FOUND資源未找到SC_ALREADY_EXISTS資源已存在SC_PERMISSION_DENIED非法訪問SC_UNAUTHENTICATED未授權SC_RESOURCE_EXHAUSTED資源耗盡SC_FAILED_PRECONDITION調用條件異常SC_ABORTED事務取消SC_OUT_OF_RANGE參數(shù)、用量超限SC_UNIMPLEMENTED未實現(xiàn)SC_INTERNAL服務器內部錯誤SC_UNAVAILABLE服務不可用SC_DATA_LOSS數(shù)據(jù)損壞SC_DEVICE_UNREACHABLE設備無法訪問SC_DEVICE_TIME_NOT_SYNC設備時間未同步A.5日志級別表A.4日志級別表A.6業(yè)務影子配置狀態(tài)業(yè)務影子配置狀態(tài)字典應符合表A.5的規(guī)定。表A.4日志級別表A.6業(yè)務影子配置狀態(tài)業(yè)務影子配置狀態(tài)字典應符合表A.5的規(guī)定