TR-REC-032 元数据访问服务接口规范

I基础科学数据共享网项目标准TR-REC-032元数据访问服务接口规范2011年3月国家科技基础条件平台建设基础科学数据共享网项目组II目次1范围...............................................................................12规范性引用文件.....................................................................13术语和定义.........................................................................14符号与缩略语.......................................................................25数据格式定义.......................................................................35.1接口的编码方式及响应格式.........................................................35.1.1接口编码方式.................................................................35.1.2接口响应格式.................................................................35.1.3接口响应请求状态码...........................................................36接口规范...........................................................................46.1采用协议.........................................................................46.2接口安全.........................................................................56.3连接方式.........................................................................66.4技术实现.........................................................................66.5接口列表.........................................................................66.6建库单位开放接口..................................................................76.6.1元数据收割接口...............................................................76.6.2其他接口.....................................................................13附录A（资料性附录）OpenURL........................................................181元数据访问服务接口规范1范围本规范规定了国家科技基础条件平台建设基础科学数据共享网项目（以下简称基础科学数据共享网项目）内元数据访问服务接口采用的协议、连接方式、调用参数以及数据的返回格式。本规范适用于基础科学数据共享网项目中元数据访问服务接口。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB18030-2005信息技术中文编码字符集TR-REC-014核心元数据标准TR-REC-017资源唯一标识符规范3术语和定义下列术语和定义适用于本规范。资源resource可以被标识的实体对象或服务。在本规范准中，特指可被标识的数据集、数据或服务。数据集dataset2由相关数据组成的可标识集合。一个数据集可能是一个较小的数据集合，在物理上或逻辑上位于一个较大的数据集之内；反之，一个数据集也可能由若干数据集组成，是这些子数据集的父数据集。本规范中，数据集指基础科学数据共享网项目的主题数据库、专题数据库、专业数据库及其各级子库。数据data对事实、概念或指令的一种形式化表示，适用于以人工或自动方式进行通信、解释或处理。本规范中，数据是指所有能输入到计算机并被计算机程序处理的符号的介质的总称，是用于输入电子计算机进行处理，具有一定意义的数字、字母、符号和模拟量等的通称。服务service本规范中，服务是指基础科学数据共享网项目中数据集满足应用系统或者人的需要时，与之发生的“直接”接触行为及有关结果。标识符identifier用于标识数据对象或服务项目的一组字符。资源唯一标识符resourceuniqueidentifier唯一标识资源的一组字符。4符号与缩略语URI统一资源标识符（UniformResourceIdentifier）URL统一资源定位符（UniformResourceLocator）XML可扩展标记语言（ExtensibleMarkupLanguage）35数据格式定义5.1接口的编码方式及响应格式5.1.1接口编码方式接口响应的数据基于xml语言格式，编码方式采用自定义编码的方式（常用编码方式包括：UTF-8、GBK、GB2312、ISO-8859-1等），接口响应数据所使用的编码方式必须在返回XML头信息的encoding属性中说明。例如：?xmlversion=1.0encoding=UTF-8?5.1.2接口响应格式?xmlversion=1.0encoding=UTF-8?responsehead!--response头信息--code请求服务响应的状态码/codemessage相关信息/message/headbody!--response具体信息，接口返回的信息全部封装在body中--/body/response5.1.3接口响应请求状态码以下状态码只列出接口中遇到的普遍问题，可根据数据库建库规范中规定的范围增加。4通用状态码相关说明200服务调用成功400请求格式错误401未授权访问402不可识别的verb403服务器拒绝访问404指定的资源未找到408请求超时500服务器内部错误响应状态码返回格式：?xmlversion=1.0encoding=UTF-8?responseheadcode响应请求状态码/codemessage响应请求状态码的描述/message/headbody!—接口返回的具体数据--/body/response6接口规范6.1采用协议HTTP1.1（超文本传输协议）超文本传输协议（HTTP）是一种为分布式，合作式，超媒体信息系统。它是一种通用的，无状态（stateless）的协议，除了应用于超文本传输外，它也可以应用于诸如名称服务器和分布对象管理系统之类的系统，这可以通过扩展它的请求方法，错误代码和报头来实现。HTTP的一个特点是数据表现形式是可输入的和可协商性的，这就允许系统能被建立而独立于数据传输。5HTTP是一个客户端和服务器端请求和应答的标准（TCP）。客户端是终端用户，服务器端是网站。通常，由HTTP客户端发起一个请求，建立一个到服务器指定端口（默认是80端口）的TCP连接。HTTP服务器则在那个端口监听客户端发送过来的请求。一旦收到请求，服务器（向客户端）发回一个状态行，比如HTTP/1.1200OK，和（响应的）消息，消息的消息体可能是请求的文件、错误消息、或者其它一些信息。6.2接口安全采用基于IP地址的身份验证方式。在服务调用的过程中，服务提供者获取调用者的IP地址，在本地保存的授权访问IP地址列表中查询，认证通过执行服务返回数据，不通过则拒绝服务。认证流程如下图所示：验证访问ip获得服务调用者ip调用服务返回数据YES拒绝服务NO图6-1基于IP地址的身份认证方式拒绝服务返回数据格式：?xmlversion=1.0encoding=UTF-8?responseheadcode403/codemessage服务拒绝访问-ip地址认证未通过/message/headbody/body/response66.3连接方式POST方式（必须实现）：POST方法被用于请求源服务器接受请求中的实体作为请求资源的一个新的从属物。POST方法的实际功能是由服务器决定的，并且经常依赖于请求URI（Request-URI）。POST提交的实体是请求URI的从属物，就好像一个文件从属于一个目录，一篇新闻文章从属于一个新闻组，或者一条记录从属于一个数据库。POST方法的响应是可缓存的。GET方式（可选）：GET方法意思是获取被请求URI（Request-URI）指定的信息（以实体的格式）。如果请求URI涉及到一个数据生成过程，那么这个生成的数据应该被作为实体在响应中返回，但这并不是过程的资源文本，除非资源文本恰好是过程的输出。GET请求的响应是可缓存的。6.4技术实现接口采用OpenURL技术实现，OpenURL技术规范详见附录A。接口语法格式说明：[query][?]号前面为基础科学数据共享网参建单位提供的服务地址，需要在资源注册系统()中注册。只有注册的服务科学数据中心才可以进行访问。[query]部分包括多组参数名称与参数值，其中最主要的verb参数，定义了访问服务的具体名称见接口列表中的接口名称。6.5接口列表本规范所涉及的接口见下表：接口提供方接口类型接口名称接口描述建库单位元数据收割接口dhGetDatabaseMetadata核心元数据获取接口dhGetCatalog概念树收割接口7其他接口缺省接口基本信息获取接口sysDatabaseStatistic数据库统计接口sysGetEntityList数据表记录数获得接口cmsGetNews新闻收割接口sysStatus服务状态监控接口6.6建库单位开放接口6.6.1元数据收割接口6.6.1.1dhGetDatabaseMetadata接口说明：元数据收割接口，根据数据集唯一标识，获得当前数据集的核心元数据信息请求参数说明：verb：dhGetDatabaseMetadatauri：数据集唯一标识调用示例：=dhGetDatabaseMetadata&uri=cn.csdb.plants响应格式说明：详见《TR-REC-014核心元数据标准标准》响应格式示例：datasetdescriptionInfotitle名称/titleuri唯一标识符/urikeyword关键词（可重复）/keywordintroduction简介/introductionpurpose目的/purpose8type类型/typecreator创建者（可重复）/creatorcontributor其他贡献者/contributorsource来源/sourcecreationDa