1、 GY 中华人民共和国 广播电视和网络视听 行业标准 GY/T 355 2021 广播电视台融合媒体云平台 接口协议 Converged media cloud platform for broadcasting Interface protocol 2021 - 10 - 12 发布 2021 - 10 - 12 实施 国家广播电视总局 发布 GY/T 355 2021 I 目 次 前言 . II 1 范围 . 1 2 规范性引用文件 . 1 3 术语和定义 . 1 4 缩略语 . 1 5 融合媒体云平台接口 . 2 5.1 概述 . 2 5.2 融合媒体云平台基础设施服务层、平台服务层 和
2、 软件服务层之间的交互接口 . 2 5.3 融合媒体云平台内部私有云、公有云 和 专属云之间的交互接口 . 3 5.4 融合媒体云平台与外部平台之间的交互接口 . 4 6 接口通用要求 . 4 6.1 概述 . 4 6.2 接口传输协议 . 4 6.3 接口主要对接方式 . 5 6.4 业务数据接口 . 5 7 融合媒体云平台 基础设施服务层、平台服务层 和 软件服务层 之间交互接口 . 5 7.1 基础设施服务层与平台服务层交互 . 5 7.2 平台服务层与软件服务层交互 . 12 8 融合媒体云平台内部 私有云、公有云 和 专属云 之间交互接口 . 16 8.1 概述 . 16 8.2 媒
3、体数据迁移类 . 16 8.3 消息传递类 . 16 8.4 运行管理类 . 17 9 融合媒体云平台与外部平台之间交互接口 . 17 附录 A(资料性) 接口定义示例 . 18 A.1 概述 . 18 A.2 任务创建接口 . 18 附录 B(资料性) 业务接口调用示例 . 19 B.1 融合媒体云平台 基础设施服务层、平台服务层 和 软件服务层 之间交互接口调用示例 . 19 B.2 融合媒体云平台内部 私有云、公有云 和 专属云 之间交互接口调用示例 . 19 参考文献 . 21 GY/T 355 2021 II 前 言 本文件按照 GB/T 1.1 2020标准化工作导则 第 1部分:
4、标准化文件的结构和起草规则的规定 起 草 。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本文件 由全国广播电影电视标准化技术委员会( SAC/TC 239)归口。 本文件 起草单位: 江苏省广播电视集团有限公司、上海文化广播影视集团有限公司、湖南广播电视 台、浙江广播电视集团、北京 广播 电视台、 国家 广播电视总 局 广播 电视 科学研究院 、 国家 广播电视 总局 广播电视规划院 。 本文件 主要起草人: 顾建国、吴昊、施冬、盛志凡、吴阳、付伟、尚峰、周建威、袁克东、郭晓强、 覃毅力、鲍莹、夏添、张亮、田恬、王丽霞、张婧瑶、毛敏明、马晨阳、严雯雯、 王
5、亮 、 杨 威、侯方天、 杨士琦、孙谦诚、陆正军、周咏麟、黄元、姚可为 。 GY/T 355 2021 1 广播电视台融合媒体云平台 接口 协议 1 范围 本文件 规定了广播电视台融合媒体云平台 基础 设施服务层、平台服务层 和 软件服务层之间, 以及 私 有云、 公 有云 和 专属云之间 进行消息通讯、控制指令和数据交换 的接口协议、功能和调用方式。 本文件 适用于广播电视台融合媒体云平台的设计、研发、建设和运行维护。 2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件, 仅该日期对应的版本适用于本文件;不注日期的引用 文件,其最新版本
6、(包括所有的修改单)适用于本 文件 。 GB/T 31524 2015 电子商务平台运营与技术规范 GB/T 36318 2018 电子商务平台数据开放总体要求 GB/T 39044 2020 政务服务平台接入规范 GB/T 39046 2020 政务服务平台基础数据规范 GY/T 321 2019 县级融媒体中心 省级技术平台规范要求 IETF RFC 1918 私有网络地址分配 ( Address Allocation for Private Internets,February 1996) IETF RFC 6890 特定用处 IP地址定义 ( Special-Purpose IP Ad
7、dress Registries,April 2013) 3 术语 和 定义 下列术语和定义适用于本 文件 。 3.1 融合媒体 converged media 有效结合 广播、电视、报刊 、 网络视听等 方面 的 信息技 术 ,借助于多样化的传播渠道和形式, 将新 闻资讯等 内容 广泛传播给受众 ,实现资源通融、内容兼融、宣传互融的新型媒体。 3.2 融合 媒体云平台 converged media cloud platform 应用 云计算 、大数据等信 息技术, 提供 公共 服务能力 与 工具,重构 融合媒体 业务 流程 , 开展 媒体服 务类 、 综合 服务 类 、运营服务 类业务 的
8、 综合 技术 支撑 平台。 3.3 接口 能力 interface capability 通过开放的接口提供给 应用 软件调用或 开发者使用的服务。 4 缩略语 下列 缩略语适用于本 文件 。 GY/T 355 2021 2 API 应用编程接口 ( Application Programming Interface) APP 应用 程序( Application) CPU 中央处理器 ( Central Processing Unit) FTP 文件传输协议 ( File Transfer Protocol) HTTP 超文本传输协议 ( Hyper Text Transfer Protoc
9、ol) HTTPS 超文本传输安全协议( Hyper Text Transfer Protocol over Secure Socket Layer) ID 身份 标识号( Identity Document) IKE 因特网密钥交换 ( Internet Key Exchange) IP 网际互连协议( Internet Protocol) IPS 入侵防御系统 ( Intrusion Prevention System) IPSec 互联网 安全 协议 ( Internet Protocol Security) JSON JavaScript对象表示法 ( JavaScript Objec
10、t Notation) JSSDK JavaScript软件 开发工具包( JavaScript Software Development Kit) REST 一个架构样式的网络系统 ( Representational State Transfer) SDK 软件 开发工具包( Software Development Kit) SNMP 简单网络管理协议 ( Simple Network Management Protocol) URL 统一资源定位符 ( Uniform Resource Locator) VPN 虚拟专用网络 ( Virtual Private Network) WAF
11、 Web应用 防火墙 ( Web Application Firewall) 5 融合媒体云平台接口 5.1 概述 融合媒体云平台接口分为 以下 三类: a) 融合媒体云平台 基础 设施服务层、平台服务层 和 软件服务层之间的交互接口; b) 融合媒体云平台内部私有云、公 有云 和 专属云之间的交互接口; c) 融合媒体云平台与外部平台之间的交互接口。 5.2 融合媒体云平台基础设施服务层、平台服务层 和 软件服务层之间的交互接口 融合媒体云 平台 基础 设施服务层、平台服务层 和 软件服务层之间的交互 接口见图 1。 GY/T 355 2021 3 图 1 融合媒体云平台 基础 设施服务层、
12、平台服务层 和 软件服务层之间的交互 接口 融合媒体云平台 基础 设施服务层、平台服务层 和 软件服务层之间 的 交互接口包括: 基础 设施服务层 与平台服务层之间交互的资源适配服务类 接口 、 数据库 访问类接口、 资源监控服务类 接口 、资源结算服 务类 接口 和资源日志服务类接口; 平台服务层与软件服务层之间交互的用户管理 类 接口 、媒体资源管理 类 接口 和 公共服务能力管理 类 接口。 5.3 融合媒体云平台内部私有云、公有云 和 专属云之间的交互接口 融合媒体云平台内部私有云、公有云 和 专属云之间的交互接口 见图 2。 GY/T 355 2021 4 图 2 融合媒体云平台 内
13、部 私有云、公有云和专属云 之间的交互接口 融合媒体云平台内部 私有云、公有云 和 专属云 之间 的 交互接口包括 媒体 数据迁移类 接口 、消息传递 类 接口 及 运行管理 类接口。 5.4 融合媒体云平台与外部平台之间的交互接口 融合媒体云平台与 外部 平台交互 时应遵循相关行业标准 、 规范或合作 平台的对接 要求。 6 接口 通用 要求 6.1 概述 接口 协议 要求如下 : a) 应充分考虑并遵循灵活、规范、 高效 、安全的原则 ; b) 应具有跨平台且语言无关性; c) 应提供对资源操作使用的标准 HTTP/HTTPS 方法; d) 应遵循幂等性设计原则; e) 为了保证接口的运行
14、安全, 应 验证调用方的身份、对消息签名以及对消息内容加密; f) 应保证所有数据传送的安全可靠,保证数据的一致性、完整性,对交互的过程和状态进行记录 和监控,支持交互失败时的交互恢复; g) 接口的通信与交互应不影响平台的正常运行; h) 应具备 开放性 , 为 云平台 工具及 应用提供统一的接口调用与交互规范。 6.2 接口传输协议 融 合媒体业务数据接口应同时支持 HTTP和 HTTPS,优先采用 HTTPS协议。现有采用 HTTP协议的系统应 逐步过渡到采用 HTTPS协议进行交互。 GY/T 355 2021 5 6.3 接口 主要 对接方式 6.3.1 概述 融合媒体云平台 宜 采
15、用 JSSDK、 APP_SDK和 API接口对接方式,根据应用场景选择对接方式,同时应 保证接口对接安全、高效和简单。 6.3.2 JSSDK JSSDK通过加载 HTML数据的方式展现软件界面,支持网页之间的接入,以及 APP客户端和网页的接入 。 在融媒体业务中, 宜 应用于手机客户端和浏览器应用的集成。 JSSDK使用说明文档应包括:调用鉴权机制说明 、方法参数说明 和 回调机制说明。 根据业务场景及功能, JSSDK宜 提供用户信息获取、页面跳转、位置信息获取、设备信息获取、文 件 选择、文件上传 等 方法。 6.3.3 APP_SDK 为手机客户端应用提供服务的接口宜 使用 APP
16、_SDK方式,通过模块的形式实现特定业务场景的功能。 APP_SDK应提供工程设计模式、工程结构、功能集成方式、数据库存储机制、依赖基础类库及其版 本、基础方法说明的配套文档。 6.3.4 API API提供不同应用程序间实现数据交换的接口能力, 宜采用 符合 REST风格的 API, 应提供鉴权方式 。 API接口说明应包含:请 求地址说明、请求方式说明、请求参数说明、返回参数说明、请求示例说 明、返回示例说明,如有回调还应包含回调参数和 回调 示例说明。 接口定义示例见附录 A。 6.4 业务 数据接口 融合媒体云平台 处理 的融 媒体 对象类型和 对象映射 应符合 GY/T 321 20
17、19给出 的定义, 上层业务 接 口 调用示例 见附录 B。 7 融合媒体云平台 基础设施服务层、平台服务层和软件服务层 之间交互接口 7.1 基础 设施服务层与平台服务层交互 7.1.1 概述 基础 设施服务层与平台服务层之间 的 交互接口主要包括资源适配服务类 接口 、 数据库 访问类接口、 资源监控服务类 接口 、资源结算服务类 接口 和 资源日志服务类接口。 7.1.2 资源适配服务类 资源适配服务类接口主要包括计算资源服务接口、存储资源服务接口、网络资源服务接口、安全资 源服务接口和租户管理接口。 计算资源服务接口 应 符合表 1给出 的 功能要求 。 GY/T 355 2021 6
18、 表 1 计算资源服务接口 序号 接口类型 接口 功能 功能描述 1 虚机管理 虚机创建 创建一台虚机 删除虚机 动态地把不用的一 台 虚机删除 修改虚机 修改虚机的名称、描述内容 启动虚机 启动一台虚机 关闭虚机 关闭一台虚机 重启虚机 重启一台虚机 调整虚机安全组 调整虚机所 在的安全组 调整虚机规格 调整虚机规格 查询虚机初始化密码 查询虚机的初始化密码 2 容器 管理 创建容器 创建一个容器 删除容器 动态删除一个容器 修改容器 修改容器资源规格 启动容器 启动一个容器 关闭容器 关闭一个容器 计算资源服务接口传递 以下 参数: 应包含: 多租户云环境下的租户或组织 ID、虚机 ID、
19、 容器 ID、 主机名称、镜像 ID、虚机规 格 ID 和 安全组 ID; 宜 包含: 网络信息和磁盘描述。 存储资源服务接口 应 符合表 2给出 的 功能要求 。 表 2 存储资源服务接口 序号 接口类型 接口 功能 功能描述 1 磁盘管理 创建磁盘 为指定虚机增加一套磁盘设备 挂载磁盘 为指定虚机挂载一 套 磁盘设备 删除磁盘 删除指定磁盘设备 卸载磁盘 卸载磁盘 修改磁盘 修改磁盘名称、磁盘描述信息 2 快照管理 创建磁盘快照 对指定的磁盘存储设备创建快照 修改磁盘快照 修改指定的磁盘快照 删除磁盘快照 删除指定的磁盘快照 根据快照恢复磁盘 把磁盘恢复到快照当前状态 3 镜像管理 创建镜
20、像 通过快照创建自定义镜像 更新镜像 更新指定镜像 删除 镜像 删除指定镜像 停用镜像 停用指定镜像 重新激活镜像 重新激活指定镜像 存储资源服务接口传递 以下 参数: GY/T 355 2021 7 应包含:多租户云环境下的租户或组织 ID、磁盘名称和磁盘 ID、虚机 ID、快照名称和快照 ID、镜像名称和镜像 ID; 宜 包含:磁盘描述、磁盘大小、磁盘状态、快照描述 和 镜像描述信息。 网络资源服务接口 应 符合表 3给出 的 功能要求 。 表 3 网络资源服务接口 序号 接口类型 接口 功能 功能描述 1 网络 创建网络 创建一个网络和与之相关的资源 删除网络 删除一个网络和与之相关的资
21、源 修 改网络 修改网络 2 子网 创建子网 为指定网络创建子网 删除子网 删除指定子网信息 修改子网 修改指定子网信息 3 路由 创建路由 创建虚拟路由 删除路由 删除虚拟路由 及其 外部网关接口 修改路由 修改虚拟路由 添加路由接口 为虚拟路由添加内部接口 删除路由接口 删除虚拟路由的内部接口 4 安全组 创建安全组 创建一个网络安全组 删除安全组 删除一个指定的安全组 修改安全组 修改一个指定的安全组 创建安全组 规 则 创建一个安全组规则 删除安全组 规 则 删除安全组的指定规则 安全组添加成员 给指定安全组添加新的虚机成员 安全组移除 成 员 从指定安全组移除原有的虚机成员 5 虚拟
22、网卡 创建虚拟网卡 在指定的网络中创建虚拟网卡 修改虚拟网卡 修改指定的虚拟网卡 删除虚拟网卡 删除指定的虚拟网卡 6 公网 IP 地址 创建公网 IP 地址 创建公网 IP 地址 修改公网 IP 地址 修改公网 IP 地址 和与之绑定的内部虚拟网卡 删除公网 IP 地址 删除公网 IP 地址 及其 所关联的虚拟网卡 7 负载均衡器 创建负载均衡器虚服务 IP 地址 为负载均 衡器创建虚服务 IP 地址 修改指定虚服务 IP 地址 修改指定负载均衡器虚服务 IP 地址 查询虚服务 IP 地址 查询虚服务 IP 地址 查看指定虚服务 IP 地址 详细信 息 显示指定虚服务 IP 地址 详细信息
23、删除指定虚服务 IP 地址 删除指定负载均衡器虚服务 IP 地址 创建资源池 创建负载均衡器下资源池 查看资源池详细信息 查询负载均衡器下指定资源池详细信息 更新资源池 更新负载均衡器下指定资源池 删除资源池 删除指定负载均衡器下指定资源池 GY/T 355 2021 8 表 3(续) 序号 接口类型 接口 功能 功能 描述 负载均衡器 创建成员 在负载均衡器下创建成员 查看成员详细信息 查看负载均衡器下指定成员详细信息 更新成员 更新负载均衡器下指定成员 删除成员 删除负载均衡器下指定成员 网络资源服务接口传递 以下 参数: 应包含:网络资源相关服务接口的对象名称和 ID、对象列表、租户 I
24、D、网络节点可用域、网 络状态、与此网络关联的子网、网络的最大传输单元和接口端口安全状态、虚服务 IP 地址 的 名称和 ID; 宜 包含:对象描述信息。 子网 地址 规划 应 遵循 IETF RFC 1918、 IETF RFC 6890的 要求 。 安全资源服务接口 应 符合表 4给出 的 功能要求 。 表 4 安全资源服务接口 序号 接口类型 接口 功能 功能描述 1 防火墙 查询 防火墙 查询 防火墙 创建防火墙 创建防火墙 修改防火墙 修改防火墙 删除防火墙 删除防火墙 查看 防火墙 详细 信息 查看 防火墙 详细 信息 2 防火墙规则 查询 防火墙 规则 查询 防火墙 规则 查看防
25、火墙规则详细信息 查看防火墙规则详细信息 创建防火墙规则 创建防火墙规则 修改防火墙规则 修改防火墙规则 删除防火墙规则 删除防火墙规则 3 防火墙策略 查询 防火墙 策略 查询 防火墙 策略 查看防火墙策略详细信息 查看防火墙策略详细信息 创建防火墙策略 创建防火墙策略 修改防火墙策略 修改防火墙策略 删除 防火墙策略 删除 防火墙策略 4 VPN 服务 查询 VPN 服务 查询 VPN 服务 查看 VPN 服务详细信息 查看 VPN 服务详细信息 创建 VPN 服务 创建 VPN 服务 删除 VPN 服务 删除 VPN 服务 5 IKE 策略 查看 IKE 策略详细信息 查看 IKE 策略
26、详细信息 创建 IKE 策略 创建 IKE 策略 删除 IKE 策略 删除 IKE 策略 6 IPSec 策略 查看 IPSec 策略详细信息 查看 IPSec 策略详细信息 创建 IPSec 策略 创建 IPSec 策略 GY/T 355 2021 9 表 4(续) 序号 接口类型 接口 功能 功能描述 删除 IPSec 策略 删除 IPSec 策略 7 IPSec 站点连接 查询 IPSec 站点连接 查询 IPSec 站点连接 查看 IPSec站点连接详细信息 查看 IPSec 站点连接详细信息 创建 IPSec 站点连接 创建 IPSec 站点连接 修改 IPSec 站点连接 修改 I
27、PSec 站点连接 删除 IPSec 站点 连接 删除 IPSec 站点 连接 8 Web 应用防护 系统( WAF)服务 查询 WAF 列表 查询 WAF 列表 查看 WAF 详细信息 查看 WAF 详细信息 创建 WAF 创建 WAF 删除 WAF 删除 WAF 9 入侵防御 系统 ( IPS)服务 查询 IPS 列表 查询 IPS 列表 查看 IPS 详细信息 查看 IPS 详细信息 创建 IPS 创建 IPS 删除 IPS 删除 IPS 10 防病毒服务 查询防病毒列表 查询防病毒列表 查看防病毒详细信息 查看防病毒详细信息 创建防病毒 创建防病毒 服务 删除防病毒 删除防病毒服务 安
28、全资源服务接口传递 以下 参数: 应包含:安全资源相关服务接口的对象名称和 ID、 租户 ID、源 IP 地址 和源端口、目的 IP 地 址 和目的端口、对应的协议 和 路由 ID; 宜 包含:对象策略的描述信息。 租户管理接口 应 符合表 5给出 的 功能要求 。 表 5 租户管理接口 序号 接口类型 接口 功能 功能描述 1 令牌 认证并生成令牌 认证并生成令牌 验证令牌 验证指定的用户令牌 2 组织 创建 组织 创建 组织 查询 组织列表 查询 组织列表 查看 组织 详细 信息 查看 组织 详细 信 息 修改 组织 对指定组织进行修改 删除 组织 删除指定 组织 授予 组织用户 某一 角
29、色 向组织中指定用户授予指定角色的权限 撤回 组织用户角色 撤回组织中指定用户的角色权限 GY/T 355 2021 10 表 5(续) 序号 接口类型 接口 功能 功能描述 3 用户 创建用户 创建用户 查询用户 列表 查询用户 列表 显示 用户 详情 显示 用户 详情 修改用户 为已经启用或者禁用的用户修改密码 删除用户 删除指定用户 4 角色 查询角色 查询角色 5 权限分组 查询权限分组 查询权限分组 6 用户 、 组织 和 权限分组之间映射关系 授予 组织下某用户权限分组 授予 组织下某用户权限分组 回收 组织下某用户 的 权限分组 回收 组织下某用户 的 权限分组 租户管理接口传递
30、 以下 参数: 应包含: 用户名称、租户名称、密码和生成 的 令牌、组织名称 、组织 ID、用户 ID、角色名称 、 角色 ID 和 权限分组 ID; 宜 包含: 组织描述 和 用户描述信息。 7.1.3 数据库访问类 数据库访问类 接口 应符合表 6给出的功能要求 。 表 6 数据库访问类接口 接口类型 接口 功能 功能描述 数据库访问 创建数据库实例 根据选定的内存、磁盘空间和数据库类型创建出相应数 据库实例 查询 数据库实例详情 供用户查询数据库实例详细信息,包含数据库地址、用户名、密码 释放数据库实例 根据数据库实例 ID 删除 并 释放 相应的数据库实例 重启数据库实例 根据数据库实
31、例 ID 重启相应的数据库服务 数据库访问类 接口 传递以下参数: 应包含: 授权令牌、 时间标识 、 实例名称、 数据库实例 ID、 数据库类型、数据库版本号、数 据库存储、 CPU 规格 和 内存 规格; 宜包含:附属信息。 7.1.4 资源监控服务类 资源监控类服务接口主要包括告警接口和查询接口。 告警接口 应符合表 7 给出的功能要求 。 表 7 告警接口 接 口类型 接口 功能 功能描述 告警接口 上报告警 上报告警信 息 至第三方 查询告警 查询告警信息 清除告警 清除告警信息 GY/T 355 2021 11 告警 接口传递 以下 参数: 应包含: 告警编号、告警 ID、告警名称
32、、告警对象实例、流水号、告警类型、数据类型、告 警产生时间、告警清除时间 和 清除类型 ; 宜 包含:告警描述信息。 查询接口 应符合表 8给出的功能要求 。 表 8 查询接口 序号 接口类型 接口 功能 功能描述 1 计算资源查询 查询虚机列表 查询虚机列表 查询虚机具体信息 查询虚机的基本信息、详情 查询 容器 列表 查询 容 器 列表 查询 容器 具体信息 查询 容器 的基本信息、详情 2 存储资源查询 查看磁盘详细 列表 查看 租户的磁盘的详细列表 查询磁盘信息 查询 指定 磁盘 信息 查询所有磁盘快照 查询租户 的 所有磁盘快照列表 查询磁盘快照信息 查询指定磁盘快照信息 3 网络资
33、源查询 查询网络 查询 指定 网络 详情 查询 子网信息 查询 指定子网信息 查询子网列表 查询 指定租户 的子 网 列表 查询路由信息 查询指定 虚拟路由 查询路由列表 查看 虚拟路由列表 查询安全组 查询指定 安全组信息 查询 安全组规则 查询指定安全组规则 查询 虚拟网卡列表 查询租户 可访问的虚拟网卡 查询 虚拟网卡 查询指定 虚拟网卡 的 信息 查询公网 IP 地址 列表 查询符合要求 的 租户可以 访问的公网 IP 地址 查询公网 IP 地址 信息 查询指定公网 IP 地址 信息 查询 接口传递 以下 参数: 应包含:多租户云环境下的租户或组织 ID、虚机 ID、 容器 ID、 硬
34、盘 ID、快照 ID、网络和子 网 ID、网络 对象列表、 网络名称、路由 ID、安全组 ID、虚拟网卡 的 MAC 地址 、 虚拟网卡 的 接 口 ID 和 使用该网卡的设备 ID、 公网 IP 地址 的 ID; 宜 包含 : 网络状态、网络的最大传输单元 、 接口安全状态、网络 节点 可用域 和 可访问 的公网 IP 地址 信息 。 7.1.5 资源结算服务类 资源结算服务类接口主要包括资源定价 接口、资源订单接口、资源申请用户接口和资源费用详情接 口, 各 接口 应符合表 9给出的功能要求 。 GY/T 355 2021 12 表 9 资源结算服务类接口 接口类型 接口 功能 功能描述
35、资源结算服务 资源定价 描述资源定价对象,为系统提供资源定价的模型,实现资源定价对象的增加、删除、修改和查询功能 资源订单 描述资源订单对象,实现资源订单对象的增加、删除、修改和查询功能 资源申请用户 用于记 录和描述申请资源的用户对象信息,实现资源申请用户对象的增加、删除、修改和查询功能 资源费用详情 用于资源费用详情的描述和操作功能,实现资源计费的 费用 详情查询功能 资源结算服务类 接口传递 以下 参数: 应包含: 授权令牌、 时间标识 、 资源结算相关服务接口的对象 ID、用户 ID、定价模型、 申请 用 户 和 组织机构名 ; 宜 包含 : 资源类型、价格、计费类型、计费单位、计费折
36、扣 、 订单时间、联系方式 和 账户信息。 7.1.6 资源日志服务类 资源日志服务类接口主要包括资源日志提交方式接口、资源日志位置接口和资源日志详情接口, 各 接口 应符合表 10给出的功能要求 。 表 10 资源日志服务类接口 接口类型 接口 功能 功能描述 资源日志服务 资源日志提交方式 描述平台当前资源的日志提交方式, 包括 文件方式、 HTTP 方式、 SNMP 方式,实现日志提交方式的增加、删除、修改和查询功能 资源日志位置 描述平台资源日志的位置信息, 包括 HTTP/HTTPS 地址、文件路径,实现资源日志位置对象的增加、删除、修改和查询功能 资源日志详情 描述平台资源日志的详
37、细信息,实现资源日志详情对象的增加和查询功能 资源日志服务类 接口传递 以下 参数: 应 包含 : 授权令牌、 时 间标识 、进程名、进程 ID、资源 ID、需要获取的资源 日志位置和资源 日志 提交方式的文本信息 ; 宜 包 含 : 日志级别 和 日志详细内容。 7.2 平台服务层与软件服务层交互 7.2.1 概述 平台服务层与软件服务层之间交互接口主要包括用户管理 类 接口 、媒体资源管理 类 接口和 公共服务 能力管理 类 接口 。 7.2.2 用户管理 类 平台服务层提供统一的用户、组织机构、权限管理,对平台的所有用户信息进行统一管理和认证, 实现单点登录。 用户管理 类 接口 应符合
38、表 11 给出的功能要求 。 GY/T 355 2021 13 表 11 用户管理 类 接口 序号 接口类型 接口 功能 功能描述 1 接口认证 获取授权令 牌 平台服务层的服务 对每个访问的请求进行身份验证, 应 在请求中带上令牌信息 2 权限管理 获取组织结构信息 获取组织结构信息 应 先获取授权令牌 ,调用此接口可获取平台内的组织结构 信息 获取指定部门 /组的用户信息 获取指定部门 /组的用户信息 应 先获取授权令牌, 通过参数中传递的部门 /组标识,返回该部门 /组下的用户信息列表 获取指定应用的用户信息 获取指定应用的用户信息 应 先获取授权令牌 , 通过参数 中 传递的应用标识,
39、自动匹配该用户所在应用,并返回该应 用下的用户信息列表 获取指定用户的信息 获取指定用户信息 应 先获取授权令牌 ,通过参数中 传递的要查询的用户标识,返回该用户的信息详情 根据用户名查询用户 获取指定用户信息应先获取授权令牌,通过参数中 传递的要查询的用户名称,返回该用户的信息详情 获取栏目列表信息 获取栏目列表信息 应 先获取授权令牌 , 调用此接口可获取平台内的栏目列表信息 获取指定栏目的用户信息 获取指定栏目的用户信息 应 先获取授权令牌 ,通过参数中传递的栏目标识,返回该栏目下的用户信息列表 用户管理 类 接口 应 传递 的 参数 包括 :应用标识、版本号、企业标识、服务标识、 部门
40、 /组标识 、 栏 目标识、 用户 标识、 用户 名称、 密钥以及 由 时间标识 生成的 相应的 授权令牌。 7.2.3 媒体资源管理 类 对媒体资源的格式和访问方式进行统一规范,使平台具备 管理 来自多种 类型 的媒体资源的 接口 能 力,实现媒体资源统一的存储管理和跨应用的内容共享。 媒体资源管理 类 接口 应符合表 12 给出的功能要求 。 表 12 媒体资源管理 类 接口 接口类型 接口 功能 功能描述 媒体资源管理 FTP 上传 提供 FTP 服务,上传媒体资源文件 断点续传 提供文件断点续传服务,上传媒体资源文件 文件上传 提供文件上传服务,上传媒体资源文件 断点上传续传进度查询
41、提 供文件断点上传续传进度查询服务,上传媒体资源文件 资源注册 根据传入参数注册资源 资源查询 根据提供的资源注册标识,返回该资源标识所属的资源详细信息 按条件资源查询 根据提供的时间、关键词检索资源,返回对应检索条件的资源详细信息 删除资源 根据提供的资源注册标识,删除该注册标识所属的资源信息 GY/T 355 2021 14 表 12(续) 接口类型 接口 功能 功能描述 媒体资源管理 更新资源素材包信息 根据提供的资源素材包信息,编辑该资源素材包所对应的资源基本 信息 新增资源媒体文件信息 根据提供的新增素材包信息,将 新的素材信息添加到指定资源中 删除资源媒体文件信息 根据提供的需要删
42、除的素材标识信息,将需要删除的素材信息从指 定资源中删除 资源包与已有媒体文件绑定 根据提供的资源标识和素材标志,将资源与素材进行关系绑定 资源分享或移交 根据提供的信息,进行资源的分享或移交 查询个人同步资源 根据提供的信息,进行查询个人同步资源 媒体资源管理 类 接口 应 传递 以下 参数: a) 通用参数: 授权令牌 和 时间标识; b) FTP 上传 接口 : 主要 包含 FTP 服务的用户名、 FTP 服务的密码 、 FTP 服务器 IP 地址 和 端口号 ; c) 断点续传 接口 : 主要 包含 素材名称、素材大小和公共参数信息; d) 文件上传 接口 : 主要 包含 上传令牌、文件的 MD5 值、文件流和公共参数信息; e) 断点上传续传进度查询 接口 : 主要 包含 上传令牌和公共参数信息; f) 资源注册 接口 : 主要 包含 素材包编码后的字符串信息; g) 资源查询 接口 : 主要 包含 注册资源时获取的唯一标识; h) 按条件资源查询 接口 : 主要 包含 开始时间、结束时间、搜索关键词、查询从第几页开始和每页 显示条数; i) 删除资源 接口 : 主要 包含 删除的素材包标识;