DB5110

四川省（內(nèi)江市）地方標(biāo)準(zhǔn)

DB5110/T6—2023

數(shù)據(jù)接口規(guī)范

DataInterfaceStandardSpecification

i

DB5110/T1—2023

目次

前言II

1范圍9

2引用文件9

3術(shù)語(yǔ)和定義9

3.1政務(wù)信息資源9

3.2元數(shù)據(jù)9

3.3數(shù)據(jù)服務(wù)化9

3.4數(shù)據(jù)服務(wù)接口9

4概述9

5系統(tǒng)架構(gòu)10

6數(shù)據(jù)接口共享流程11

6.1數(shù)據(jù)源11

6.2接口接入11

6.2.1數(shù)據(jù)表轉(zhuǎn)RESTful服務(wù)接入11

6.2.2RESTful接口接入11

6.2.3WebService接口接入11

6.2.4HTTP自定義服務(wù)接口接入11

6.3目錄發(fā)布12

6.4使用審批12

7接口開(kāi)發(fā)要求12

7.1接口方法12

7.2接口要求12

7.3返回參數(shù)13

7.4狀態(tài)碼13

8數(shù)據(jù)共享接口接入樣例13

附錄A（資料性附錄）JSON接口返回模板14

附錄B（資料性附錄）數(shù)據(jù)表轉(zhuǎn)RESTful服務(wù)接入樣例16

附錄C（資料性附錄）RESTful接口接入樣例18

附錄D（資料性附錄）WebService接口接入樣例19

附錄E（資料性附錄）HTTP自定義服務(wù)接口接入樣例21

參考文獻(xiàn)23

II

DB5110/T1—2023

,11-1-

刖百

標(biāo)準(zhǔn)號(hào)：DB5110/T6-2023。

標(biāo)準(zhǔn)名稱：數(shù)據(jù)接口規(guī)范。

本標(biāo)準(zhǔn)部分按照GB/T1.1—2020標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則的規(guī)

定起草。

請(qǐng)注意：本標(biāo)準(zhǔn)的某些內(nèi)容可能涉及專(zhuān)利，本標(biāo)準(zhǔn)的發(fā)布機(jī)構(gòu)不承擔(dān)識(shí)別這些專(zhuān)利的先任。

標(biāo)準(zhǔn)歸口單位：由內(nèi)江市大數(shù)據(jù)中心提出并歸口。

標(biāo)準(zhǔn)起草單位：內(nèi)江市大數(shù)據(jù)中心、四川云領(lǐng)智城信息科技有限公司、杭州數(shù)夢(mèng)工場(chǎng)科技有限公司。

標(biāo)準(zhǔn)主要起草人：

III

DB5110/T6—2023

I

DB5110/T6—2023

數(shù)據(jù)接口規(guī)范

1范圍

本規(guī)范規(guī)定了內(nèi)江市全市范圍內(nèi)數(shù)據(jù)資源共享的系統(tǒng)架陶，定義了數(shù)據(jù)接口共享流程，為內(nèi)江市數(shù)

據(jù)資源共享接口的規(guī)劃、實(shí)施和管理提供指導(dǎo)。

本規(guī)范適用于內(nèi)江市數(shù)據(jù)資源共享接口的建設(shè)與設(shè)計(jì)工作，主要用于數(shù)據(jù)資源共享接口的提供方。

2規(guī)范性引用文件

下列文件對(duì)于本文件的應(yīng)用是必不可少的。凡是注口期的引用文件，僅所注口期的版本適用于本文

件。凡是不注日期的引用文件，其最新版本(包括所有的修改單)適用于本文件。

GB/T18391.1?2009信息技術(shù)元數(shù)據(jù)注冊(cè)系統(tǒng)(MDR)第1部分：框架。

GB7T21062.3-2007政務(wù)信息資源交換體系第3部分：數(shù)據(jù)接口規(guī)范。

3術(shù)語(yǔ)和定義

下列術(shù)語(yǔ)和定義適用于本接口規(guī)范。

3.1.1

政務(wù)信息資源

政務(wù)信息資源是指政務(wù)部門(mén)在履行職責(zé)過(guò)程中制作或獲取的，以一定形式記錄、保存的文件、資料、

圖表和數(shù)據(jù)等各類(lèi)信息資源，包括政務(wù)部門(mén)直接或通過(guò)第三方依法采集的、依法授權(quán)管理的和因履行職

責(zé)需要依托政務(wù)信息系統(tǒng)形成的信息資源等。

3.2

元數(shù)據(jù)

政務(wù)信息資源元數(shù)據(jù)是對(duì)政務(wù)數(shù)據(jù)資源特征的描述，包括：標(biāo)識(shí)符、中文名稱、提供部門(mén)、共享類(lèi)

型、開(kāi)放類(lèi)型、數(shù)據(jù)類(lèi)型、字段名稱、定義、值域、表示格式、備注等。

3.3

數(shù)據(jù)服務(wù)化

數(shù)據(jù)服務(wù)化是將政務(wù)數(shù)據(jù)資源轉(zhuǎn)化為標(biāo)準(zhǔn)的數(shù)據(jù)服務(wù)接口的過(guò)程。

3.4

數(shù)據(jù)服務(wù)接口

數(shù)據(jù)服務(wù)接口是指信息建設(shè)過(guò)程中已開(kāi)發(fā)完成，并在政務(wù)外網(wǎng)各信息系統(tǒng)間使用的服務(wù)接口。常見(jiàn)

9

DB5110/T6—2023

的數(shù)據(jù)服務(wù)接口協(xié)議包括WebService、RESTful、HTTP等。

4概述

本規(guī)范中的信息資源是指符合國(guó)家政務(wù)信息資源共享要求的相關(guān)數(shù)據(jù)。

政務(wù)數(shù)據(jù)共享應(yīng)遵循統(tǒng)籌規(guī)劃、全面推進(jìn)、統(tǒng)一標(biāo)準(zhǔn)、便捷高效、主動(dòng)提供、依法管理、安全可控

的原則。

可通過(guò)數(shù)據(jù)共享接口共享的政務(wù)數(shù)據(jù)資源不包括：

a）涉及國(guó)家秘密的；

b）涉及商業(yè)秘密的；

c）涉及個(gè)人隱私的：

d）法律法規(guī)規(guī)定不得開(kāi)放的其他政府?dāng)?shù)據(jù)。

5系統(tǒng)架構(gòu)

依托于內(nèi)江市政務(wù)信息資源數(shù)據(jù)中臺(tái)提供的數(shù)據(jù)服務(wù)接口開(kāi)發(fā)、接入、發(fā)布、共享能力，為全省政

務(wù)部門(mén)及地市的業(yè)務(wù)系統(tǒng)提供高性能、高可靠的數(shù)據(jù)共享服務(wù)，整體系統(tǒng)架構(gòu)參考圖

幅信息資源目錄系統(tǒng)

接口服務(wù)同關(guān)度口服務(wù)網(wǎng)關(guān)

接口調(diào)用

部門(mén)［酬穌的部門(mén)I部息系統(tǒng)

圖1內(nèi)江市政務(wù)數(shù)據(jù)接口服務(wù)架構(gòu)圖

內(nèi)江市政務(wù)信息資源共享平臺(tái)由如下七部分組成:

10

DB5110/T6—2023

a）政務(wù)信息資源目錄系統(tǒng)：在數(shù)據(jù)共享場(chǎng)景中，政務(wù)信息資源目錄系統(tǒng)規(guī)范了數(shù)據(jù)服務(wù)接口的展

示以及提供接口服務(wù)的方法和要求：

b）數(shù)據(jù)接口服務(wù)管理系統(tǒng)：對(duì)已發(fā)布的數(shù)據(jù)接口進(jìn)行統(tǒng)一管控并對(duì)各接口服務(wù)網(wǎng)關(guān)進(jìn)行運(yùn)維監(jiān)

控；

c）接口服務(wù)網(wǎng)關(guān)：為各部門(mén)提供服務(wù)注冊(cè)、發(fā)布、管理能力。支持多種接口服務(wù)協(xié)議，轉(zhuǎn)化為

RESTful服務(wù)接入服務(wù)網(wǎng)關(guān)，為各政務(wù)部門(mén)提供便捷、高可靠的服務(wù)支撐；

d）前置庫(kù)：用「存儲(chǔ)各政務(wù)部門(mén)共享交換的數(shù)據(jù)資源的關(guān)系型數(shù)據(jù)庫(kù)；

e）接口服務(wù)：各政務(wù)部門(mén)提供的接口服務(wù)；

f）業(yè)務(wù)庫(kù)：各政務(wù)部門(mén)的業(yè)務(wù)數(shù)據(jù)庫(kù)；

g）文件：以文件形式存儲(chǔ)的政務(wù)數(shù)據(jù)資源，如CSV文件、TXT文件等。

6數(shù)據(jù)接口共享流程

數(shù)據(jù)接口共享包含如下步驟：共享數(shù)據(jù)源的確定、對(duì)應(yīng)數(shù)據(jù)服務(wù)服務(wù)接口掛接、數(shù)據(jù)服務(wù)接口目錄

發(fā)布、使用審批。見(jiàn)圖2。

共享教據(jù)源的確定匚二〉接口接入匚二〉目錄發(fā)布匚二〉使用審批

圖2共享流程

6.1數(shù)據(jù)源

政務(wù)信息資源共享前，數(shù)據(jù)中臺(tái)管理方需與數(shù)據(jù)服務(wù)接口提供方就信息資源的共享需求和共享方式

達(dá)成一致，包括信息資源名稱、內(nèi)容、用途、共享模式、數(shù)據(jù)格式等內(nèi)容。

6.2接口接入

各政務(wù)部門(mén)完成共享數(shù)據(jù)接口開(kāi)發(fā)并驗(yàn)證通過(guò)后，將對(duì)應(yīng)共享數(shù)據(jù)接口服務(wù)注冊(cè)到接II服務(wù)網(wǎng)關(guān)。

接口服務(wù)網(wǎng)關(guān)具備數(shù)據(jù)表轉(zhuǎn)服務(wù)接入、RESTful接口接入、WebService接口接入、HTTP自定義服務(wù)接

口接入等能力。

6.2.1數(shù)據(jù)表轉(zhuǎn)RESTful服務(wù)接入

數(shù)據(jù)表接入接口服務(wù)網(wǎng)關(guān)時(shí)，需錄入服務(wù)名稱、服務(wù)描述、調(diào)用閾值、超時(shí)時(shí)間等，用戶根據(jù)數(shù)據(jù)

庫(kù)的數(shù)據(jù)元信息完成服務(wù)接口配置，自動(dòng)生成RESTful服務(wù)。同時(shí)可根據(jù)數(shù)據(jù)共享需要設(shè)置過(guò)濾、排

序、是否分頁(yè)等條件。

6.2.2RESTful接口接入

RESTful接口接入時(shí)，需錄入服務(wù)名稱、服務(wù)描述、調(diào)用閾值、超時(shí)時(shí)間等。采用RESTful接口接

入時(shí)，可選擇免驗(yàn)證、Basic驗(yàn)證、Digest驗(yàn)證、Token驗(yàn)證等四種代理驗(yàn)證方式。用戶也可選擇下行

驗(yàn)證方式（如不需要驗(yàn)證和用戶名驗(yàn)證）。除上述線上填報(bào)外，也可通過(guò)手工錄入或文件上傳的方式開(kāi)

發(fā)RESTful服務(wù)，滿足多種用戶需求。

6.2.3WebService接口接入

WcbScrvicc接口接入時(shí)，需錄入服務(wù)名稱、服務(wù)描述、調(diào)用閾值、超時(shí)時(shí)間等。采用WcbScrvicc

11

DB5110/T6—2023

接口接入時(shí)，可選擇免驗(yàn)證、Basic驗(yàn)證、Digest驗(yàn)證、Token驗(yàn)證等四種代理驗(yàn)證方式。用戶也可通

過(guò)錄入WSDL文件完成WcbScrvicc接口的接入，滿足多種用戶需求。

6.2.4HTTP自定義服務(wù)接口凄入

HTTP接口接入時(shí)，需錄入服務(wù)名稱、服務(wù)描述、調(diào)用閾值、超時(shí)時(shí)間等。采用HTTP接口接入時(shí)，

用戶可選擇代理驗(yàn)證類(lèi)型（免驗(yàn)證、Basic驗(yàn)證、Digest驗(yàn)證、Token驗(yàn)證），用戶也可選擇下行驗(yàn)證

方式（如不需要驗(yàn)證和用戶名驗(yàn)證）。

6.3目錄發(fā)布

目錄發(fā)布流程見(jiàn)圖3。

目錄編目匚二/部門(mén)審核匚二〉中心審批匚二》目錄發(fā)布

圖3目錄發(fā)布

數(shù)據(jù)共享接口服務(wù)通過(guò)政務(wù)信息資源目錄系統(tǒng)統(tǒng)一管理，可完成數(shù)據(jù)共享接II的編目'發(fā)布。

目錄編目階段由服務(wù)提供方的部門(mén)人員操作，在發(fā)布流程中錄入該數(shù)據(jù)接口服務(wù)相關(guān)的元數(shù)據(jù)，包

括信息資源名稱、信息資源英文、來(lái)源信息系統(tǒng)名稱、信息資源提供方、資源提供方代碼、信息資源格

式類(lèi)型、信息資源摘要等。

部門(mén)審核階段由服務(wù)提供方的部門(mén)權(quán)簽人員操作，用于審核該數(shù)據(jù)服務(wù)接口發(fā)布的正確性并提交至

中心審批。

中心審批由系統(tǒng)平臺(tái)的管理員操作，用于決策是否發(fā)布此數(shù)據(jù)服務(wù)接口。

目錄發(fā)布后即可在政務(wù)信息資源目錄系統(tǒng)中統(tǒng)一呈現(xiàn)，便于各政務(wù)部門(mén)或地市進(jìn)行申請(qǐng)使用該數(shù)據(jù)

服務(wù)接口。

上述是?個(gè)完整的數(shù)據(jù)服務(wù)接口目錄發(fā)布流程，實(shí)際操作中，用戶可根據(jù)需求對(duì)目錄發(fā)布流程進(jìn)行

訂制。

6.4使用審批

使用審批流程見(jiàn)圖4。

接口服務(wù)申潔I〉獲取審批I供應(yīng)審批

圖4使用審批

接口服務(wù)申請(qǐng)階段由服務(wù)申請(qǐng)方的部門(mén)使用人員操作，用于觸發(fā)啟動(dòng)審批流程。

獲取審批階段由服務(wù)申請(qǐng)方的部門(mén)權(quán)簽人員操作，用于確認(rèn)是否有必要申請(qǐng)使用該政務(wù)數(shù)據(jù)資源。

供應(yīng)審批階段由服務(wù)提供方的部門(mén)權(quán)簽人員操作，用于決策是否對(duì)申請(qǐng)部門(mén)做服務(wù)接口授權(quán)。

授權(quán)審批后，服務(wù)需求部門(mén)可調(diào)用該信息資源共享接口.

上述是一個(gè)完整的使用審批流程，實(shí)際操作中用戶可按需對(duì)使用審批流程進(jìn)行訂制。

7接口開(kāi)發(fā)要求

7.1接口方法

12

DB5110/T6—2023

市數(shù)據(jù)中臺(tái)接口管理平臺(tái)支持HTTPGET/POST和WebService類(lèi)型接口。接口參數(shù)數(shù)據(jù)全部使

用UTF-8編碼格式。接口數(shù)據(jù)可選取采用XML和JSON兩種格式，WebService方法調(diào)用只能返回

XML格式。

注：對(duì)于非結(jié)構(gòu)化數(shù)據(jù)接口、在線交互操作接口、地圖操作類(lèi)型接口，市數(shù)據(jù)中臺(tái)采用直接代理方式（隱藏原始IP

地址），對(duì)請(qǐng)求參數(shù)、返回參數(shù)格式等不做要求，但是需要提供接口使用說(shuō)明文檔。

7.2接口要求

a）要求服務(wù)接口的請(qǐng)求參數(shù)和接口登記時(shí)錄入的參數(shù)完全一致；

b）要求返回錯(cuò)誤碼和接II登記時(shí)錄入的參數(shù)完全一致；

c）要求返回?cái)?shù)據(jù)時(shí)的數(shù)據(jù)項(xiàng)名稱和接口登記的數(shù)據(jù)項(xiàng)英文名完全一致；

d）要求接口登記的數(shù)據(jù)項(xiàng)英文名和信息資源目錄注冊(cè)的信息項(xiàng)的英文名保持一致；

e）資源提供方開(kāi)發(fā)的服務(wù)接口，無(wú)論是HTTP類(lèi)型的服務(wù)接口還是WebService類(lèi)型的服務(wù)接

口，在設(shè)計(jì)傳入?yún)?shù)時(shí)，不允許在Header傳遞參數(shù),應(yīng)在Body中進(jìn)行傳遞；

f）如果提供方接口存在管控參數(shù),例如:秘鑰、用戶名、密碼等。需要告知市共享交付平臺(tái)具體參

數(shù)數(shù)據(jù)。并給予市數(shù)據(jù)中臺(tái)訪問(wèn)權(quán)限。管控值需要固定；

g）服務(wù)提供方應(yīng)明確原始接口地址是否有調(diào)用限制，例如,有IP或端口限制。

7.3返回參數(shù)

在開(kāi)發(fā)服務(wù)接口時(shí)，接口成功接到請(qǐng)求，應(yīng)返回200的HTTP狀態(tài)值。為保障前后端數(shù)據(jù)交互的

順暢，應(yīng)規(guī)范數(shù)據(jù)的返回，并采用固定的數(shù)據(jù)格式封裝。返回參數(shù)見(jiàn)表1。

表1返回參數(shù)

參數(shù)中文名參數(shù)英文名類(lèi)型必填說(shuō)明

返回碼code數(shù)字（int）是狀態(tài)碼/錯(cuò)誤碼

返回信息msg字符串(string)是返回狀態(tài)描述

返回?cái)?shù)據(jù)data字符串(string)是具體的真實(shí)數(shù)據(jù)

每頁(yè)記錄數(shù)pageSize數(shù)字（int）否每頁(yè)記錄數(shù)

當(dāng)前頁(yè)pageindex數(shù)字(int)否當(dāng)前頁(yè)

總頁(yè)數(shù)pages數(shù)字（ini）否總頁(yè)數(shù)

總記錄數(shù)count數(shù)字（int）是總記錄數(shù)

注1：JS0N接口返回模板見(jiàn)附錄A。

注2：數(shù)據(jù)核驗(yàn)接口返回值為yes或者noo

7.4狀態(tài)碼

資源提供方開(kāi)發(fā)的服務(wù)接口必須提供狀態(tài)碼表。

8數(shù)據(jù)共享接口接入樣例

本章介紹目前數(shù)據(jù)表轉(zhuǎn)RESTful服務(wù)接入（見(jiàn)附錄A）、RESTful接口接入（見(jiàn)附錄B）,WebService

接口接入（見(jiàn)附錄C）及HTTP自定義服務(wù)接口接入（見(jiàn)附錄D）對(duì)應(yīng)的樣例。

13

DB5110/T6—2023

附錄A

(資料性附錄)

JS0N接口返回模板

(

status:0,

data:{},

〃"

msg:

)

status:接口的執(zhí)行狀態(tài),=0表示成功。

出ita:接口包含的主要數(shù)據(jù)，可以是JS0N對(duì)象。

msg:接口的返回信息

提示:下載數(shù)據(jù)每頁(yè)支持最大條數(shù)【pageSize][5000]條

JS0N返回示例：

{

"code":"200〃,/*返回碼*/

"msg”:〃成功〃，/*返回消息*/

"data":{/*返回?cái)?shù)據(jù)*/

"pageSize":15,/*每頁(yè)記錄數(shù)*/

“pageindex”:1,/*當(dāng)前頁(yè)*/

"pages”:10,/*總頁(yè)數(shù)*/

“count":15(),/*總記錄數(shù)*/

"data":[{/*數(shù)據(jù)項(xiàng)*/“ISPROCESSED”:ISPROCESSED,"DATADATA

“LOCKTIME”:LOCKTIME,“TASKID”:TASKID,

“USER」D_":USER」D_,

*LOG_NRJ:LOG_NR_,

"EXECUT1ON」D_〃:EXECUTION_ID_,

“TYPE」：TYPE_,

“PROC」NST_II)_":PROC_INST_n)_,

"LOCK_0WNER_":LOCKOWNER.,

“PROC_DEF_ID_":PROC_DEF_ID_,

"TIME_STAMP_*:TIME_STAMP_,

)]}

)

圖A.1接口返回錯(cuò)誤信息

錯(cuò)誤碼錯(cuò)誤碼類(lèi)型錯(cuò)誤碼說(shuō)明

204代理接口錯(cuò)誤碼未查詢到數(shù)據(jù)

408代理接口錯(cuò)誤碼請(qǐng)求超時(shí)

14

DB5110/T6—2023

錯(cuò)誤碼錯(cuò):吳碼類(lèi)型錯(cuò)誤碼說(shuō)明

-200服務(wù)級(jí)錯(cuò)誤碼請(qǐng)求失敗

-10系統(tǒng)級(jí)錯(cuò)誤碼數(shù)據(jù)簽名不存在

-11系統(tǒng)級(jí)錯(cuò)誤碼無(wú)效的數(shù)據(jù)簽名

-20系統(tǒng)級(jí)錯(cuò)誤碼時(shí)間裁不存在

-21系統(tǒng)級(jí)錯(cuò)誤碼無(wú)效的時(shí)間找

-30系統(tǒng)級(jí)錯(cuò)誤碼無(wú)效的數(shù)據(jù)返回格式

-40系統(tǒng)級(jí)錯(cuò)誤碼訪問(wèn)的服務(wù)不存在

-50系統(tǒng)級(jí)錯(cuò)誤碼用戶不存在

-60系統(tǒng)級(jí)錯(cuò)誤碼無(wú)效的簽名方式

-70系統(tǒng)級(jí)錯(cuò)誤碼用戶沒(méi)有權(quán)限訪問(wèn)服務(wù)

-80系統(tǒng)級(jí)錯(cuò)誤碼系統(tǒng)錯(cuò)誤

-90系統(tǒng)級(jí)錯(cuò)誤碼惡意訪問(wèn)

參數(shù)異常=請(qǐng)求參數(shù)出錯(cuò)，請(qǐng)檢查serviceld、ak、timestamp、

-100系統(tǒng)級(jí)錯(cuò)誤碼

sign、appld是否存在!

-110系統(tǒng)級(jí)錯(cuò)誤碼AK不存在

-120系統(tǒng)級(jí)錯(cuò)誤碼請(qǐng)求時(shí)間失立不在有效時(shí)間內(nèi)訪問(wèn)接口！

-130系統(tǒng)級(jí)錯(cuò)誤碼服務(wù)狀態(tài)為:亭用，請(qǐng)檢查！

-140系統(tǒng)級(jí)錯(cuò)誤碼服務(wù)未申請(qǐng)，請(qǐng)檢查！

-150系統(tǒng)級(jí)錯(cuò)誤碼服務(wù)申請(qǐng)有效期結(jié)束，請(qǐng)檢查！

-160系統(tǒng)級(jí)錯(cuò)誤碼服務(wù)申請(qǐng)權(quán)限已回收，請(qǐng)檢查！

-170系統(tǒng)級(jí)錯(cuò)誤碼appld非法或者未經(jīng)過(guò)應(yīng)用授權(quán)

-180代理接口錯(cuò)誤類(lèi)型代理接口錯(cuò)誤類(lèi)型

-190代理接口錯(cuò)誤類(lèi)型接口已升級(jí)，需要調(diào)用更高版本

15

DB5110/T6—2023

附錄B

(資料性附錄)

數(shù)據(jù)表轉(zhuǎn)RESTful服務(wù)接入樣例

List<Rcst2DbRulcRequestModel>ruleRcquestModcls=newArrayList<>();

Rest2DbRuleRequestModelruleRequestModel=newRest2DbRjleRequestModel();

nilcRcqucstModcl.sctRulcNamc(,'jdbcRulcNamc");

ruleRequestModel.setProxyAuthType("digest");

nileRequestModel.setlIttpPath(,'/test/rule/jdbc,');

ruleRequestModel.setHttpPathMode("custom");

ruleRequestModel.setIIttpMethod(Hgetn);

ruleRequestModel.setCreator("usersystem");

ruleRequestModel.setCreatorGroup("instance01");

ruleRequestModel.sctTypc("OraclcH);

ruleRequestModel.setHost(u46");

nileRequestMode!.setPort(1521);

ruleRequestModel.setDatabaseCORCL");

nileRequestModeLsetTableCtbr*);

ruleRequestModel.setUsemame("username");

ruleRequestModeLsetPassv/ord("password");

ruleRequestModel.sctHasPagination(falsc);

ruleRequestModel.setCountLimit(l00);

nilcRcqucstModcI.sctSqlDcscJson(H!\Htype\,*:\"modcl\,,.\,,modcl\',:!\',columns\*,:[{\',expression\,,:!\"sourc

e\H:\',tbl\",\"column\u:\,,C_CHAR\,,,\"type\":\,,Column\',,\"dataType\',:\"CHAR\',},\,'label\',:\"C_CHAR\,,,\',desc

ription\',:\,,\,,,\H$Sselected\,':false,\"$ShashKey\,,:\,,object:1927\"),{\,,expression\,,:{\"sourceV,:\,'tbl\,,,\,'column\H:

\',C_DATE\',,\,,type\,':V,Column\,,,\"dataType\n:\,,TIMESTAMP\M),\"label\,,:\"C_DATE\,,,\,,description\,,:\,,\,,,\"$

$selected\,,:false,\,'$$hashKey\,':\"object:1933\"}],\,'filter\,':{\,'type\,,:\"Group\',,\"operator\,,:\',And\",\"items\H:[]

,\ndcsc\,,:\"\",\,,S$sclcctcd\":falsc},\"ordcrBy\,,:[],\"sourccs\":[]}}");

ruleRequestModel.setJdbcUrl(,'jdbc:oracle:lhin:@46:1521:ORCLn);

nilcRcquestModcl.setSql("selecttbl.CCHARasCCHAR,tochar(table.CDATE,'yyyy-MM-dd

HH24:mi:ss')asC_DATEfrom:bl")；

RileRequestModel.setDbId(,'d23fdb3b933442ae970073c468de3dl5',);

ruleRequestModel.setMaxPoolSize(100);

ruleRequestModels.add(ruleRequestModel);

StringswaggcrJson="”根據(jù)實(shí)際服務(wù)構(gòu)造

List<RuleResponse>rest2DbRule=CSBCIientUtil.createRest2DbRules(instance,ruleRequestMcdels,

swaggerJson,false);

16

DB5110/T6—2023

表B.1參數(shù)說(shuō)明

參數(shù)名類(lèi)型是否必需描述

setRuieNameString必選路由名稱

setProxyAuthTypeString必選代理認(rèn)證類(lèi)型

setllttpPathString可選代理地址路徑

setHttpPathModeString必選代理地址生成方式

selHlIpMelliodSuiii^必選http請(qǐng)求方法

setCreatorString必選創(chuàng)建者

setCreatorGroupString必選創(chuàng)建者所屬組

setTypcString必選數(shù)據(jù)庫(kù)類(lèi)型

setHostString必選數(shù)據(jù)庫(kù)地址

mysql和postgresql下為查詢的數(shù)據(jù)庫(kù)，

setDatabaseString必選

oracle下為ScrviccNanic

setTableString必選表名

setUsernameString必選用戶名

setPasswordString必選密碼

sctHasPaginationboolean必選查詢是否帶分頁(yè)

setCountLimitlong必選不分頁(yè)時(shí)數(shù)據(jù)返回條數(shù)限制

setSqlDescJsonString必選sql解釋json

setJdbcUrlString必選JDBCURL

setSqlString必選SQL語(yǔ)句

setDbldString必選數(shù)據(jù)源ID

setMaxPoolSizeint必選線程池最大線程數(shù)

DB5110/T6—2023

附錄C

(資料性附錄)

RESTful接口接入樣例

List<Rest2RestRuleRequestModel>rest2RestRuleRequesttfodels=newArrayListO():

Rest2RestRu1eRequestMode1rest2RestRu1eRequestMode1=newRest2RestRuleRequestModel();

rest2RestRuleRequestModel.setRuleNameC/restRule/，);

rest2RestRu1eRequestMode1.setProxyAuthType("digest");

rest2RestRuleRequestModel.setHttpPathC/test/rule/rest，z);

rest2RestRulcRequestModcl.sctHttpPathMode("custom");

rest2RestRuleRequestMode1.setHttpMethod("get");

rest2RestRuleRcquestModel.sctCreatorC'uscrsystem");

rest2RestRuleRequestMode1.setCreatorGroup(z，instance0r，);

rest2RestRuleRequestModel.setHasSandbox(false);

rest2RestRuleRequestModel.setRealAddress("http:〃192.168.129.100:9000");

rest2RestRuleRequestModel.setRealHttpPath(z7api/v1/1ist，y);

rest2RestRuleRequestModcl.sctAuthTypc("none");

rest2RestRuleRequestModel.setNeedCertificate(false);

rest2RcstRuleRcquestModcls.add(rest2RestRulcRcquestModcl);

StringswaggerJson=〃"；//根據(jù)實(shí)際服務(wù)構(gòu)造

List<RuleResponse>rest2RestRule=CSBClientUtil.createRest2RestRule(instance,

rest2RestRu1eRequestMode1s,swaggerJson,null,false);

表C.1參數(shù)說(shuō)明

參數(shù)名類(lèi)型是否必需描述

setRuleNameString必選路由名稱

setProxyAuthTypeString必選代理認(rèn)證類(lèi)型

setHttpPathString可選代理地址路徑

sctHttpPathModeString必選代理地址生成方式

setHttpMethodString必選http請(qǐng)求方法

setCreatorString必選創(chuàng)建者

setCreatorGroupSiring必選創(chuàng)建者所屬組

setRealAddressString必選真實(shí)服務(wù)地址

setBealHttpPathString必選真實(shí)服務(wù)路徑

setAuthTypeString必選真實(shí)服務(wù)驗(yàn)證類(lèi)型

setNeedCertificateboolean可選是否需要證書(shū)

18

DB5110/T6—2023

附錄D

(資料性附錄)

WebService接口接入樣例

List<Rest2WsRuleRequestModel>ruleRequestModels=newArrayListO();

Rest2WsRu1eRequestMode1rest2WsRu1eRequestMode1=newRest2WsRuleRequestModel0;

rest2WsRu1eRequestMode1.setRuieName(，zWsRuleName/z);

rest2WsRu1eRequestMode1.setProxyAuthType("digest");

rest2WsRuleRequestModel.setHttpPath(/z/test/rule/wsw);

rest2WsRuleRequestModel.sctllttpPathModcC，custom/，);

rest2WsRu1eRequestMode1.setHttpMethod("post");

rest2WsRuleRequestMode1.setCrcator(/zusersystem/，);

rest2WsRu1eRequestMode1.setCreatorGroupinstanceOl〃)；

res12WsRu1eRequestMode1.setSoapAddress(，zhttp://192.168.129.223:8787/service/ws/calculate，z)

?

rest2WsRuleRequestModel.setSoapVersion(〃L1");

rest2WsRuleRequestModel.sctSoapAction(，z/，);

rest2WsRuleRequestModel.selOperationName("describe");

rcst2WsRulcRcqucstModcl.setOperationDcsc(^ImplementsWSDLoperationdescribe");

rest2WsRu1eRequestMode1.setSoapTemplate(，z<soapenv:Enve1ope

xmlns:soapenv=\/zhttp://schemas,xmlsoap.org/soap/envelope/\/z

xmlns:ws=\，，http://ws.test.com/\，，>\n，/+

“<#ifbody??>\n〃+

“<#assignscrviccljson=body?cva]/>\n"+

”</#if>\n"+

“<soapenv:Header/>\n"+

〃<soapenv:Body>\n'+

“<ws:describe/>\n〃+

，z</soapenv:Body>\n，/+

，z</soapenv:Envelope>，/);

rest2WsRuleRequestMode1.setWsdlUrl(*http://192.168.129.223:8787/service/ws/calculate?wsdl

〃)；

rest2W?Ru1eRequestMode1.setBindingName(，，CulculdteImplPortBinding/，);

19

DB5110/T6—2023

rest2WsRu1eRequestMode1.setNeedCertificate(faIse);

ruleRequestModels.add(rest2WsRuleRequestModel);

StringswaggerJson=根據(jù)實(shí)際服務(wù)構(gòu)造

List<RuleResponse>rest2WsRule=CSBClientUtil.createRest2WsRules(instance,

ruleRequestModels,swaggerjson,null,false);

表D.l參數(shù)說(shuō)明

參數(shù)名類(lèi)型是否必需描述

setRuleNameString必選路由名稱

setProxyAuthTypeString必選代理認(rèn)證類(lèi)型

setHttpPathString可選代理地址路徑

setHttpPathModeString必選代理地址生成方式

sctHttpMcthodString必選http請(qǐng)求方法

setCreatorString必選創(chuàng)建者

setCreatorGroupString必選創(chuàng)建者所屬組

setSoapAddressString必選webservice請(qǐng)求地加

sctSoapVcrsionString必選Soap版本

setSoapActionString必選webservices請(qǐng)求url

setOperationNameString必選webservices請(qǐng)求接口名稱

setOperalionDescString必選webservices請(qǐng)求接口描述

setSoapTemplateString必選生成的soap模板信息

setWsdllrlString必選webservices請(qǐng)求的wsdl地址

setBindingNameString必選服務(wù)綁定名稱

setNeedCertificateboolean可選是否需要證書(shū)

20

DB5110/T6—2023

附錄E

(資料性附錄)

HTTP自定義服務(wù)接口接入樣例

HTTP接口作為一種基于HTTP協(xié)議的常用開(kāi)發(fā)接口，在某些場(chǎng)景下可通過(guò)HTTP接口的自定義，滿足

政府部門(mén)對(duì)HTTP轉(zhuǎn)發(fā)規(guī)則的特殊定義要求，實(shí)現(xiàn)根據(jù)用戶指定的規(guī)則進(jìn)行政務(wù)信息的共享，如基于HTTP

請(qǐng)求報(bào)文自定義轉(zhuǎn)換規(guī)則、基于HTTP應(yīng)答報(bào)文自定義轉(zhuǎn)換規(guī)則。

通過(guò)HTTP自定義規(guī)則接口的訪問(wèn)樣例：。

List<HttpSe1fDefRu1eRequestMode1>ruleRequestModels=newArrayListO0;

HttpSclfDcfRulcRcquestModclruleRcqucstModel=newHttpSclfDofRuleRcqucstModelD;

intindex=finalI*20+j;

ruleRequestModcl.setRuleName(proxyAuthType+“batchTaslRulcHltp"+index);

ruleRequestModel.setProxyAuthType(proxyAuthType);

ruleRequestModel.setHttpPath('7*+proxyAuthType+*/batch/test/rule/http*+index);

ruleRequestModel.setHttpPathMode(/zcustom，/);

ruleRequestModel.setHttpMethod(，zget/);

ruleRequestModel.sctCrcator("usersystem");

ruleRequestModel.setCreatorGroup("instance01");

ruleRequestModel.sctHasSandbox(false);

ruleRequestModel.setReal/\ddress(，，htlp://192.168.129.100:9000z，);

ruleRequestModel.setRealHttpPath(，7api/vl/list，/);

ru1eRequestMode1.setAuthType("none");

ruleRequestModel.setNeedCertificate(false);

ruleRequestModel.setResponscTypo(z，other，z);

ruleRequestModel.setResponseDecodeJsonObject(false);

ruleRequestModel.sctProxyllttpMcthod(，，gct，/);

ruleRequestModel.setOnlyDecodeFirstLevel(false);

ruleRequestModel.setContainBodyParameter(false);

ru1eRequestMode1.setBodyEnve1opFromHeader(false);

Map<String,HttpSelfDefParameter>headerMap=newHashMapO();

HttpSolfDefParamctcrparameter=newHttpSelfDefParameter();

parameter.setValue("application/json;charset=UTF-8”)；

parameter.sctDynamic(false);

parameter.setRequired(true);

head