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

1T/NSSQ-2022电力行业自主可控域控平台接口规范本文件规定了电力行业自主可控域控平台接口规范的数据接口方式和数据调用接口。本文件适用于电力行业自主可控域控平台接口的设计、编程和应用开发。2规范性引用文件本文件没有规范性引用文件。3术语和定义下列术语与定义适用于本文件。3.1接口interface预先定义的为应用程序提供实现一定数据访问、数据处理和数据服务等功能的程序、函数或过程。4缩略语下列缩略语适用于本文件。ID：标识符（IDentityIP:网际互连协议（InternetProtocolJSON∶一种轻量级的数据交换格式（JavaScriptObjectNotationUSB:通用串行总线(UniversalSerialBus)。5数据接口方式5.1数据接入流程5.1.1入域退域入域退域主要管控自主可控操作系统终端进行入域（退域）操作以纳入（退出）自主可控操作系统域控平台管理范围的操作，以实现自主可控操作系统终端的统一基本准入管理功能。入域退域从统信组件到域控平台的数据流向接口包括如下3种：a)终端加域接口；b)终端用户登录认证接口；c)终端退域接口。2T/NSSQ-20225.1.2数据上报数据上报主要把已纳入自主可控操作系统域控平台管理范围的自主可控操作系统终端主机的各种详细信息如设备系统名、别名、IP地址、硬件信息、终端状态、用户信息等信息上报给平台，供平台进行统一的终端信息收集、规整和可视化统计展示，为上层拓展业务逻辑提供数据支撑。数据上报从统信组件到域控平台的数据流向接口包括如下2种：a)终端信息上报接口；b)客户端上报USB接入记录接口。数据上报从域控平台到统信组件的数据流向接口包括：获取终端信息接口。5.1.3策略下发策略下发主要把自主可控操作系统域控平台中的统一域策略库中维护的策略统一下发至各个终端，策略下发可向目标终端发起主动拉取策略的通知，让自主可控操作系统终端即时拉取策略信息，也可以由自主可控操作系统终端定时拉取策略信息。策略下发从域控平台到统信组件的数据流向接口包括：策略下发通知接口。5.2身份认证要求调用方需申请对应appid和appsecret。5.3接口传输要求接口使用JSON传输数据，具备通用性和可扩展性。5.4数据接口描述数据接口具体描述如下：a）接口名称：电力行业自主可控域平台调用接口；b）接口描述：调用方需申请对应appid和appsecret，以判断用户是否为合法用户；c）接口地址：接口调用的地址；d）请求方式：POST；e）接口标识符：/application/json；f）请求示例：请求数据的接口地址示例说明；{"machine_id":"caa31d96b72d1a44bfed}g）输入参数：访问接口所需的参数，见6.1；h）返回参数：请求反馈的结果，见6.2。T/NSSQ-20226数据调用接口6.1输入参数电力行业自主可控域平台调用接口输入参数及说明见表1。表1电力行业自主可控域平台调用接口输入参数及说明6.2返回参数电力行业自主可控域平台调用接口返回参数及说明见表2。表2电力行业自主可控域平台调用接口返回参数及说明服务器成功返回用户请求的数据，该操作/米/用户发出的请求有错误，服务器没有进行米令牌、用户名、米/米/比如用户请求JSON格式，但是用户请求的资源被永久删除，且不会再得//米服务器发生错误，用户将无法判断发出的/4T/NSSQ-2022米/米/米/T/NSSQ-2022附录A（资料性）电力行业自主可控域控平台数据词典A.1参数说明参数说明见表A.1。表A.1参数说明6T/NSSQ-20227T/NSSQ-2022（规范性）接口规范示例B.1公共约束以下所有的接口都需要添加表B.1的参数：表B.1公共约束参数是B.2终端加域接口描述：终端加域时，请求平台服务接口。请求方式:POST请求地址:/gateway/ads/domain/joinContent-Type:application/json{"machine_id":"caa31d96b72d1a44bfed8}表B.2.1参数说明是是否否否是是{8T/NSSQ-2022}表B.2.2参数说明T/NSSQ-2022B.3终端退域接口描述：用于执行终端退域操作。请求方式:POST请求地址:/gateway/ads/domain/leaveContent-Type:application/json{"machine_id":"caa31d96b72d1a44bfed}表B.3.1参数说明是是否{}}表B.3.2参数说明T/NSSQ-2022B.4终端用户登录认证接口描述：终端向平台请求接口认证用户登录信息。请求方式:POST请求地址:/gateway/ads/domain/login参数格式:Content-Type:application/json{}表B.4参数说明是是是是否{"login_token":"asd123zxcxsdzqasdqw23as2d"refresh_login_token":"asd123zxcxsdzqasdqw23as2dfzah123123asd123zxcxsdzqasdqw23as2}T/NSSQ-2022B.5终端信息上报接口描述：终端信息会在加域和开机的时候上报，1.7及以上客户端做了优化，终端信息无变化时，不会上报。请求方式:POST请求地址:``Content-Type:application/json{{"sn":"de89e33adb034ab18c09beedfecfcb94""machine_id":"a4081635f35fc9dae63a4"sn":"de89e33adb034ab18c09beedfecfcb94de89e33adb034ab18c0"model":"VirtualBox_Oracle"sn":"c422f375-63ea-d443-a76f-ff9ea1e9de2c"{"sn":"de89e33adb034ab18c09}{T/NSSQ-2022}}T/NSSQ-2022B.6客户端上报USB接入记录接口描述：主动下发usb授权任务和客户端初始化的时请求，其它时候读取缓存。请求方式:POST请求地址:/uim/v4/client/usb/record{{}{}表B.6参数说明是是是否是是T/NSSQ-2022否是是是是T/NSSQ-2022B.7获取终端信息接口请求方式:GET请求地址:/gateway/ads/client/info{}表B.7.1参数说明是{"machine_id":"9b16874b50a24fabb896T/NSSQ-2022{}"created_at":"2021-05-21T10:"updated_at":"2021-05-21T11:"last_login_time":"2021-05-21T11:2"sn":"de89e33adb034ab18c09beedfecfcb94de89e33adb034ab18c}}表B.7.2参数说明T/NSSQ-2022neT/NSSQ-2022B.8策略下发通知接口请求方式:POST请求地址:/csg/job_send{}表B.8.1参数说明是是是是