盛行-荔枝云網(wǎng)絡(luò)接入與安全交互平臺深入設(shè)計接口v1

江蘇臺荔枝云

——網(wǎng)絡(luò)接入與安全交互深入設(shè)計與接口規(guī)范v1.2

1.概述

隨著數(shù)字化、網(wǎng)絡(luò)化、文件化的業(yè)務(wù)系統(tǒng)在

廣泛應(yīng)用，引入越來越多的網(wǎng)絡(luò) ，

而且

速度也越來越快，

的特殊性、重要性及其業(yè)務(wù)系統(tǒng)緊密聯(lián)系性使得

必須建立一套完善的安全防御體系來抵御

的侵?jǐn)_。

各個業(yè)務(wù)系統(tǒng)往往由不同廠商集成，造成了一座座的信息孤島、應(yīng)用孤島、安全孤島，

共享變得異常

，

對信息整合、應(yīng)用整合、安全整合等信息化高端需求日益迫切，

希望通過新一代綜合業(yè)務(wù)集成（門戶）

發(fā)揮其 資產(chǎn)的作用。

，解決孤島問題，使

資源得以共享，最大化

《

數(shù)字化網(wǎng)絡(luò)化建設(shè)白皮書》、《廣播電視相關(guān)信息系統(tǒng)安全等級保護(hù)基本要

求》，建設(shè)高效、安全、共享的業(yè)務(wù)系統(tǒng)，數(shù)據(jù)安全傳輸、交換、發(fā)布 擔(dān)負(fù)了

各

各系統(tǒng)間進(jìn)行數(shù)據(jù)安全、高效交互的任務(wù)，將各個不同的業(yè)務(wù)子網(wǎng)通過TCP/IP、Firewire、

Infiniband等介質(zhì)連接起來，業(yè)務(wù)網(wǎng)間的

通過

、殺毒保證了數(shù)據(jù)來源的安全，

分布式任務(wù)調(diào)度保證了

的快速高效，其由DSC分布式任務(wù)調(diào)度中心、MSU

服

務(wù)單元、WEB及應(yīng)用服務(wù)中心、MAD消息自動處理中心、數(shù)據(jù) 中心、

成。

服務(wù)中心構(gòu)

文件服務(wù)和HTTP 是安全交互

對外提供的兩個

服務(wù)。

2.文件服務(wù)

2.1功能介紹

各個業(yè)務(wù)系統(tǒng)處理和交換的最終對象是

文件，而

文件分散在各個不同的

業(yè)務(wù)網(wǎng)內(nèi)，安全交互

提供了一套安全有效的文件服務(wù)用于處理網(wǎng)內(nèi)的文件管理和網(wǎng)間的

文件交換。具體來說，文件服務(wù)提供了如下功能：

1. 文件管理：可以瀏覽所有業(yè)務(wù)網(wǎng)(無論是否以子網(wǎng)、Firewire,Infiniband等措施

)的以

共享、FTP等形式提供的文件或文件夾，并可以對文件、文件夾進(jìn)行重命名、刪除等操作。

2. 流程管理：定制文件遷移處理流程。將文件從一個業(yè)務(wù)網(wǎng)遷移至另一個業(yè)務(wù)網(wǎng)時，可以

指定一套相應(yīng)的處理流程，如遷移前需經(jīng)過

、殺毒，或者轉(zhuǎn)碼等等。

3. 文件遷移：將文件從一個業(yè)務(wù)網(wǎng)遷移至另一個業(yè)務(wù)網(wǎng)(無論風(fēng)間是否以子網(wǎng)、Firewire,

Infiniband等措施

)，并以指定的遷移處理流程進(jìn)行處理。

2.2使用說明

文件服務(wù)以REST風(fēng)格的HTTPAPI的形式對外提供。調(diào)用api需獲得ap

和app-secret，第

應(yīng)用需向

申請來獲得。RESTfulAPI輸入數(shù)據(jù)支持xml和json格式，由HTTP請求頭

Content-Type標(biāo)識，“application/xml”表示輸入數(shù)據(jù)為xml格式，“application/json”表示輸入數(shù)據(jù)為json格式；輸出數(shù)據(jù)支持xml和json格式，由HTTP請求頭Accept標(biāo)識，如果沒有指定Accept頭，默認(rèn)輸出格式為json。

調(diào)用API時，正常情況下，會返回API對應(yīng)的響應(yīng)。如果調(diào)用出錯，會返回錯誤碼等信息，錯誤信息格式如下：

1.Json

2.Xml

為節(jié)省篇幅，以下API調(diào)用出錯返回信息已省略，如無特別說明，調(diào)用出錯返回信息均如上

述所示。

2.3令牌API

調(diào)用其它API之前需調(diào)用本API獲取令牌。本API必須需通過HTTPS方式獲取。

2.3.1獲取令牌

URL

https:/

/token?id=<ap

>&secret=<app-secret>

請求方式

GET

<?xmlver ="1.0"encoding="utf-8"?>

<response>

<error>{錯誤碼}</token>

<message>{錯誤描述}</expired>

</response>

{

“error”:<錯誤碼>,“message”:<錯誤描述>

}

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

返回參數(shù)

1.

2.

Json

3.

Xml

2.4任務(wù)流程API

2.4.1查詢流程

查詢所有任務(wù)流程。

URL

http:/

/taskflows?token={token}

請求方式

GET

<?xmlver ="1.0"encoding="utf-8"?>

<response>

<token>{ API所使用的Token}</token>

<expired>{超時時間}</expired>

</response>

{

“token”:< API所使用的Token>,“expired”:<超時時間>

}

屬性

類型

說明

token

string

應(yīng)用 本API所使用的令牌

expired

numeric

令牌過期時間

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

返回數(shù)據(jù)為一個數(shù)組，每個數(shù)組元素代表一個任務(wù)流程。

返回參數(shù)

1.

2.

json

3.

xml

<?xmlver ="1.0"encoding="utf-8"?>

<responsearray=”true”>

<item>

<id>{流程ID}</id>

<name>{流程名稱}</name>

<description>{流程描述}</description>

<nodesarray=”true”>

<item>{流程節(jié)點1}</item>

<item>{流程節(jié)點2</item>

<item>{流程節(jié)點3}</item>

[

{

“id”:<流程ID>,“name”:<流程名稱>,

“description”:<流程描述>

“nodes”:[<流程節(jié)點1>,<流程節(jié)點2>,<流程節(jié)點3>,……]“creation_time”:<流程創(chuàng)建時間>

},

……

]

屬性

類型

說明

id

string

任務(wù)流程ID

name

string

任務(wù)流程名稱

description

string

任務(wù)流程說明

nodes

stringarray

任務(wù)流程的組成節(jié)點。當(dāng)前支持節(jié)點有：

DSU( 節(jié)點),

ASU(分析節(jié)點),

FVS(一級殺毒節(jié)點)SecFVS(二級殺毒節(jié)點)MAD(上傳節(jié)點)

creation_ti meric

任務(wù)流程創(chuàng)建時間戳

2.4.2創(chuàng)建流程

創(chuàng)建新任務(wù)流程。

URL

http:/

/taskflows?token={token}

請求方式

T

請求數(shù)據(jù)說明

1.請求參數(shù)

2.json

{

“name”:<流程名稱>“description”:<流程描述>“nodes”:[

<流程節(jié)點1>,

<流程節(jié)點2>,

<流程節(jié)點3>,

屬性

類型

是否必須

說明

name

string

是

新任務(wù)流程名稱

description

string

否

新任務(wù)流程描述信息

nodes

stringarray

是

新任務(wù)流程的組成節(jié)點。當(dāng)前支持節(jié)點有：

DSU( 節(jié)點),

ASU(分析節(jié)點),

FVS(一級殺毒節(jié)點)SecFVS(二級殺毒節(jié)點)MAD(上傳節(jié)點)

……

</nodes>

<creation_time>{流程創(chuàng)建時間}</creation_time>

</item>

……

</response>

3.xml

返回數(shù)據(jù)說明

1.返回參數(shù)

2.json

3.xml

<?xmlver ="1.0"encoding="utf-8"?>

<responsearray=”true”>

<id>{流程ID}</id>

<name>{流程名稱}</name>

<description>{流程描述}</description>

<nodesarray=”true”>

<item>{流程節(jié)點1}</item>

<item>{流程節(jié)點2</item>

{

“id”:<流程ID>,“name”:<流程名稱>,

“description”:<流程描述>

“nodes”:[<流程節(jié)點1>,<流程節(jié)點2>,<流程節(jié)點3>,……]“creation_time”:<流程創(chuàng)建時間>

}

屬性

類型

說明

id

string

任務(wù)流程ID

name

string

任務(wù)流程名稱

description

string

任務(wù)流程說明

nodes

stringarray

任務(wù)流程的組成節(jié)點。

creation_ti meric

任務(wù)流程創(chuàng)建時間戳

<?xmlver ="1.0"encoding="utf-8"?>

<request>

<name>{流程名稱}</name>

<description>{流程描述}</description>

<nodesarray=”true”>

<item>{流程節(jié)點1}</item>

<item>{流程節(jié)點2}</item>

<item>{流程節(jié)點3}</item>

……

</nodes>

</request>

……

]

}

2.4.3獲取流程

根據(jù)流程ID獲取任務(wù)流程。

URL

http:/

/taskflows/{taskflow-id}?token={token}

請求方式

GET

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

1.返回參數(shù)

2.json

{

“id”:<流程ID>,“name”:<流程名稱>,

“description”:<流程描述>

“nodes”:[<流程節(jié)點1>,<流程節(jié)點2>,<流程節(jié)點3>,……]“creation_time”:<流程創(chuàng)建時間>

}

屬性

類型

說明

id

string

任務(wù)流程ID

name

string

任務(wù)流程名稱

description

string

任務(wù)流程說明

nodes

stringarray

任務(wù)流程的組成節(jié)點。

creation_ti meric

任務(wù)流程創(chuàng)建時間戳

<item>{流程節(jié)點3}</item>

……

</nodes>

<creation_time>{流程創(chuàng)建時間}</creation_time>

</response>

3.xml

2.4.4刪除流程

刪除指啊任務(wù)流程。

URL

http:/

/taskflows/{taskflow-id}?token={token}

請求方式

DELETE

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

1.json

2.xml

<?xmlver ="1.0"encoding="utf-8"?>

{

“error”:0,

“message”:<刪除流程成功>

}

<?xmlver ="1.0"encoding="utf-8"?>

<responsearray=”true”>

<id>{流程ID}</id>

<name>{流程名稱}</name>

<description>{流程描述}</description>

<nodesarray=”true”>

<item>{流程節(jié)點1}</item>

<item>{流程節(jié)點2</item>

<item>{流程節(jié)點3}</item>

……

</nodes>

<creation_time>{流程創(chuàng)建時間}</creation_time>

</response>

2.5任務(wù)API

2.5.1任務(wù)統(tǒng)計

獲取任務(wù)統(tǒng)計信息，包含任務(wù)總數(shù)，暫停任務(wù)數(shù)，執(zhí)行任務(wù)數(shù)，取消任務(wù)數(shù)，失敗任務(wù)數(shù)，

成功任務(wù)數(shù)。

URL

http:/

/tasks/s

istics?token={token}

請求方式

GET

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

1.返回參數(shù)

2.json

{

“total”:<傳輸任務(wù)總數(shù)>,“paused”:<暫停的任務(wù)數(shù)>,

屬性

類型

說明

total

numeric

所有提交的任務(wù)總數(shù)

paused

numeric

暫停的任務(wù)數(shù)

running

numeric

正在執(zhí)行的任務(wù)數(shù)

canceled

numeric

被取消的任務(wù)數(shù)

failed

numeric

已失敗的任務(wù)數(shù)

succeeded

numeric

已成功的任務(wù)數(shù)

<response>

<error>0</error>

<message>{刪除流程成功}</message>

</response>

3.xml

2.5.2查詢?nèi)蝿?wù)

查詢所有任務(wù)。

URL

http:/

/tasks?token={token}&offset={offset}&limit={limit}

請求方式

GET

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

返回數(shù)據(jù)為一個數(shù)組。每個數(shù)組元素代表一條任務(wù)。

1.返回參數(shù)

屬性

類型

說明

id

string

任務(wù)ID

taskflow_id

string

任務(wù)流程ID

priority

numeirc

任務(wù)優(yōu)先級，值越大優(yōu)先級越高。取值范圍

<?xmlver ="1.0"encoding="utf-8"?>

<response>

<total>{傳輸任務(wù)總數(shù)}</total>

<paused>{暫停的任務(wù)數(shù)}</paused>

<running>{正在執(zhí)行任務(wù)數(shù)}</running>

<canceled>{被取消的任務(wù)數(shù)}</canceled>

<failed>{失敗任務(wù)數(shù)}</failed>

<succeeded>{成功的任務(wù)數(shù)}</succeeded>

</response>

“running”:<正在執(zhí)行的任務(wù)數(shù)>,“canceled”:<被取消的任務(wù)數(shù)>,“failed”:<失敗任務(wù)數(shù)>,

“succeeded”:<成功的任務(wù)數(shù)>

}

2.json

3.xml

<?xmlver ="1.0"encoding="utf-8"?>

<responsearray=”true”>

<item>

<id>{任務(wù)ID}</id>

<taskflow_id>{流程ID}</taskflow_id>

<priority>{任務(wù)優(yōu)先級}</priority>

<begin_time>{任務(wù)開始時間}</begin_time>

<end_time>{任務(wù)結(jié)束時間}</end_time>

<s us>{任務(wù)狀態(tài)}</s us>

<percent>{任務(wù)進(jìn)度百分比}</percent>

<message>{任務(wù)處理信息}</message>

<node_index>{任務(wù)所處節(jié)點在流程中的索引}</node_index>

<node_percent>{任務(wù)所處節(jié)點的進(jìn)度百分比}</node_percent>

</item>

……

</response>

[

{

“id”:<任務(wù)ID>,“taskflow_id”:<流程ID>,“priority”:<任務(wù)優(yōu)先級>

“begin_time”:<任務(wù)開始時間>,“end_time”:<任務(wù)結(jié)束時間>,“s us”:<任務(wù)狀態(tài)>,“percent”:<任務(wù)進(jìn)度百分比>,“message”:<任務(wù)處理信息>,

“node_index”:<任務(wù)所處節(jié)點在流程中的索引>,“node_percent”:<任務(wù)所處節(jié)點的進(jìn)度百分比>

},

……

]

0-5

begin_ti

meric

任務(wù)開始時間戳

end_ti

meric

任務(wù)結(jié)束時間戳

s us

string

任務(wù)狀態(tài)：paused–暫停,running–執(zhí)行中,canceled–取消,failed–失敗,succeeded–成功

percent

numeric

任務(wù)完成的百分比

message

string

任務(wù)當(dāng)前進(jìn)度描述信息

node_index

numeric

任務(wù)當(dāng)前所處流程節(jié)點在整個流程中的索引

node_percent

numeric

任務(wù)當(dāng)前所處流程節(jié)點的百分比進(jìn)度

2.5.3新建任務(wù)

根據(jù)指定任務(wù)流程新建任務(wù)。

URL

ht

/tasks?token={token}

請求方式

T

請求數(shù)據(jù)說明

1.請求參數(shù)

2.json

{

“taskflow_id”:<任務(wù)流程ID>,“priority”:<任務(wù)優(yōu)先級>,“callback_url”:<任務(wù)回調(diào)通知url>,“input”:{

“source_files”:{“dir”:{

“path”:<目錄地址>

“user”:< 目錄所使用的用戶名>,“password”:< 目錄所使用的 >

屬性

類型

是否必須

說明

taskflow_id

string

是

任務(wù)所使用的任務(wù)流程ID

priority

numeric

否

任務(wù)優(yōu)先級，值越大優(yōu)先級越高。取值范圍0-5。

callback_url

string

否

任務(wù)完成后的回調(diào)url

input

object

是

任務(wù)的輸入

input.source_files.dir

object

是

遷移任務(wù)的源目錄

input.source_s

stringarray

是

遷移任務(wù)的源文件名（支持多文件）

input. _files.dir

object

是

遷移任務(wù)的目標(biāo)目錄

input. _s

stringarray

否

遷移任務(wù)的目標(biāo)文件名（支持多文件）。如果忽略該參數(shù)，則目標(biāo)文件名與源文件名相同。

3.xml

<?xmlver ="1.0"encoding="utf-8"?>

<request>

<taskflow_id>{任務(wù)流程ID}</taskflow_id>

<priority>{任務(wù)優(yōu)先級}</priority>

<callback_url>{任務(wù)回調(diào)通知url}</callback_url>

<input>

<source_files>

<dir>

<path>{目錄地址}</path>

<user>{ 目錄所使用的用戶名}</user>

<password>{ 目錄所使用的 }</password>

</dir>

<namesarray=”true”>

<item>{源文件名稱1}</item>

<item>{源文件名稱2}</item>

<item>{源文件名稱3}</item>

……

</names>

</source_files>

< _files>

},

“names”:[

<源文件名稱1>,

<源文件名稱2>,

<源文件名稱3>,

……

]

},

“ _files”:{

“dir”:{

“path”:<目錄地址>

“user”:< 目錄所使用的用戶名>,“password”:< 目錄所使用的 >

},

“names”:[

<目標(biāo)文件名稱1>,

<目標(biāo)文件名稱2>,

<目標(biāo)文件名稱3>,

……

]

}

}

}

返回數(shù)據(jù)說明

1.返回參數(shù)

2.json

{

“id”:<任務(wù)ID>,“taskflow_id”:<流程ID>,

“priority”:<任務(wù)優(yōu)先級>,“begin_time”:<任務(wù)開始時間>,“end_time”:<任務(wù)結(jié)束時間>,“s us”:<任務(wù)狀態(tài)>,“percent”:<任務(wù)進(jìn)度百分比>,“message”:<任務(wù)處理信息>,

屬性

類型

說明

id

string

任務(wù)ID

taskflow_id

string

任務(wù)流程ID

priority

numeirc

任務(wù)優(yōu)先級，值越大優(yōu)先級越高。取值范圍

0-5

begin_ti meric

任務(wù)開始時間戳

end_ti meric

任務(wù)結(jié)束時間戳

s us

string

任務(wù)狀態(tài)：paused–暫停,running–執(zhí)行中,canceled–取消,failed–失敗,succeeded–成功

percent

numeric

任務(wù)完成的百分比

message

string

任務(wù)當(dāng)前進(jìn)度描述信息

node_index

numeric

任務(wù)當(dāng)前所處流程節(jié)點在整個流程中的索引

node_percent

numeric

任務(wù)當(dāng)前所處流程節(jié)點的百分比進(jìn)度

<dir>

<path>{目錄地址}</path>

<user>{ 目錄所使用的用戶名}</user>

<password>{ 目錄所使用的 }</password>

</dir>

<namesarray=”true”>

<item>{目標(biāo)文件名稱1}</item>

<item>{目標(biāo)文件名稱2}</item>

<item>{目標(biāo)文件名稱3}</item>

……

</names>

</ _files>

</input>

</request>

3.xml

2.5.4獲取任務(wù)

根據(jù)任務(wù)ID獲取任務(wù)信息

URL

http:/

/tasks/{task-id}?token={token}

請求方式

GET

請求數(shù)據(jù)說明

無

返回數(shù)據(jù)說明

1.返回參數(shù)

<?xmlver ="1.0"encoding="utf-8"?>

<response>

<id>{任務(wù)ID}</id>

<taskflow_id>{流程ID}</taskflow_id>

<priority>{任務(wù)優(yōu)先級}</priority>

<begin_time>{任務(wù)開始時間}</begin_time>

<end_time>{任務(wù)結(jié)束時間}</end_time>

<s us>{任務(wù)狀態(tài)}</s us>

<percent>{任務(wù)進(jìn)度百分比}</percent>

<message>{任務(wù)處理信息}</message>

<node_index>{任務(wù)所處節(jié)點在流程中的索引}</node_index>

<node_percent>{任務(wù)所處節(jié)點的進(jìn)度百分比}</node_percent>

<output></output>

</response>

“node_index”:<任務(wù)所處節(jié)點在流程中的索引>,“node_percent”:<任務(wù)所處節(jié)點的進(jìn)度百分比>,“output”:{

}

}

2.

3.

json

4.

xml

<?xmlver ="1.0"encoding="utf-8"?>

<response>

<id>{任務(wù)ID}</id>

<taskflow_id>{流程ID}</taskflow_id>

<priority>{任務(wù)優(yōu)先級}</priority>

<begin_time>{任務(wù)開始時間}</begin_time>

<end_time>{任務(wù)結(jié)束時間}</end_time>

<s us>{任務(wù)狀態(tài)}</s us>

<percent>{任務(wù)進(jìn)度百分比}</percent>

<message>{任務(wù)處理信息}</message>

<node_index>{任務(wù)所處節(jié)點在流程中的索引}</node_index>

<node_percent>{任務(wù)所處節(jié)點的進(jìn)度百分比}</node_percent>

{

“id”:<任務(wù)ID>,“taskflow_id”:<流程ID>,

“priority”:<任務(wù)優(yōu)先級>,“begin_time”:<任務(wù)開始時間>,“end_time”:<任務(wù)結(jié)束時間>,“s us”:<任務(wù)狀態(tài)>,“percent”:<任務(wù)進(jìn)度百分比>,“message”:<任務(wù)處理信息>,

“node_index”:<任務(wù)所處節(jié)點在流程中的索引>,“node_percent”:<任務(wù)所處節(jié)點的進(jìn)度百分比>,“output”:{

}

}

屬性

類型

說明

id

string

任務(wù)ID

taskflow_id

string

任務(wù)流程ID

priority

numeirc

任務(wù)優(yōu)先級，值越大優(yōu)先級越高。取值范圍

0-5

begin_ti meric

任務(wù)開始時間戳

end_ti meric

任務(wù)結(jié)束時間戳

s us

string

任務(wù)狀態(tài)：paused–暫停,running–執(zhí)行中,canceled–取消,failed–失敗,succeeded–成功

percent

numeric

任務(wù)完成的百分比

message

string

任務(wù)當(dāng)前進(jìn)度描述信息

node_index

numeric

任務(wù)當(dāng)前所處流程節(jié)點在整個流程