DB23∕T 3080-2022 黑龍江工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)公共服務(wù)平臺(tái)數(shù)據(jù)接口規(guī)范

ICS35.240.99CCSL6723黑龍江省地方標(biāo)準(zhǔn)DB23/T3080—2022黑龍江工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)公共服務(wù)平臺(tái)數(shù)據(jù)接口規(guī)范2022-01-29發(fā)布2022-03-01實(shí)施DB23/T3080—2022目??次前言.....................................................................................................................................................................II1范圍.................................................................................................................................................................12規(guī)范性引用文件.............................................................................................................................................13術(shù)語和定義.....................................................................................................................................................14縮略語.............................................................................................................................................................25總體框架與基本要求.....................................................................................................................................25.1總體框架.................................................................................................................................................25.2二級(jí)節(jié)點(diǎn)技術(shù)要求.................................................................................................................................25.3二級(jí)節(jié)點(diǎn)接口要求.................................................................................................................................35.4企業(yè)節(jié)點(diǎn)標(biāo)識(shí)注冊要求.........................................................................................................................36標(biāo)識(shí)注冊.........................................................................................................................................................36.1基于Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)...........................................................................................................36.2基于數(shù)據(jù)模板創(chuàng)建標(biāo)識(shí).........................................................................................................................87標(biāo)識(shí)查詢.......................................................................................................................................................127.1必須帶前綴的查詢...............................................................................................................................127.2可以省略前綴的查詢...........................................................................................................................13附錄A（資料性）狀態(tài)碼..........................................................................................................................15參考文獻(xiàn).............................................................................................................................................................16IDB23/T3080—2022前??言本文件按照GB/T1.1—2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定起草。IIDB23/T3080—2022黑龍江工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)公共服務(wù)平臺(tái)數(shù)據(jù)接口規(guī)范1范圍本文件規(guī)定了黑龍江工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)公共服務(wù)平臺(tái)的總體框架與基本要求，以及標(biāo)識(shí)注冊、標(biāo)識(shí)查詢等數(shù)據(jù)接口要求。本文件適用于黑龍江省工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)與企業(yè)節(jié)點(diǎn)間的數(shù)據(jù)接口管理。2規(guī)范性引用文件本文件沒有規(guī)范性引用文件。3術(shù)語和定義下列術(shù)語和定義適用于本文件。3.1標(biāo)識(shí)編碼能夠唯一識(shí)別機(jī)器、產(chǎn)品等物理資源和算法、工序等虛擬資源的身份符號(hào)。3.2標(biāo)識(shí)注冊針對(duì)工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)編碼的規(guī)劃、申請(qǐng)與分配、使用情況反饋、生命周期管理、標(biāo)識(shí)有效性管理，標(biāo)識(shí)分配使用情況的信息收集以及標(biāo)識(shí)關(guān)聯(lián)信息的采集等功能。3.3標(biāo)識(shí)解析根據(jù)標(biāo)識(shí)編碼查詢目標(biāo)對(duì)象網(wǎng)絡(luò)位置或者相關(guān)信息。3.4國家頂級(jí)節(jié)點(diǎn)國家或地區(qū)內(nèi)部最頂級(jí)的標(biāo)識(shí)服務(wù)節(jié)點(diǎn)，能夠面向全國范圍提供頂級(jí)標(biāo)識(shí)解析服務(wù)，以及標(biāo)識(shí)備案、標(biāo)識(shí)認(rèn)證等管理能力。3.5標(biāo)識(shí)解析二級(jí)節(jié)點(diǎn)1DB23/T3080—2022面向特定行業(yè)或者多個(gè)行業(yè)提供標(biāo)識(shí)服務(wù)的公共節(jié)點(diǎn)，以下簡稱為二級(jí)節(jié)點(diǎn)。3.6企業(yè)節(jié)點(diǎn)企業(yè)內(nèi)部的標(biāo)識(shí)服務(wù)節(jié)點(diǎn)，能夠面向特定企業(yè)提供標(biāo)識(shí)注冊、標(biāo)識(shí)解析服務(wù)、標(biāo)識(shí)數(shù)據(jù)服務(wù)等，既可以獨(dú)立部署，也可以作為企業(yè)信息系統(tǒng)的組成要素。4縮略語下列縮略語適用于本文件。API：應(yīng)用程序接口（ApplicationProgrammingInterface)HDFS：Hadoop分布式文件系統(tǒng)（HadoopDistributedFileSystem）HBASE：Hadoop數(shù)據(jù)庫（HadoopDatabase）RDBMS：關(guān)系式數(shù)據(jù)庫管理系統(tǒng)（RelationalDatabaseManagementSystem）5總體框架與基本要求5.1總體框架黑龍江省工業(yè)互聯(lián)網(wǎng)標(biāo)識(shí)解析（綜合型）二級(jí)節(jié)點(diǎn)公共服務(wù)平臺(tái)的總體框架示意圖，見圖1。圖1公共服務(wù)平臺(tái)接口框架示意圖5.2二級(jí)節(jié)點(diǎn)技術(shù)要求2DB23/T3080—2022應(yīng)滿足下列條件：a)服務(wù)可用性應(yīng)達(dá)到99.99%以上；b)支持IPv4、IPv6雙協(xié)議棧的標(biāo)識(shí)注冊及解析服務(wù)；c)支持對(duì)企業(yè)節(jié)點(diǎn)及標(biāo)識(shí)查詢客戶端的雙向身份認(rèn)證；d)支持對(duì)標(biāo)識(shí)解析過程中數(shù)據(jù)傳輸?shù)臋C(jī)密性與完整性保護(hù)；e)支持對(duì)標(biāo)識(shí)信息的訪問權(quán)限控制能力；f)具備流量重定向等拒絕服務(wù)攻擊防護(hù)能力。5.3二級(jí)節(jié)點(diǎn)接口要求應(yīng)滿足下列條件：a)提供標(biāo)識(shí)注冊、標(biāo)識(shí)解析等相關(guān)接口；b)采用UTF-8字符編碼,Content-Type為application/json；c)除特殊指定外，接口請(qǐng)求方式為POST；d)提供基于Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)的接口和基于數(shù)據(jù)模板創(chuàng)建標(biāo)識(shí)的接口。5.4企業(yè)節(jié)點(diǎn)標(biāo)識(shí)注冊要求在中華人民共和國境內(nèi)依法登記注冊具有獨(dú)立法人資格的企業(yè)、事業(yè)單位、社會(huì)團(tuán)體。6標(biāo)識(shí)注冊6.1基于Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)6.1.1創(chuàng)建Handle數(shù)據(jù)類型請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/createHandleDataType。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表1。表1基于Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)的請(qǐng)求參數(shù)參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填為每家企業(yè)分配的APPID，接口調(diào)試前需要向相應(yīng)人員索取。StringappIdHandle數(shù)據(jù)類型，即標(biāo)識(shí)注冊時(shí)相應(yīng)字段的名稱。StringhandleDataType50必填響應(yīng)參數(shù)，見表2。表2基于Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象3DB23/T3080—20測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","handleDataType":"SIZE"}6.1.2根據(jù)Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/createHandleByType。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表3。表3根據(jù)Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappIdStringhandle標(biāo)識(shí)碼。可以加上工業(yè)互聯(lián)網(wǎng)前綴也可以不加前綴。標(biāo)識(shí)屬性列表200必填必填A(yù)rrayIntitemsitems[i].index標(biāo)識(shí)屬性索引，不填則默認(rèn)從10000開始。8非必填StringStringArrayitems[i].handleDataTypeitems[i].value505.1.1接口創(chuàng)建的Handle數(shù)據(jù)類型標(biāo)識(shí)屬性內(nèi)容值必填2000非必填非必填items[i].references標(biāo)識(shí)引用列表引用的標(biāo)識(shí)碼，如果與handle字段工業(yè)互聯(lián)網(wǎng)前綴一致，則可以省略工業(yè)互聯(lián)網(wǎng)前綴。如果引用的是其他企業(yè)的碼，則必須加上工業(yè)互聯(lián)網(wǎng)前綴。Stringitems[i].references[j].handle200非必填響應(yīng)參數(shù)，見表4。表4根據(jù)Handle數(shù)據(jù)類型創(chuàng)建標(biāo)識(shí)的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","handle":"2000091","items":[4DB23/T3080—2022{"handleDataType":"PRODUCT_NAME","value":"菠蘿""handleDataType":"PRICE","value":"8.5"},{},{"handleDataType":"BATCHNO","references":[{"handle":"88.210.366669/2000079"},{"handle":"2000090"}]}]}6.1.3根據(jù)Handle數(shù)據(jù)類型添加標(biāo)識(shí)項(xiàng)請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/addHandleItemByType。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表5。表5根據(jù)Handle數(shù)據(jù)類型添加標(biāo)識(shí)項(xiàng)參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappIdhandleitems標(biāo)識(shí)碼?？梢约由瞎I(yè)互聯(lián)網(wǎng)前綴也可以不加前綴。標(biāo)識(shí)屬性列表StringArrayInt200必填必填標(biāo)識(shí)屬性索引，不填則默認(rèn)從10000開始items[i].index8非必填StringStringArrayitems[i].handleDataTypeitems[i].value505.1.1接口創(chuàng)建的Handle數(shù)據(jù)類型標(biāo)識(shí)屬性內(nèi)容值必填2000非必填非必填items[i].references標(biāo)識(shí)引用列表5DB23/T3080—2022表5根據(jù)Handle數(shù)據(jù)類型添加標(biāo)識(shí)項(xiàng)（續(xù)）參數(shù)類型參數(shù)名字段長度參數(shù)說明備注引用的標(biāo)識(shí)碼，如果與handle字段工業(yè)互聯(lián)網(wǎng)前綴一致，則可以省略工業(yè)互聯(lián)網(wǎng)前綴。如果引用的是其他企業(yè)的碼，則必須加上工業(yè)互聯(lián)網(wǎng)前綴。Stringitems[i].references[j].handle200非必填響應(yīng)參數(shù)，見表6。表6根據(jù)Handle數(shù)據(jù)類型添加標(biāo)識(shí)項(xiàng)的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","handle":"2000094","items":[{"handleDataType":"BATCHNO","value":"A0310001"}]}6.1.4根據(jù)Handle數(shù)據(jù)類型修改標(biāo)識(shí)值請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/updateHandleByType。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表7。表7根據(jù)Handle數(shù)據(jù)類型修改標(biāo)識(shí)值參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappIdhandleitems標(biāo)識(shí)碼?？梢约由瞎I(yè)互聯(lián)網(wǎng)前綴也可以不加前綴。標(biāo)識(shí)屬性列表StringArray200必填必填6DB23/T3080—2022表7根據(jù)Handle數(shù)據(jù)類型修改標(biāo)識(shí)值（續(xù)）參數(shù)類型參數(shù)名字段長度8參數(shù)說明備注標(biāo)識(shí)屬性索引，必須與注冊時(shí)標(biāo)識(shí)屬性索引一致Intitems[i].index必填必填5.1.1接口創(chuàng)建的Handle數(shù)據(jù)類型Stringitems[i].handleDataType50StringArrayitems[i].value2000標(biāo)識(shí)屬性內(nèi)容值標(biāo)識(shí)引用列表非必填非必填items[i].references引用的標(biāo)識(shí)碼，如果與handle字段工業(yè)互聯(lián)網(wǎng)前綴一致，則可以省略工業(yè)互聯(lián)網(wǎng)前綴。如果引用的是其他企業(yè)的碼，則必須加上工業(yè)互聯(lián)網(wǎng)前綴。items[i].references[j].handleString200非必填響應(yīng)參數(shù)，見表8。表8根據(jù)Handle數(shù)據(jù)類型修改標(biāo)識(shí)值的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","handle":"2000094","items":[{"index":10000,"handleDataType":"PRODUCT_NAME","value":"西瓜"},{"index":10001,"value":"5.0""handleDataType":"PRICE",}]}7DB23/T3080—20226.2基于數(shù)據(jù)模板創(chuàng)建標(biāo)識(shí)6.2.1創(chuàng)建或修改數(shù)據(jù)模板請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/saveTemplate。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表9。表9創(chuàng)建或修改數(shù)據(jù)模板參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappId模板名稱。如果存在則修改模板，否則新增模板。StringtemplateName50必填StringArrayStringStringBooleanIntdescriptionitems500模板描述非必填必填必填必填必填必填必填模板項(xiàng)列表字段中文名字段英文名是否必填items[i].nameCn5050101010items[i].nameEnitems[i].requireditems[i].minLengthitems[i].maxLength字段最小長度字段最大長度Int響應(yīng)參數(shù)，見表10。表10創(chuàng)建或修改數(shù)據(jù)模板的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","templateName":"neil-0310","description":"Neil測試模板","items":[{"nameCn":"名稱","nameEn":"name","required":true,"minLength":2,"maxLength":208DB23/T3080—2022},{"nameCn":"顏色","nameEn":"color","required":true,"minLength":1,"maxLength":10},{"nameCn":"價(jià)格","nameEn":"price","required":false,"minLength":1,"maxLength":10}]}6.2.2根據(jù)模板創(chuàng)建標(biāo)識(shí)請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/createHandleByTemplate。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表11。表11根據(jù)模板創(chuàng)建標(biāo)識(shí)參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappId標(biāo)識(shí)碼。可以加上工業(yè)互聯(lián)網(wǎng)前綴也可以不加前綴。Stringhandle20050必填StringArrayinttemplateNameitems模板名稱必填必填必填標(biāo)識(shí)屬性列表items[i].index8標(biāo)識(shí)屬性索引（不能為1001）標(biāo)識(shí)屬性類型,對(duì)應(yīng)數(shù)據(jù)模板的nameEn。StringStringitems[i].nameitems[i].value50必填必填2000標(biāo)識(shí)屬性內(nèi)容值響應(yīng)參數(shù)，見表12。9DB23/T3080—2022表12根據(jù)模板創(chuàng)建標(biāo)識(shí)的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯一appId","templateName":"neil-0310","handle":"2000097","items":[{"index":2000,"name":"name","value":"APPLE"},{"index":2001,"name":"color","value":"紅色"},{"index":2002,"name":"price","value":"5999"}]}6.2.3根據(jù)模板修改標(biāo)識(shí)請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/updateHandleByTemplate。請(qǐng)求方式：POST。請(qǐng)求參數(shù)，見表13。表13根據(jù)模板修改標(biāo)識(shí)參數(shù)類型參數(shù)名字段長度30參數(shù)說明備注必填StringappId標(biāo)識(shí)碼。可以加上工業(yè)互聯(lián)網(wǎng)前綴也可以不加前綴。Stringhandle200必填10DB23/T3080—2022表13根據(jù)模板修改標(biāo)識(shí)（續(xù)）參數(shù)類型參數(shù)名字段長度參數(shù)說明備注必填必填StringtemplateName508模板名稱Arrayitems標(biāo)識(shí)屬性列表標(biāo)識(shí)屬性索引,索引值必須與注冊時(shí)對(duì)應(yīng)屬性的索引值一致。必填intitems[i].index標(biāo)識(shí)屬性類型,對(duì)應(yīng)數(shù)據(jù)模板StringStringitems[i].nameitems[i].value50必填必填的nameEn。2000標(biāo)識(shí)屬性內(nèi)容值響應(yīng)參數(shù)，見表14。表14根據(jù)模板修改標(biāo)識(shí)的響應(yīng)參數(shù)參數(shù)類型參數(shù)名備注IntegerStringObjectcodemsg狀態(tài)碼(詳見附錄1)提示信息obj返回的對(duì)象測試用例，格式如下。示例：{"appId":"企業(yè)唯－appId","templateName":"neil-0310","handle":"2000097","items":[{"index":2000,"name":"name","value":"獼猴桃"},{"index":2001,"name":"color","value":"yellow"},{11DB23/T3080—2022"index":2002,"name":"price","value":"8.9"}]}7標(biāo)識(shí)查詢7.1必須帶前綴的查詢7.1.1請(qǐng)求路徑：/api/loongxy-lxhl/lxhl/queryHandle?handle=標(biāo)識(shí)碼。7.1.2請(qǐng)求方式：GET。7.1.3請(qǐng)求參數(shù)，見表15。表15必須帶前綴查詢的請(qǐng)求參數(shù)參數(shù)類型參數(shù)名字段長度200參數(shù)說明備注必填String標(biāo)識(shí)碼必須加上工業(yè)互聯(lián)網(wǎng)前綴7.1.4響應(yīng)參數(shù)，見表16。表16必須帶前綴查詢的響應(yīng)參數(shù)參數(shù)類型參數(shù)名參數(shù)說明備注IntresponseCode響應(yīng)碼StringStringArrayInthandlemsg查詢的標(biāo)識(shí)提示信息items標(biāo)識(shí)屬性列表標(biāo)識(shí)屬性索引標(biāo)識(shí)屬性類型標(biāo)識(shí)屬性內(nèi)容值時(shí)間戳items[i].indexitems[i].nameitems[i].valueitems[i].timestampStringStringString7.1.5測試用例，格式如下。示例：{"responseCode":1,"handle":"88.210.366669/2000097","msg":"","items":[{"index":2000,12DB23/T3080—2022"name":"name","value":"獼猴桃","timestamp":"2021-03-1012:08:06"},{"index":2001,"name":"