Q／GDW 12105-2021  电力物联网数据中台服务接口规范

5.6数据服务接口运行维护

5.6数据服务接口运行维护

5.6.1监控及异常处理

为确保服务接口的有效运行，需常态开展服务接口运行的巡查监控，及时处理服务接口异常，主 要的服务接口监控及异常处理规则如下： a 基于数据中台数据服务接口监控管理功能，按照服务接口对应的业务应用调用频度分别设置 监控规则，并进行服务接口的常态监控： b 根据服务接口监测发现的异常，按以下处理规则进行服务接口异常的处理： 1 针对服务接口状态失效的异常情况，按照服务接口标准操作流程，进行服务状态的重启， 并监测服务接口重启后的状态； 2 针对服务接口访问延迟、响应时间过长，结合监测日志分析结果石油天然气标准规范范本，进行服务接口的访问 流量的优化配置或其他井发参数配置； 3 针对服务接口异常重启或参数配置优化无法解决的异常，转入服务接口故障分析处理流 程，进行详细分析处理。

版本更新分为新版本上线和旧版本下线两个阶段，数据服务接口版本更新如图3所示，具体要求如 a) 数据服务提供者在数据中台数据服务组件注册新版本数据服务接口； b 数据中台数据服务组件发布新版本数据服务并自动替换老版本数据服务，同时下线老版本数 据服务； C）数据服务调用者调用新版本数据服务

图3数据服务接口版本更新

5. 6. 4下线退出

Q/GDW12105202

服务接口应月 服务，服务接口下线退出按以下规则开展： a）自动退出：按照服务接口创建时设置的有效期时间条件及版本升级等其他触发约束条件，在 服务接口达到运行时长并满足退出条件时，由数据中台数据服务组件自动设置服务接口为下 线状态，实现服务接口的自动退出； b） 手动退出：是指根据对服务接口的监测以及服务接口版本的迭代更新要求，进行服务接口手 动下线退出

5.7数据服务接口安全要求

数据服务接口安全应满足以下要求： a）数据服务封装的数据必须满足数据安全要求，对于涉密数据，需进行脱敏处理或者特殊加密； b）数据服务接口安全日志至少保存6个月以上； C）数据服务访问权限按照公司数据分级分类权限等级管理要求进行授权管理。

表1WebService协议栈

表2RESTService协

Q/GDW121052021

6.2数据服务接口命名

应采用基于XML的数据格式，RESTService应采

一个资源应具有一个或多个标识，采用URI作为资源标识。为保证URI的可寻址性和可读性，采用 路径变量来表达资源层次结构，URL全部采用小写字母及数字，至少两层，根据场景支持多级分类。URL 定义规则如下： (通信协议)//(数据服务网关地址)/(服务所属应用域)/《版本号)/(子目录)//(子目录

6.3数据服务接口创建

数据服务接口创建应基于数据中台数据服务组件完成，包括操作请求和返回应答两部分。数 接口创建请求参数包括但不限于表4内容，数据服务接口创建返回参数包括但不限于表5内容。

Q/GDW 121052021

表4数据服务接口创建请求参数

表5数据服务接口创建返回参数

6.4数据服务接口发布

数据服务接口发布应基于数据中台数据服务组件完成，包括操作请求和返回应答两部分。数 接口发布请求参数包括但不限于表6内容，数据服务接口发布返回参数包括但不限于表7内容。

表6数据服务接口发布请求参数

表7数据服务接口发布返回参数

6.5数据服务接口授权

数据服务提供者根据数据服务调用者申请的数据服务权限，进行审核及授权，确保数据访问的独 立性和安全性，示例见附录A。数据服务接口授权应基于数据中台数据服务组件完成，包括操作请求和 返回应答两部分。数据服务接口授权请求参数包括但不限于表8内容，数据服务接口授权返回参数包括 但不限于表9内容。

Q/GDW121052021

表8数据服务接口授权请求参数

表9数据服务接口授权返回参数

6.6数据服务接口查看

数据服务接口查看应基于数据中台数据服务组件完成， 包括操作请求和返回应答两部分。数 接口查看请求参数包括但不限于表10内容， 数据服务接口查看返回参数包括但不限于表11内容

表10数据服务接口查看请求参数

表11数据服务接口查看返回参数

6.7数据服务接口认证

调用数据服务API接口应选择一种或多种认证方式进行认证，具体如下： a APPKey认证，通过AppKey和AppSecret进行签名认证； b) Basic认证，采用HTTP的BASIC认证方式，后端服务通过用户名和密码进行认证； C PublicKey认证，采用AuthAdv的TokenNE认证，后端服务通过公钥验证Token进行认证； d）无认证，可直接调用API，无需认证。

6.8数据服务接口调用

服务请求方法包括新增、删除等，见表12。

Q/GDW12105202

6.8.2HTTP状态码

HTTP响应状态码定义应遵从RFC7231协议，见表13所示，资源应尽量保证不返回除200以外的 态码。

表13HTTP状态码

当资源返回的HTTP状态码为200时，资源返回数据应为JSON或XML格式的数据。数据中应包含资源 调用是否成功、异常代码、异常原因、业务数据等信息，示例如下： success：true,//返回正确或错误 errcode：//当success为false时，组件自定义的错误代码

Q/GDW 121052021

errinf：//当success为false时，组件自定义的错误信息 ：//返回的业务数据

errinf：//当success为false时，组件自定义的错误信息 ：//返回的业务数据

A.1数据服务请求示例

A.2数据服务XML格式返回示例。

据服务.JSON格式返回示

Q/GDW12105202

附录A （资料性附录） 数据服务请求及返回应答示例

电力物联网数据中台服务接口规范

Q/GDW12105202

编制背景. 编制主要原则， 与其他标准文件的关系.. 主要工作过程 标准结构和内容... 条文说明 15

尔 主要原则， 14 也标准文件的关系.. 14 工作过程 结构和内容.. 说明..

本标准依据《国家电网有限公司关于下达2019年第二批技术标准制修订计划的通知》（国家电网 科（2019）807号文）的要求编写。 本标准编制背景是随着公司业务发展和信息化建设推进，对于海量业务数据处理、存储和应用提 出了更高要求，结合先进互联网企业的中台思维和技术的发展和成熟应用上海标准规范范本，在电力企业也函需开展数 据中台的建设，因此有必要制定数据中台相关标准，为支撑数据中台建设提供标准和参考依据。 本标准编制的主要目的是制定数据中台服务接口开发、调用等应满足的要求。

本标准根据以下原则编制： a 坚持先进性与实用性相结合、统一性与灵活性相结合、可靠性与经济性相结合的原则，以标 准化为引领，服务公司科学发展； b）本标准遵循公司信息化“十三五”规划、电力物联网规划、数据中台技术方案： c）认真研究国内外现行相关的IEC标准、国家标准、行业标准、企业标准，体现安全设计框架 的最新发展。

3与其他标准文件的关系

本标准与相关技术领域的国家现行法律、法规和政策保持一致。 本标准不涉及知识产权问题。

2019年8月，项目正式启动，成立项目编写组，确立分工与职责，制定工作计划。 2019年8月，编写组通过调研和分析，起草了本部分标准草案稿，并组织内部专家对草案稿的内 容、格式等进行了认真讨论，提出了修改意见，会后编写组根据专家意见进行了修改，形成标准初稿。 2019年9月，公司互联网技术标准专业工作组（TC06）在北京组织专家对本部分初稿进行了评审 并提出了修改意见。 2019年9月，完成标准征求意见稿编写，采用函件方式，广泛、多次向国网公司主管部门及省公 同专家征求意见和建议。 2019年10月至11月，多次召开工作组会议，听取各方面意见，进行修改、完善和补充，形成标 准送审。 2019年12月，公司互联网技术标准专业工作组（TC06）在北京组织召开了标准审查会，审查结 论为：经审查组协商一致，同意修改后报批。 2019年12月，修改形成报批稿

本标准按照《国家电网公司技术标准管理办法》（国家电网企管（2018）222号文）的要求编 本标准的主要结构和内容如下：

过滤器标准Q/GDW12105202

本标准主题章分为2章：包括总体要求、数据服务接口技术要求。 第5章总体要求明确了数据服务接口使用流程、以及从需求设计到运行维护的要求； 第6章数据服务接口技术要求明确了数据服务接口形式、接口命名以及从数据服务接口创建到接 口调用全流程的技术要求。

本标准主题章分为2章：包括总体要求、数据服务接口技术要求。 第5章总体要求明确了数据服务接口使用流程、以及从需求设计到运行维护的要求； 第6章数据服务接口技术要求明确了数据服务接口形式、接口命名以及从数据服务接口创建至 调用全流程的技术要求。