TCSES 61-2022 流域水环境管理大数据业务系统接口规范

ICS01.040.35CCSL70/84团体标准T/CSES61—2022流域水环境管理大数据业务系统接口规范Specificationsforbigdataplatformoperationinterfaceofwaterenvironmentmanagementofwatershed（发布稿)2022-07-29发布2022-08-01实施中国环境科学学会发布T/CSES61—2022I目次前言.........................................................................................................................................II1范围...........................................................................................................................................12规范性引用文件.......................................................................................................................13术语和定义...............................................................................................................................14缩略语........................................................................................................................................25接口分类与描述格式...............................................................................................................36物联网传感器数据接口...........................................................................................................47结构化数据接口.......................................................................................................................88非结构化数据类接口...............................................................................................................89流域水环境模型接口...............................................................................................................910服务接口..................................................................................................................................11T/CSES61—2022II前言本文件按照GB/T1.1-2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由北京师范大学提出。本文件由中国环境科学学会归口。本文件起草单位：北京师范大学、山东大学、山东省生态环境规划研究院、中科宇图科技股份有限公司。本文件主要起草人：王国强、薛宝林、张璇、王宝刚、黄鹏飞、谢刚。T/CSES61—20221流域水环境管理大数据业务系统接口规范1范围本文件规定了流域水环境管理大数据业务系统的物联网传感器数据接口、结构化数据接口、非结构化数据接口、流域水环境模型接口、服务接口。本文件适用于流域水环境管理大数据业务系统接口的设计开发及数据共享等应用构建。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T29811.1信息技术学习、教育和培训学习系统体系结构与服务接口GB/T35295信息技术大数据术语GB/T35319物联网系统接口要求GB/T35589信息技术大数据技术参考模型HJ/T418环境信息系统集成技术规范HJ719环境信息系统数据库访问接口规范HJ727环境信息交换技术规范HJ929环保物联网术语3术语和定义下列术语和定义适用于本文件。3.1物联网internetofthings(IoT)通过感知设备，按照约定协议，连接物、人、系统和信息资源，实现对物理和虚拟世界的信息进行处理并作出反应的智能服务系统。[来源：GB/T35319-2017,3.1]3.2接口interface预先定义的为应用程序提供实现一定数据访问、数据处理和数据服务等功能的程序、函数或过程。T/CSES61—202223.3服务service定义明确、具有自包含特性的功能单元，它的存在不依赖于系统上下文或者其他服务的状态。[来源：GB/T29811.1-2013,3.2]3.4传感器sensor依照一定的规则，对物理世界中的客观现象、物理属性进行监测，并将监测结果转化为可以进一步处理的信号的设备。注1：信号可以是电子的、化学的或者其他形式的传感器响应。注2：信号可以表示为1维、2维、3维或更高维度的数据。[来源：HJ929-2017,3.25]3.5WebService一种基于标准的Web协议的可编程组件，是Web服务提供者开放的一系列API，开发人员通过调用这些API来集成Web服务，构建应用程序。3.6非结构化数据unstructureddata不具有预定义模型或未以预定义方式组织的数据。[来源：GB/T35295-2017,2.1.25]4缩略语4.1HTTP超文本传输协议（HyperTextTransferProtocol）4.2API应用程序编程接口（ApplicationProgrammingInterface）4.3SOAP简单对象访问协议（SimpleObjectAccessProtocol）4.4JSON一种轻量级的数据交换格式（JavaScriptObjectNotation）T/CSES61—202234.5RESTful满足一组架构约束条件和原则的应用程序或设计（RepresentationalStateTransfer）4.6UDF用户定义函数（User-DefinedFunction）4.7MR映射化简（MapReduce），是一种用于大数据并行处理的分布式计算模型、框架和平台。4.8OpenMI开放式模型界面（OpenModelingInterface），是一种模型连接标准，提供了实现水文、水力、水质、水生态环境等不同领域模块构成集成系统的连接机制，用以解决复杂系统中各计算模块之间的连接和数据交互问题。5接口分类与描述格式5.1接口分类流域水环境管理大数据业务系统的接口包括数据接口和服务接口两类。数据接口主要完成数据的处理，根据数据采集方式和数据特征，主要包括水环境监测监控物联网采集数据接口，水环境管理业务相关的结构化和非结构化数据接口，以及水模型耦合集成的调用接口。数据接口提供数据类的支持，主要是指对数据的增删改查。服务接口是功能和数据的集合体，主要是完成某一特定功能的运算和展示。5.2接口描述格式接口描述基于如下基本格式：WebService::=METHODENTRY[PARAM][HEADER][STREAM]各字段的含义如表1所示。HTTP请求的返回结果包含两部分：一部分为HTTP消息的状态码(StatusCode)，表示响应的状态；另一部分为HTTP请求消息体，消息体采用JSON格式进行封装。[]为接口中可选项。表1接口描述基本格式说明字段含义METHODHTTP请求方法，本接口中使用到的值有GET，POST，各取值含义参考HTTP协议。ENTRYWEB服务接口的入口地址。PARAM可选参数，用以传递少量的参数信息，例如监测点位编码、时间等。HEADERHTTP请求的消息头部。STREAM可选的附加流信息，用以传递大量的参数信息，例如视频流、图片等。所有接口定义格式说明如下：a）接口名：接口的名称；b）说明：对接口内容的描述；T/CSES61—20224c）调用格式：调用Web服务时的语法格式；d）语义：对调用格式的解释；e）调用结果：Web服务调用结果，包括成功状态和失败状态的下的响应信息。如无特殊说明，所有Web服务接口调用时都应加上表2中的HTTP请求头。表2Web服务接口调用请求说明请求头Header取值ValueContent-Typeapplication/json;charset=utf-8Acceptapplication/json;charset=utf-8注：表头的英文是相应的中文的对照，避免引起歧义。6物联网传感器数据接口6.1物联网传感器接口模型常用的HTTP状态码表示及含义见表3，未列举状态码的名称及含义参考HTTP协议的定义。表3HTTP状态码表状态码状态码名称含义200OK请求已成功。201Created对象或资源已成功创建。202Accepted操作已被成功接受。302Found重定向跳转。400BadRequest请求的内容丢失或不合法。401Unauthorized当前请求需要用户验证。404NotFound请求的内容不存在。405MethodNotAllowed客户端请求中的方法被禁止。409Conflict访问冲突，访问资源已被上锁或可能导致服务器内部状态出错。415UnsupportedMediaType服务器无法处理请求附带的媒体格式。500InternalServerError服务器出现内部错误，无法正确响应请求。503ServiceUnavailable服务器服务暂不可用。流域水环境管理大数据业务系统物联网传感器接口模型开发应遵循GB/T35319和HJ727的规定。传感器模型接口规定了平台管理传感器及数据接入的相关要求，接口名为：BsTable，如表4所示。T/CSES61—20225表4传感器模型接口规范序号说明调用格式接口语义调用结果1创建传感器数据模型。POST/BsTableSTREAM附加流STREAM指定该传感器数据模型所涉及的相关信息，包括但不限于：模型名称、模型标识（模型ID）、传感器标识（传感器ID）、一个或多个传感器的元数据信息等，支持JSON格式。成功状态：返回的HTTP状态码为201。失败状态：返回失败对应的HTTP状态码及采用JSON封装的响应结果。2更新传感器数据模型，主要修改模型基本信息及相关属性。PUT/BsTable/{模型ID}STREAM更新指定模型ID的传感器数据模型的基本信息、属性信息等。附加流STREAM指定需要更新的传感器数据模型，支持JSON格式。成功状态：返回的HTTP状态码为202。失败状态：返回失败对应的HTTP状态码及采用JSON封