TR-REC-033数据跨域互操作技术规范

目录 [隐藏]

    

1 1 范围

2 2 规范性引用文件 3 3 术语和定义 4 4 符号与缩略语 5 5 数据格式定义

o 5.1 5.1 接口的编码方式及响应格式

  

5.1.1 5.1.1 接口编码方式 5.1.2 .1.2 接口响应格式 5.1.3 5.1.3 接口响应请求状态码

o 5.2 5.2科学数据交换格式

 



5.2.1 5.2.1科学数据交换格式定义

5.2.2 5.2.2 科学数据交换格式支持的数据类型

6 5 数据格式定义 o 6.1 6.1 采用协议 o 6.2 6.2 接口安全 o 6.3 6.3 连接方式 o 6.4 6.4 技术实现 o 6.5 6.5 接口列表 o 6.6 6.6建库单位开放接口



6.6.1 6.6.1 数据获取接口     

6.6.1.1 6.6.6.1 dhGetDatabaseList 6.6.1.2 6.6.6.2 dhGetDatabaseSchema 6.6.1.3 6.6.6.3 dhGetIndexes

6.6.1.4 6.6.6.4 dhGetIndexModifications

6.6.2 6.6.2 数据访问接口    

6.6.2.1 6.6.2.1 daiGetRecord 6.6.2.2 6.6.2.2 uiGetRecord 6.6.2.3 6.6.2.3 daiQuery 6.6.2.4 6.6.2.4 uiQuery



 

6.6.2.5 6.6.6.5 daiGetFile

7 附录 A（资料性附录） OpenURL 8 附录 B（资料性附录） CQL o 8.1 B.1 简单词汇 o 8.2 B.2 关系表达式

  

8.2.1 B.2.1 关系运算符 8.2.2 B.2.2 关系修饰符 8.2.3 B.2.3 映射集合

o 8.3 B.3 布尔表达式：





8.3.1 B.3.1 布尔运算符

9 附录 C（资料性附录） MIME

1 范围

本规范规定了中国科学院数据应用环境建设与服务项目内数据跨域互操作接口采用的协议，连接方式，调用参数以及数据的返回格式。

2 规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。



GB 18030-2005 信息技术 中文编码字符集

3 术语和定义

下列术语和定义适用于本规范。



 资源 resource

可以被标识的实体对象或服务。

在本规范准中，特指可被标识的数据集、数据或服务。



数据集 dataset

由相关数据组成的可标识集合。一个数据集可能是一个较小的数据集合，在物理上或逻辑上位于一个较大的数据集之内；反之，一个数据集也可能由若干数据集组成，是这些子数据集的父数据集。

本规范中，数据集指中国科学院数据应用环境建设与服务项目的主题数据库、参考数据库、专题数据库、专业数据库及其各级子库。



数据 data

对事实、概念或指令的一种形式化表示，适用于以人工或自动方式进行通信、解释或处理。

本规范中，数据是指所有能输入到计算机并被计算机程序处理的符号的介质的总称，是用于输入电子计算机进行处理，具有一定意义的数字、字母、符号和模拟量等的通称。



服务 service

本规范中，服务是指数据应用环境建设与服务项目中数据集满足应用系统或者人的需要时，与之发生的“直接”接触行为及有关结果。



标识符 identifier

用于标识数据对象或服务项目的一组字符。

4 符号与缩略语

URI 统一资源标识符（Uniform Resource Identifier） URL 统一资源定位符（Uniform Resource Locator） XML 可扩展标记语言（Extensible Markup Language）

5 数据格式定义

5.1 接口的编码方式及响应格式

5.1.1 接口编码方式

接口响应的数据基于xml语言格式，编码方式采用自定义编码的方式（常用编码方式包括：UTF-8、GBK、GB2312、ISO-8859-1等），接口响应数据所使用的编码方式必须在返回XML头信息的encoding属性中说明。 例如：

.1.2 接口响应格式

请求服务响应的状态码 相关信息

5.1.3 接口响应请求状态码

以下状态码只列出接口中遇到的普遍问题，可根据数据库建库规范中规定的范围增加。 通用状态码 相关说明 200 400 401 402 403 404 408 500

响应状态码返回格式：

服务调用成功 请求格式错误 未授权访问 不可识别的verb 服务器拒绝访问 指定的资源未找到 请求超时 服务器内部错误

响应请求状态码

响应请求状态码的描述

5.2科学数据交换格式

科学数据交换格式：SDEF（Scientific Data Exchange Format）中国科学院科学数据库集成不同学科领域的数据，数据类型也各不相同，异地数据的交互非常困难，SDEF使用统一的格式对数据进行封装，为资源共享与透明访问提供保障。

5.2.1科学数据交换格式定义

原始数据

5.2.2 科学数据交换格式支持的数据类型

元素与

整型类型：long

value:数值（int、long等） title:空 sdef示例：

512

浮点型类型：double

value:数值（float、double等）

title:数值的文本（可以是普通的显示方法，也可以用科学计数法显示） sdef示例：

31.4159

日期时间类型：date

value: 从 1970 年 1 月 1 日 00:00:00 GMT 以来的毫秒数；负数表示在 1970 年 1 月 1 日 00:00:00 GMT 之前的毫秒数 title: yyyy-MM-dd格式的时间 sdef示例：

1228061164796

HTML类型：html value:HTML字符串 title: 纯文本内容字符串 sdef示例：

查看课程信息

超链接类型：hyperlink

value:超链接字符串（包括http、ftp链接等） title: 空 sdef示例：

http://vdbstu.vdb.csdb.cn/course

枚举类型：enum value:键

title: 键所对应的值 sdef示例：

1

表达式类型：expression value:表达式计算出的结果 title:表达式计算出来结果的显示 sdef示例：

62.8

文件类型：files增加接口 value:

title: 文件标题列表 sdef示例：

1f62831923a78f8a0123a7fc4c5a00c3 402880e823b2359c0123b2534caf001

引用类型：

value: 引用记录的uri title: 引用记录title字段的标题 sdef示例：

cn.csdb.vdb.vdbstu.course/1001

集合类型： value：

< items>

引用记录的id（带/的格式）

title：记录数 sdef示例：

< items>

cn.csdb.vdb.vdbstu.teacher/1001 cn.csdb.vdb.vdbstu.teacher/1003 cn.csdb.vdb.vdbstu.teacher/1005

化学结构式：ChemStructure value: SMILES字符串 title: 空 sdef示例：

C1=CC2=C(C=C1)C=CC=C2 < title>

5 数据格式定义

6.1 采用协议

HTTP1.1（超文本传输协议）

超文本传输协议（HTTP）是一种为分布式，合作式，超媒体信息系统。它是一种通用的，无状态（stateless）的协议，除了应用于超文本传输外，它 也可以应用于诸如名称服务器和分布对象管理系统之类的系统，这可以通过扩展它的请求方法，错误代码和报头来实现。HTTP的一个特点是数据表现形 式是可输入的和可协商性的，这就允许系统能被建立而独立于数据传输。

HTTP是一个客户端和服务器端请求和应答的标准（TCP）。客户端是终端用户，服务器端是网站。通常，由HTTP客户端发起一个请求，建立一个到服务器指定端口（默认是80端口）的TCP连接。HTTP服务器则在那个端口监听客户端发送过来的请求。 一旦收到请求，服务器（向客户端）发回一个状态行，比如\"HTTP/1.1 200 OK\"，和（响应的）消息，消息的消息体可能是请求的文件、错误消息、或者其它一些信息。

6.2 接口安全

采用基于IP地址的身份验证方式。在服务调用的过程中，服务提供者获取调用者的ip地址，在本地保存的授权访问ip地址列表中查询，认证通过执行服务返回数据，不通过则拒绝服务。 认证流程如下图所示：

图6-1基于ip地址的身份认证方式 拒绝服务返回数据格式：

403

服务拒绝访问-ip地址认证未通过

6.3 连接方式

POST方式（必须实现）：

POST 方法被用于请求源服务器接受请求中的实体作为请求资源的一个新的从属物。 POST方法的实际功能是由服务器决定的，并且经常依赖于请求URI（Request-URI）。POST提交的实体是请求URI的从属物，就好像一个文件从属于一个目录，一篇新闻文章从属于一个新闻组，或者一条记录从属于一个数据库。 POST方法的响应是可缓存的。 GET方式（可选）：

GET方法意思是获取被请求URI（Request-URI）指定的信息（以实体的格式）。如果请求URI涉及到一个数据生成过程，那么这个生成的数据应该被作为实体在响应中返回，但这并不是过程的资源文本，除非资源文本恰好是过程的输出。 GET请求的响应是可缓存的。

6.4 技术实现

接口采用OpenURL技术实现，OpenURL技术规范详见附录A。 接口语法格式说明： http://url/service?[query]

[?]号前面为科学数据库参建单位提供的服务地址，需要在资源注册系统(http://rsr.csdb.cn)中注册。只有注册的服务科学数据中心才可以进行访问。

[query]部分包括多组参数名称与参数值，其中最主要的verb参数，定义了访问服务的具体名称见接口列表中的接口名称。

6.5 接口列表

本规范接口列表见下表： 接口提供方 接口类型 接口名称 dhGetDatabaseList dhGetDatabaseSchema 数据获取接口 dhGetIndexes 接口描述 获取数据集列表接口 数据库结构获取接口 全部索引数据收割接口 dhGetIndexModifications 增量索引数据收割接口 建库单位 daiGetRecord uiGetRecord 数据访问接口 daiQuery uiQuery daiGetFile 数据访问接口 数据显示页面获取接口 数据集成检索接口 检索页面获取接口 获取文件描述信息接口 6.6建库单位开放接口

6.6.1 数据获取接口

6.6.6.1 dhGetDatabaseList

接口说明：

数据获取接口，获得所有数据集唯一访问标识列表 请求参数说明：

verb：dhGetDatabaseList 调用示例：

http://url/service?verb=dhGetDatabaseList 响应格式说明：

响应格式示例：

cn.csdb.plants cn.csdb.nano

6.6.6.2 dhGetDatabaseSchema

接口说明：

数据获取接口，根据数据集唯一访问标识，获得数据库结构信息 请求参数说明：

verb：dhGetDatabaseSchema uri：数据集唯一访问标识 调用示例：

http://url/service?verb=dhGetDatabaseSchema&uri=cn.csdb.plants 响应格式说明：

数据集Uri

实体名称

实体Uri，往往是数据集Uri.实体名 实体描述信息

主键字段

属性名称

属性Uri，往往是实体Uri.属性名 属性的类型

[可选项。当该属性是引用或集合类型时表示关联到哪个实体上]

视图类型，若source为数据集，则此处为listEntities（实体列表）；若source为实体，则此处有listBeans（概览视图）、showBean（细览视图）、queryEntity（查询视图）、indexEntity（索引视图）四种 数据集Uri或实体Uri

若上层为数据集，则此处表示哪些实体；若上层为实体，则此处表示哪些属性

响应格式示例：

cn.csdb.vdb.vdbstu

course

cn.csdb.vdb.vdbstu.course

cn.csdb.vdb.vdbstu.course.id

course

cn.csdb.vdb.vdbstu.course.course String

teacher

cn.csdb.vdb.vdbstu.course.teacher collection

cn.csdb.vdb.vdbstu.teacher

indexEntity

cn.csdb.vdb.vdbstu.stu

cn.csdb.vdb.vdbstu.stu.id

cn.csdb.vdb.vdbstu.stu.stuname /item>

6.6.6.3 dhGetIndexes

接口说明：

数据获取接口，索引数据收割接口（数据唯一访问标识） 请求参数说明： verb：dhGetIndexes uri：数据表唯一标识

beginIndex：收割的起始标识（可选参数） size：每次收割的记录数量（可选参数） 调用示例：

http://url/service?verb=dhGetIndexes&uri=cn.csdb.gibss.phase_transition.Density_critical&beginIndex=1&size=10000 响应格式说明：

总记录数

下次收割起始uri

响应格式示例：

3

cn.csdb.gibbs.phase_transition.T_boiling/1004cn.csdb.gibbs.phase_transition.T_boiling/1001

cn.csdb.gibbs.phase_transition.T_boiling/1002 cn.csdb.gibbs.phase_transition.T_boiling/1003

6.6.6.4 dhGetIndexModifications

接口说明：

数据获取接口，增量索引数据收割接口 请求参数说明：

verb：dhGetIndexModifications uri：数据表唯一标识

beginIndex：收割的起始标识（可选参数） size：每次收割的记录数量（可选参数） startDate：增量收割开始日期 endDate：增量收割结束日期 增量收割如没有数据，显示格式如下

200

服务调用成功

0

数据收割起始标识

调用示例：

http://url/service?verb=dhGetIndexModifications&uri=cn.csdb.gibss.phase_transition.Density_critical&beginIndex=1&size=10000&startDate=2009-01-01&endDate=2009-02-05

响应格式说明：

总记录数

下次收割起始uri

响应格式示例：

3 4

cn.csdb.gibbs.phase_transition.T_boiling/1001 I

cn.csdb.gibbs.phase_transition.T_boiling/1002 U

cn.csdb.gibbs.phase_transition.T_boiling/1003 D

6.6.2 数据访问接口

6.6.2.1 daiGetRecord

接口说明：

数据访问接口，根据数据唯一访问标识，获取数据（索引）记录的信息 请求参数说明： verb：daiGetRecord

uri：数据唯一访问标识 调用示例：

http://url/service?verb=daiGetRecord&uri=cn.csdb.gibbs.phase_transition.T_boiling/1001

响应格式说明：

数据访问url地址

数据表字段的uri 科学数据

响应格式示例：

数据访问地址

id(主键)

58003696