盛行-荔枝云网络接入与安全交互平台深入设计接口v1

江苏台荔枝云

——网络接入与安全交互深入设计与接口规范v1.2

1.概述

随着数字化、网络化、文件化的业务系统在

广泛应用，引入越来越多的网络 ，

而且

速度也越来越快，

的特殊性、重要性及其业务系统紧密联系性使得

必须建立一套完善的安全防御体系来抵御

的侵扰。

各个业务系统往往由不同厂商集成，造成了一座座的信息孤岛、应用孤岛、安全孤岛，

共享变得异常

，

对信息整合、应用整合、安全整合等信息化高端需求日益迫切，

希望通过新一代综合业务集成（门户）

发挥其 资产的作用。

，解决孤岛问题，使

资源得以共享，最大化

《

数字化网络化建设白皮书》、《广播电视相关信息系统安全等级保护基本要

求》，建设高效、安全、共享的业务系统，数据安全传输、交换、发布 担负了

各

各系统间进行数据安全、高效交互的任务，将各个不同的业务子网通过TCP/IP、Firewire、

Infiniband等介质连接起来，业务网间的

通过

、杀毒保证了数据来源的安全，

分布式任务调度保证了

的快速高效，其由DSC分布式任务调度中心、MSU

服

务单元、WEB及应用服务中心、MAD消息自动处理中心、数据 中心、

成。

服务中心构

文件服务和HTTP 是安全交互

对外提供的两个

服务。

2.文件服务

2.1功能介绍

各个业务系统处理和交换的最终对象是

文件，而

文件分散在各个不同的

业务网内，安全交互

提供了一套安全有效的文件服务用于处理网内的文件管理和网间的

文件交换。具体来说，文件服务提供了如下功能：

1. 文件管理：可以浏览所有业务网(无论是否以子网、Firewire,Infiniband等措施

)的以

共享、FTP等形式提供的文件或文件夹，并可以对文件、文件夹进行重命名、删除等操作。

2. 流程管理：定制文件迁移处理流程。将文件从一个业务网迁移至另一个业务网时，可以

指定一套相应的处理流程，如迁移前需经过

、杀毒，或者转码等等。

3. 文件迁移：将文件从一个业务网迁移至另一个业务网(无论风间是否以子网、Firewire,

Infiniband等措施

)，并以指定的迁移处理流程进行处理。

2.2使用说明

文件服务以REST风格的HTTPAPI的形式对外提供。调用api需获得ap

和app-secret，第

应用需向

申请来获得。RESTfulAPI输入数据支持xml和json格式，由HTTP请求头

Content-Type标识，“application/xml”表示输入数据为xml格式，“application/json”表示输入数据为json格式；输出数据支持xml和json格式，由HTTP请求头Accept标识，如果没有指定Accept头，默认输出格式为json。

调用API时，正常情况下，会返回API对应的响应。如果调用出错，会返回错误码等信息，错误信息格式如下：

1.Json

2.Xml

为节省篇幅，以下API调用出错返回信息已省略，如无特别说明，调用出错返回信息均如上

述所示。

2.3令牌API

调用其它API之前需调用本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”:<错误描述>

}

请求数据说明

无

返回数据说明

返回参数

1.

2.

Json

3.

Xml

2.4任务流程API

2.4.1查询流程

查询所有任务流程。

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

应用 本API所使用的令牌

expired

numeric

令牌过期时间

请求数据说明

无

返回数据说明

返回数据为一个数组，每个数组元素代表一个任务流程。

返回参数

1.

2.

json

3.

xml

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

<responsearray=”true”>

<item>

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

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

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

<nodesarray=”true”>

<item>{流程节点1}</item>

<item>{流程节点2</item>

<item>{流程节点3}</item>

[

{

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

“description”:<流程描述>

“nodes”:[<流程节点1>,<流程节点2>,<流程节点3>,……]“creation_time”:<流程创建时间>

},

……

]

属性

类型

说明

id

string

任务流程ID

name

string

任务流程名称

description

string

任务流程说明

nodes

stringarray

任务流程的组成节点。当前支持节点有：

DSU( 节点),

ASU(分析节点),

FVS(一级杀毒节点)SecFVS(二级杀毒节点)MAD(上传节点)

creation_ti meric

任务流程创建时间戳

2.4.2创建流程

创建新任务流程。

URL

http:/

/taskflows?token={token}

请求方式

T

请求数据说明

1.请求参数

2.json

{

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

<流程节点1>,

<流程节点2>,

<流程节点3>,

属性

类型

是否必须

说明

name

string

是

新任务流程名称

description

string

否

新任务流程描述信息

nodes

stringarray

是

新任务流程的组成节点。当前支持节点有：

DSU( 节点),

ASU(分析节点),

FVS(一级杀毒节点)SecFVS(二级杀毒节点)MAD(上传节点)

……

</nodes>

<creation_time>{流程创建时间}</creation_time>

</item>

……

</response>

3.xml

返回数据说明

1.返回参数

2.json

3.xml

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

<responsearray=”true”>

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

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

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

<nodesarray=”true”>

<item>{流程节点1}</item>

<item>{流程节点2</item>

{

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

“description”:<流程描述>

“nodes”:[<流程节点1>,<流程节点2>,<流程节点3>,……]“creation_time”:<流程创建时间>

}

属性

类型

说明

id

string

任务流程ID

name

string

任务流程名称

description

string

任务流程说明

nodes

stringarray

任务流程的组成节点。

creation_ti meric

任务流程创建时间戳

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

<request>

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

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

<nodesarray=”true”>

<item>{流程节点1}</item>

<item>{流程节点2}</item>

<item>{流程节点3}</item>

……

</nodes>

</request>

……

]

}

2.4.3获取流程

根据流程ID获取任务流程。

URL

http:/

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

请求方式

GET

请求数据说明

无

返回数据说明

1.返回参数

2.json

{

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

“description”:<流程描述>

“nodes”:[<流程节点1>,<流程节点2>,<流程节点3>,……]“creation_time”:<流程创建时间>

}

属性

类型

说明

id

string

任务流程ID

name

string

任务流程名称

description

string

任务流程说明

nodes

stringarray

任务流程的组成节点。

creation_ti meric

任务流程创建时间戳

<item>{流程节点3}</item>

……

</nodes>

<creation_time>{流程创建时间}</creation_time>

</response>

3.xml

2.4.4删除流程

删除指啊任务流程。

URL

http:/

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

请求方式

DELETE

请求数据说明

无

返回数据说明

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>{流程节点1}</item>

<item>{流程节点2</item>

<item>{流程节点3}</item>

……

</nodes>

<creation_time>{流程创建时间}</creation_time>

</response>

2.5任务API

2.5.1任务统计

获取任务统计信息，包含任务总数，暂停任务数，执行任务数，取消任务数，失败任务数，

成功任务数。

URL

http:/

/tasks/s

istics?token={token}

请求方式

GET

请求数据说明

无

返回数据说明

1.返回参数

2.json

{

“total”:<传输任务总数>,“paused”:<暂停的任务数>,

属性

类型

说明

total

numeric

所有提交的任务总数

paused

numeric

暂停的任务数

running

numeric

正在执行的任务数

canceled

numeric

被取消的任务数

failed

numeric

已失败的任务数

succeeded

numeric

已成功的任务数

<response>

<error>0</error>

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

</response>

3.xml

2.5.2查询任务

查询所有任务。

URL

http:/

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

请求方式

GET

请求数据说明

无

返回数据说明

返回数据为一个数组。每个数组元素代表一条任务。

1.返回参数

属性

类型

说明

id

string

任务ID

taskflow_id

string

任务流程ID

priority

numeirc

任务优先级，值越大优先级越高。取值范围

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

<response>

<total>{传输任务总数}</total>

<paused>{暂停的任务数}</paused>

<running>{正在执行任务数}</running>

<canceled>{被取消的任务数}</canceled>

<failed>{失败任务数}</failed>

<succeeded>{成功的任务数}</succeeded>

</response>

“running”:<正在执行的任务数>,“canceled”:<被取消的任务数>,“failed”:<失败任务数>,

“succeeded”:<成功的任务数>

}

2.json

3.xml

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

<responsearray=”true”>

<item>

<id>{任务ID}</id>

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

<priority>{任务优先级}</priority>

<begin_time>{任务开始时间}</begin_time>

<end_time>{任务结束时间}</end_time>

<s us>{任务状态}</s us>

<percent>{任务进度百分比}</percent>

<message>{任务处理信息}</message>

<node_index>{任务所处节点在流程中的索引}</node_index>

<node_percent>{任务所处节点的进度百分比}</node_percent>

</item>

……

</response>

[

{

“id”:<任务ID>,“taskflow_id”:<流程ID>,“priority”:<任务优先级>

“begin_time”:<任务开始时间>,“end_time”:<任务结束时间>,“s us”:<任务状态>,“percent”:<任务进度百分比>,“message”:<任务处理信息>,

“node_index”:<任务所处节点在流程中的索引>,“node_percent”:<任务所处节点的进度百分比>

},

……

]

0-5

begin_ti

meric

任务开始时间戳

end_ti

meric

任务结束时间戳

s us

string

任务状态：paused–暂停,running–执行中,canceled–取消,failed–失败,succeeded–成功

percent

numeric

任务完成的百分比

message

string

任务当前进度描述信息

node_index

numeric

任务当前所处流程节点在整个流程中的索引

node_percent

numeric

任务当前所处流程节点的百分比进度

2.5.3新建任务

根据指定任务流程新建任务。

URL

ht

/tasks?token={token}

请求方式

T

请求数据说明

1.请求参数

2.json

{

“taskflow_id”:<任务流程ID>,“priority”:<任务优先级>,“callback_url”:<任务回调通知url>,“input”:{

“source_files”:{“dir”:{

“path”:<目录地址>

“user”:< 目录所使用的用户名>,“password”:< 目录所使用的 >

属性

类型

是否必须

说明

taskflow_id

string

是

任务所使用的任务流程ID

priority

numeric

否

任务优先级，值越大优先级越高。取值范围0-5。

callback_url

string

否

任务完成后的回调url

input

object

是

任务的输入

input.source_files.dir

object

是

迁移任务的源目录

input.source_s

stringarray

是

迁移任务的源文件名（支持多文件）

input. _files.dir

object

是

迁移任务的目标目录

input. _s

stringarray

否

迁移任务的目标文件名（支持多文件）。如果忽略该参数，则目标文件名与源文件名相同。

3.xml

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

<request>

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

<priority>{任务优先级}</priority>

<callback_url>{任务回调通知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”:[

<目标文件名称1>,

<目标文件名称2>,

<目标文件名称3>,

……

]

}

}

}

返回数据说明

1.返回参数

2.json

{

“id”:<任务ID>,“taskflow_id”:<流程ID>,

“priority”:<任务优先级>,“begin_time”:<任务开始时间>,“end_time”:<任务结束时间>,“s us”:<任务状态>,“percent”:<任务进度百分比>,“message”:<任务处理信息>,

属性

类型

说明

id

string

任务ID

taskflow_id

string

任务流程ID

priority

numeirc

任务优先级，值越大优先级越高。取值范围

0-5

begin_ti meric

任务开始时间戳

end_ti meric

任务结束时间戳

s us

string

任务状态：paused–暂停,running–执行中,canceled–取消,failed–失败,succeeded–成功

percent

numeric

任务完成的百分比

message

string

任务当前进度描述信息

node_index

numeric

任务当前所处流程节点在整个流程中的索引

node_percent

numeric

任务当前所处流程节点的百分比进度

<dir>

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

<user>{ 目录所使用的用户名}</user>

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

</dir>

<namesarray=”true”>

<item>{目标文件名称1}</item>

<item>{目标文件名称2}</item>

<item>{目标文件名称3}</item>

……

</names>

</ _files>

</input>

</request>

3.xml

2.5.4获取任务

根据任务ID获取任务信息

URL

http:/

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

请求方式

GET

请求数据说明

无

返回数据说明

1.返回参数

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

<response>

<id>{任务ID}</id>

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

<priority>{任务优先级}</priority>

<begin_time>{任务开始时间}</begin_time>

<end_time>{任务结束时间}</end_time>

<s us>{任务状态}</s us>

<percent>{任务进度百分比}</percent>

<message>{任务处理信息}</message>

<node_index>{任务所处节点在流程中的索引}</node_index>

<node_percent>{任务所处节点的进度百分比}</node_percent>

<output></output>

</response>

“node_index”:<任务所处节点在流程中的索引>,“node_percent”:<任务所处节点的进度百分比>,“output”:{

}

}

2.

3.

json

4.

xml

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

<response>

<id>{任务ID}</id>

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

<priority>{任务优先级}</priority>

<begin_time>{任务开始时间}</begin_time>

<end_time>{任务结束时间}</end_time>

<s us>{任务状态}</s us>

<percent>{任务进度百分比}</percent>

<message>{任务处理信息}</message>

<node_index>{任务所处节点在流程中的索引}</node_index>

<node_percent>{任务所处节点的进度百分比}</node_percent>

{

“id”:<任务ID>,“taskflow_id”:<流程ID>,

“priority”:<任务优先级>,“begin_time”:<任务开始时间>,“end_time”:<任务结束时间>,“s us”:<任务状态>,“percent”:<任务进度百分比>,“message”:<任务处理信息>,

“node_index”:<任务所处节点在流程中的索引>,“node_percent”:<任务所处节点的进度百分比>,“output”:{

}

}

属性

类型

说明

id

string

任务ID

taskflow_id

string

任务流程ID

priority

numeirc

任务优先级，值越大优先级越高。取值范围

0-5

begin_ti meric

任务开始时间戳

end_ti meric

任务结束时间戳

s us

string

任务状态：paused–暂停,running–执行中,canceled–取消,failed–失败,succeeded–成功

percent

numeric

任务完成的百分比

message

string

任务当前进度描述信息

node_index

numeric

任务当前所处流程节点在整个流程