电力行业自主可控域控平台接口规范.docxVIP

1

T/NSSQ-2022

电力行业自主可控域控平台接口规范

1范围

本文件规定了电力行业自主可控域控平台接口规范的数据接口方式和数据调用接口。本文件适用于电力行业自主可控域控平台接口的设计、编程和应用开发。

2规范性引用文件

本文件没有规范性引用文件。

3术语和定义

下列术语与定义适用于本文件。3.1

接口interface

预先定义的为应用程序提供实现一定数据访问、数据处理和数据服务等功能的程序、函数或过程。

4缩略语

下列缩略语适用于本文件。ID：标识符（IDentity）；

IP:网际互连协议（InternetProtocol）；

JSON∶一种轻量级的数据交换格式（JavaScriptObjectNotation）；USB:通用串行总线(UniversalSerialBus)。

5数据接口方式

5.1数据接入流程

5.1.1入域退域

入域退域主要管控自主可控操作系统终端进行入域（退域）操作以纳入（退出）自主可控操作系统域控平台管理范围的操作，以实现自主可控操作系统终端的统一基本准入管理功能。

入域退域从统信组件到域控平台的数据流向接口包括如下3种：

a)终端加域接口；

b)终端用户登录认证接口；

c)终端退域接口。

2

T/NSSQ-2022

5.1.2数据上报

数据上报主要把已纳入自主可控操作系统域控平台管理范围的自主可控操作系统终端主机的各种详细信息如设备系统名、别名、IP地址、硬件信息、终端状态、用户信息等信息上报给平台，供平台进行统一的终端信息收集、规整和可视化统计展示，为上层拓展业务逻辑提供数据支撑。

数据上报从统信组件到域控平台的数据流向接口包括如下2种：

a)终端信息上报接口；

b)客户端上报USB接入记录接口。

数据上报从域控平台到统信组件的数据流向接口包括：获取终端信息接口。

5.1.3策略下发

策略下发主要把自主可控操作系统域控平台中的统一域策略库中维护的策略统一下发至各个终端，策略下发可向目标终端发起主动拉取策略的通知，让自主可控操作系统终端即时拉取策略信息，也可以由自主可控操作系统终端定时拉取策略信息。

策略下发从域控平台到统信组件的数据流向接口包括：策略下发通知接口。

5.2身份认证要求

调用方需申请对应appid和appsecret。

注：appid即应用的唯一标识，appsecret即私匙。

5.3接口传输要求

接口使用JSON传输数据，具备通用性和可扩展性。

5.4数据接口描述

数据接口具体描述如下：

a）接口名称：电力行业自主可控域平台调用接口；

b）接口描述：调用方需申请对应appid和appsecret，以判断用户是否为合法用户；

c）接口地址：接口调用的地址；示例1：/gateway/ads/domain/leaved）请求方式：POST；

e）接口标识符：/application/json；

f）请求示例：请求数据的接口地址示例说明；示例2：body参数

{

machine_id:caa31d96b72d1a44bfed8be9ece2665b,username:wcc1,

mac:00:0C:29:CC:74:2F}

g）输入参数：访问接口所需的参数，见6.1；h）返回参数：请求反馈的结果，见6.2。

3

T/NSSQ-2022

6数据调用接口

6.1输入参数

电力行业自主可控域平台调用接口输入参数及说明见表1。

表1电力行业自主可控域平台调用接口输入参数及说明

输入参数

说明

GET

查询数据

POST

新增数据

PUT

更新数据，调用者提供完整数据，要求幂等性

DELETE

删除数据，要求幂等性

PATCH（UPDATE）

更新数据，调用者提供需改变数据

6.2返回参数

电力行业自主可控域平台调用接口返回参数及说明见表2。

表2电力行业自主可控域平台调用接口返回参数及说明

参数编号

返回参数

输入参数类型

说明

备注

200

OK

GET

服务器成功返回用户请求的数据，该操作是幂等的

幂等的

201

CREATED

POST/PUT/PATCH

用户新建或修改数据成功

/

202

Accepted

米

表示一个请求已经进入后台排队

异步任务

204

NOCONTENT

DELETE

用户删除数据成功

/

400

INVALIDREQUEST

POST/PUT/PATCH

用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的

幂等的

401

Unauthorized

米

表示用户没有权限

令牌、用户名、密码错误

403