《GY∕T 355-2021 广播电视台融合媒体云平台 接口协议[广播电影电视].pdf》由会员分享,可在线阅读,更多相关《GY∕T 355-2021 广播电视台融合媒体云平台 接口协议[广播电影电视].pdf(25页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、 GY 中华人民共和国广播电视和网络视听行业标准 GY/T 3552021 广播电视台融合媒体云平台 接口协议 Converged media cloud platform for broadcastingInterface protocol 2021-10-12 发布 2021-10-12 实施 国家广播电视总局 发 布 GY/T 3552021 I 目 次 前言.II 1 范围.1 2 规范性引用文件.1 3 术语和定义.1 4 缩略语.1 5 融合媒体云平台接口.2 5.1 概述.2 5.2 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口.2 5.3 融合媒体云平台内
2、部私有云、公有云和专属云之间的交互接口.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 媒体数据迁移类.16 8.3 消息传递类.16 8.4 运行管理类.17 9 融合媒体云平台与外部平台之间交互接口.17 附录 A
3、(资料性)接口定义示例.18 A.1 概述.18 A.2 任务创建接口.18 附录 B(资料性)业务接口调用示例.19 B.1 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间交互接口调用示例.19 B.2 融合媒体云平台内部私有云、公有云和专属云之间交互接口调用示例.19 参考文献.21 GY/T 3552021 II 前 言 本文件按照GB/T 1.12020标准化工作导则 第1部分:标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本文件由全国广播电影电视标准化技术委员会(SAC/TC 239)归口。本文件起草单位
4、:江苏省广播电视集团有限公司、上海文化广播影视集团有限公司、湖南广播电视台、浙江广播电视集团、北京广播电视台、国家广播电视总局广播电视科学研究院、国家广播电视总局广播电视规划院。本文件主要起草人:顾建国、吴昊、施冬、盛志凡、吴阳、付伟、尚峰、周建威、袁克东、郭晓强、覃毅力、鲍莹、夏添、张亮、田恬、王丽霞、张婧瑶、毛敏明、马晨阳、严雯雯、王亮、杨威、侯方天、杨士琦、孙谦诚、陆正军、周咏麟、黄元、姚可为。GY/T 3552021 1 广播电视台融合媒体云平台 接口协议 1 范围 本文件规定了广播电视台融合媒体云平台基础设施服务层、平台服务层和软件服务层之间,以及私有云、公有云和专属云之间进行消息通
5、讯、控制指令和数据交换的接口协议、功能和调用方式。本文件适用于广播电视台融合媒体云平台的设计、研发、建设和运行维护。2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 315242015 电子商务平台运营与技术规范 GB/T 363182018 电子商务平台数据开放总体要求 GB/T 390442020 政务服务平台接入规范 GB/T 390462020 政务服务平台基础数据规范 GY/T 3212019 县级融媒体中心省级技术平台规
6、范要求 IETF RFC 1918 私有网络地址分配(Address Allocation for Private Internets,February 1996)IETF RFC 6890 特定用处IP地址定义(Special-Purpose IP Address Registries,April 2013)3 术语和定义 下列术语和定义适用于本文件。3.1 融合媒体 converged media 有效结合广播、电视、报刊、网络视听等方面的信息技术,借助于多样化的传播渠道和形式,将新闻资讯等内容广泛传播给受众,实现资源通融、内容兼融、宣传互融的新型媒体。3.2 融合媒体云平台 conver
7、ged media cloud platform 应用云计算、大数据等信息技术,提供公共服务能力与工具,重构融合媒体业务流程,开展媒体服务类、综合服务类、运营服务类业务的综合技术支撑平台。3.3 接口能力 interface capability 通过开放的接口提供给应用软件调用或开发者使用的服务。4 缩略语 下列缩略语适用于本文件。GY/T 3552021 2 API 应用编程接口(Application Programming Interface)APP 应用程序(Application)CPU 中央处理器(Central Processing Unit)FTP 文件传输协议(File T
8、ransfer Protocol)HTTP 超文本传输协议(Hyper Text Transfer Protocol)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)JS
9、ON JavaScript对象表示法(JavaScript Object 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 Pri
10、vate Network)WAF Web应用防火墙(Web Application Firewall)5 融合媒体云平台接口 5.1 概述 融合媒体云平台接口分为以下三类:a)融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口;b)融合媒体云平台内部私有云、公有云和专属云之间的交互接口;c)融合媒体云平台与外部平台之间的交互接口。5.2 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口见图1。GY/T 3552021 3 图1 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口
11、 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间的交互接口包括:基础设施服务层与平台服务层之间交互的资源适配服务类接口、数据库访问类接口、资源监控服务类接口、资源结算服务类接口和资源日志服务类接口;平台服务层与软件服务层之间交互的用户管理类接口、媒体资源管理类接口和公共服务能力管理类接口。5.3 融合媒体云平台内部私有云、公有云和专属云之间的交互接口 融合媒体云平台内部私有云、公有云和专属云之间的交互接口见图2。GY/T 3552021 4 图2 融合媒体云平台内部私有云、公有云和专属云之间的交互接口 融合媒体云平台内部私有云、公有云和专属云之间的交互接口包括媒体数据迁移类接口、消息
12、传递类接口及运行管理类接口。5.4 融合媒体云平台与外部平台之间的交互接口 融合媒体云平台与外部平台交互时应遵循相关行业标准、规范或合作平台的对接要求。6 接口通用要求 6.1 概述 接口协议要求如下:a)应充分考虑并遵循灵活、规范、高效、安全的原则;b)应具有跨平台且语言无关性;c)应提供对资源操作使用的标准 HTTP/HTTPS 方法;d)应遵循幂等性设计原则;e)为了保证接口的运行安全,应验证调用方的身份、对消息签名以及对消息内容加密;f)应保证所有数据传送的安全可靠,保证数据的一致性、完整性,对交互的过程和状态进行记录和监控,支持交互失败时的交互恢复;g)接口的通信与交互应不影响平台的
13、正常运行;h)应具备开放性,为云平台工具及应用提供统一的接口调用与交互规范。6.2 接口传输协议 融合媒体业务数据接口应同时支持HTTP和HTTPS,优先采用HTTPS协议。现有采用HTTP协议的系统应逐步过渡到采用HTTPS协议进行交互。GY/T 3552021 5 6.3 接口主要对接方式 6.3.1 概述 融合媒体云平台宜采用JSSDK、APP_SDK和API接口对接方式,根据应用场景选择对接方式,同时应保证接口对接安全、高效和简单。6.3.2 JSSDK JSSDK通过加载HTML数据的方式展现软件界面,支持网页之间的接入,以及APP客户端和网页的接入。在融媒体业务中,宜应用于手机客户
14、端和浏览器应用的集成。JSSDK使用说明文档应包括:调用鉴权机制说明、方法参数说明和回调机制说明。根据业务场景及功能,JSSDK宜提供用户信息获取、页面跳转、位置信息获取、设备信息获取、文件选择、文件上传等方法。6.3.3 APP_SDK 为手机客户端应用提供服务的接口宜使用APP_SDK方式,通过模块的形式实现特定业务场景的功能。APP_SDK应提供工程设计模式、工程结构、功能集成方式、数据库存储机制、依赖基础类库及其版本、基础方法说明的配套文档。6.3.4 API API提供不同应用程序间实现数据交换的接口能力,宜采用符合REST风格的API,应提供鉴权方式。API接口说明应包含:请求地址
15、说明、请求方式说明、请求参数说明、返回参数说明、请求示例说明、返回示例说明,如有回调还应包含回调参数和回调示例说明。接口定义示例见附录A。6.4 业务数据接口 融合媒体云平台处理的融媒体对象类型和对象映射应符合GY/T 3212019给出的定义,上层业务接口调用示例见附录B。7 融合媒体云平台基础设施服务层、平台服务层和软件服务层之间交互接口 7.1 基础设施服务层与平台服务层交互 7.1.1 概述 基础设施服务层与平台服务层之间的交互接口主要包括资源适配服务类接口、数据库访问类接口、资源监控服务类接口、资源结算服务类接口和资源日志服务类接口。7.1.2 资源适配服务类 资源适配服务类接口主要
16、包括计算资源服务接口、存储资源服务接口、网络资源服务接口、安全资源服务接口和租户管理接口。计算资源服务接口应符合表1给出的功能要求。GY/T 3552021 6 表1 计算资源服务接口 序号 接口类型 接口功能 功能描述 1 虚机管理 虚机创建 创建一台虚机 删除虚机 动态地把不用的一台虚机删除 修改虚机 修改虚机的名称、描述内容 启动虚机 启动一台虚机 关闭虚机 关闭一台虚机 重启虚机 重启一台虚机 调整虚机安全组 调整虚机所在的安全组 调整虚机规格 调整虚机规格 查询虚机初始化密码 查询虚机的初始化密码 2 容器管理 创建容器 创建一个容器 删除容器 动态删除一个容器 修改容器 修改容器资
17、源规格 启动容器 启动一个容器 关闭容器 关闭一个容器 计算资源服务接口传递以下参数:应包含:多租户云环境下的租户或组织 ID、虚机 ID、容器 ID、主机名称、镜像 ID、虚机规格 ID 和安全组 ID;宜包含:网络信息和磁盘描述。存储资源服务接口应符合表2给出的功能要求。表2 存储资源服务接口 序号 接口类型 接口功能 功能描述 1 磁盘管理 创建磁盘 为指定虚机增加一套磁盘设备 挂载磁盘 为指定虚机挂载一套磁盘设备 删除磁盘 删除指定磁盘设备 卸载磁盘 卸载磁盘 修改磁盘 修改磁盘名称、磁盘描述信息 2 快照管理 创建磁盘快照 对指定的磁盘存储设备创建快照 修改磁盘快照 修改指定的磁盘快
18、照 删除磁盘快照 删除指定的磁盘快照 根据快照恢复磁盘 把磁盘恢复到快照当前状态 3 镜像管理 创建镜像 通过快照创建自定义镜像 更新镜像 更新指定镜像 删除镜像 删除指定镜像 停用镜像 停用指定镜像 重新激活镜像 重新激活指定镜像 存储资源服务接口传递以下参数:GY/T 3552021 7 应包含:多租户云环境下的租户或组织 ID、磁盘名称和磁盘 ID、虚机 ID、快照名称和快照ID、镜像名称和镜像 ID;宜包含:磁盘描述、磁盘大小、磁盘状态、快照描述和镜像描述信息。网络资源服务接口应符合表3给出的功能要求。表3 网络资源服务接口 序号 接口类型 接口功能 功能描述 1 网络 创建网络 创建
19、一个网络和与之相关的资源 删除网络 删除一个网络和与之相关的资源 修改网络 修改网络 2 子网 创建子网 为指定网络创建子网 删除子网 删除指定子网信息 修改子网 修改指定子网信息 3 路由 创建路由 创建虚拟路由 删除路由 删除虚拟路由及其外部网关接口 修改路由 修改虚拟路由 添加路由接口 为虚拟路由添加内部接口 删除路由接口 删除虚拟路由的内部接口 4 安全组 创建安全组 创建一个网络安全组 删除安全组 删除一个指定的安全组 修改安全组 修改一个指定的安全组 创建安全组规则 创建一个安全组规则 删除安全组规则 删除安全组的指定规则 安全组添加成员 给指定安全组添加新的虚机成员 安全组移除成
20、员 从指定安全组移除原有的虚机成员 5 虚拟网卡 创建虚拟网卡 在指定的网络中创建虚拟网卡 修改虚拟网卡 修改指定的虚拟网卡 删除虚拟网卡 删除指定的虚拟网卡 6 公网 IP 地址 创建公网 IP 地址 创建公网 IP 地址 修改公网 IP 地址 修改公网 IP 地址和与之绑定的内部虚拟网卡 删除公网 IP 地址 删除公网 IP 地址及其所关联的虚拟网卡 7 负载均衡器 创建负载均衡器虚服务 IP 地址 为负载均衡器创建虚服务 IP 地址 修改指定虚服务 IP 地址 修改指定负载均衡器虚服务 IP 地址 查询虚服务 IP 地址 查询虚服务 IP 地址 查看指定虚服务 IP 地址详细信息 显示指
21、定虚服务 IP 地址详细信息 删除指定虚服务 IP 地址 删除指定负载均衡器虚服务 IP 地址 创建资源池 创建负载均衡器下资源池 查看资源池详细信息 查询负载均衡器下指定资源池详细信息 更新资源池 更新负载均衡器下指定资源池 删除资源池 删除指定负载均衡器下指定资源池 GY/T 3552021 8 表 3(续)序号 接口类型 接口功能 功能描述 负载均衡器 创建成员 在负载均衡器下创建成员 查看成员详细信息 查看负载均衡器下指定成员详细信息 更新成员 更新负载均衡器下指定成员 删除成员 删除负载均衡器下指定成员 网络资源服务接口传递以下参数:应包含:网络资源相关服务接口的对象名称和 ID、对
22、象列表、租户 ID、网络节点可用域、网络状态、与此网络关联的子网、网络的最大传输单元和接口端口安全状态、虚服务 IP 地址的名称和 ID;宜包含:对象描述信息。子网地址规划应遵循IETF RFC 1918、IETF RFC 6890的要求。安全资源服务接口应符合表4给出的功能要求。表4 安全资源服务接口 序号 接口类型 接口功能 功能描述 1 防火墙 查询防火墙 查询防火墙 创建防火墙 创建防火墙 修改防火墙 修改防火墙 删除防火墙 删除防火墙 查看防火墙详细信息 查看防火墙详细信息 2 防火墙规则 查询防火墙规则 查询防火墙规则 查看防火墙规则详细信息 查看防火墙规则详细信息 创建防火墙规则
23、 创建防火墙规则 修改防火墙规则 修改防火墙规则 删除防火墙规则 删除防火墙规则 3 防火墙策略 查询防火墙策略 查询防火墙策略 查看防火墙策略详细信息 查看防火墙策略详细信息 创建防火墙策略 创建防火墙策略 修改防火墙策略 修改防火墙策略 删除防火墙策略 删除防火墙策略 4 VPN 服务 查询 VPN 服务 查询 VPN 服务 查看 VPN 服务详细信息 查看 VPN 服务详细信息 创建 VPN 服务 创建 VPN 服务 删除 VPN 服务 删除 VPN 服务 5 IKE 策略 查看 IKE 策略详细信息 查看 IKE 策略详细信息 创建 IKE 策略 创建 IKE 策略 删除 IKE 策略
24、 删除 IKE 策略 6 IPSec 策略 查看 IPSec 策略详细信息 查看 IPSec 策略详细信息 创建 IPSec 策略 创建 IPSec 策略 GY/T 3552021 9 表 4(续)序号 接口类型 接口功能 功能描述 删除 IPSec 策略 删除 IPSec 策略 7 IPSec 站点连接 查询 IPSec 站点连接 查询 IPSec 站点连接 查看IPSec站点连接详细信息 查看 IPSec 站点连接详细信息 创建 IPSec 站点连接 创建 IPSec 站点连接 修改 IPSec 站点连接 修改 IPSec 站点连接 删除 IPSec 站点连接 删除 IPSec 站点连接
25、8 Web 应用防护系统(WAF)服务 查询 WAF 列表 查询 WAF 列表 查看 WAF 详细信息 查看 WAF 详细信息 创建 WAF 创建 WAF 删除 WAF 删除 WAF 9 入侵防御系统(IPS)服务 查询 IPS 列表 查询 IPS 列表 查看 IPS 详细信息 查看 IPS 详细信息 创建 IPS 创建 IPS 删除 IPS 删除 IPS 10 防病毒服务 查询防病毒列表 查询防病毒列表 查看防病毒详细信息 查看防病毒详细信息 创建防病毒 创建防病毒服务 删除防病毒 删除防病毒服务 安全资源服务接口传递以下参数:应包含:安全资源相关服务接口的对象名称和 ID、租户 ID、源
26、IP 地址和源端口、目的 IP 地址和目的端口、对应的协议和路由 ID;宜包含:对象策略的描述信息。租户管理接口应符合表5给出的功能要求。表5 租户管理接口 序号 接口类型 接口功能 功能描述 1 令牌 认证并生成令牌 认证并生成令牌 验证令牌 验证指定的用户令牌 2 组织 创建组织 创建组织 查询组织列表 查询组织列表 查看组织详细信息 查看组织详细信息 修改组织 对指定组织进行修改 删除组织 删除指定组织 授予组织用户某一角色 向组织中指定用户授予指定角色的权限 撤回组织用户角色 撤回组织中指定用户的角色权限 GY/T 3552021 10 表 5(续)序号 接口类型 接口功能 功能描述
27、3 用户 创建用户 创建用户 查询用户列表 查询用户列表 显示用户详情 显示用户详情 修改用户 为已经启用或者禁用的用户修改密码 删除用户 删除指定用户 4 角色 查询角色 查询角色 5 权限分组 查询权限分组 查询权限分组 6 用户、组织和权限分组之间映射关系 授予组织下某用户权限分组 授予组织下某用户权限分组 回收组织下某用户的权限分组 回收组织下某用户的权限分组 租户管理接口传递以下参数:应包含:用户名称、租户名称、密码和生成的令牌、组织名称、组织 ID、用户 ID、角色名称、角色 ID 和权限分组 ID;宜包含:组织描述和用户描述信息。7.1.3 数据库访问类 数据库访问类接口应符合表
28、6给出的功能要求。表6 数据库访问类接口 接口类型 接口功能 功能描述 数据库访问 创建数据库实例 根据选定的内存、磁盘空间和数据库类型创建出相应数据库实例 查询数据库实例详情 供用户查询数据库实例详细信息,包含数据库地址、用户名、密码 释放数据库实例 根据数据库实例 ID 删除并释放相应的数据库实例 重启数据库实例 根据数据库实例 ID 重启相应的数据库服务 数据库访问类接口传递以下参数:应包含:授权令牌、时间标识、实例名称、数据库实例 ID、数据库类型、数据库版本号、数据库存储、CPU 规格和内存规格;宜包含:附属信息。7.1.4 资源监控服务类 资源监控类服务接口主要包括告警接口和查询接
29、口。告警接口应符合表 7 给出的功能要求。表7 告警接口 接口类型 接口功能 功能描述 告警接口 上报告警 上报告警信息至第三方 查询告警 查询告警信息 清除告警 清除告警信息 GY/T 3552021 11 告警接口传递以下参数:应包含:告警编号、告警 ID、告警名称、告警对象实例、流水号、告警类型、数据类型、告警产生时间、告警清除时间和清除类型;宜包含:告警描述信息。查询接口应符合表8给出的功能要求。表8 查询接口 序号 接口类型 接口功能 功能描述 1 计算资源查询 查询虚机列表 查询虚机列表 查询虚机具体信息 查询虚机的基本信息、详情 查询容器列表 查询容器列表 查询容器具体信息 查询
30、容器的基本信息、详情 2 存储资源查询 查看磁盘详细列表 查看租户的磁盘的详细列表 查询磁盘信息 查询指定磁盘信息 查询所有磁盘快照 查询租户的所有磁盘快照列表 查询磁盘快照信息 查询指定磁盘快照信息 3 网络资源查询 查询网络 查询指定网络详情 查询子网信息 查询指定子网信息 查询子网列表 查询指定租户的子网列表 查询路由信息 查询指定虚拟路由 查询路由列表 查看虚拟路由列表 查询安全组 查询指定安全组信息 查询安全组规则 查询指定安全组规则 查询虚拟网卡列表 查询租户可访问的虚拟网卡 查询虚拟网卡 查询指定虚拟网卡的信息 查询公网 IP 地址列表 查询符合要求的租户可以访问的公网 IP 地
31、址 查询公网 IP 地址信息 查询指定公网 IP 地址信息 查询接口传递以下参数:应包含:多租户云环境下的租户或组织 ID、虚机 ID、容器 ID、硬盘 ID、快照 ID、网络和子网 ID、网络对象列表、网络名称、路由 ID、安全组 ID、虚拟网卡的 MAC 地址、虚拟网卡的接口 ID 和使用该网卡的设备 ID、公网 IP 地址的 ID;宜包含:网络状态、网络的最大传输单元、接口安全状态、网络节点可用域和可访问的公网IP 地址信息。7.1.5 资源结算服务类 资源结算服务类接口主要包括资源定价接口、资源订单接口、资源申请用户接口和资源费用详情接口,各接口应符合表9给出的功能要求。GY/T 35
32、52021 12 表9 资源结算服务类接口 接口类型 接口功能 功能描述 资源结算服务 资源定价 描述资源定价对象,为系统提供资源定价的模型,实现资源定价对象的增加、删除、修改和查询功能 资源订单 描述资源订单对象,实现资源订单对象的增加、删除、修改和查询功能 资源申请用户 用于记录和描述申请资源的用户对象信息,实现资源申请用户对象的增加、删除、修改和查询功能 资源费用详情 用于资源费用详情的描述和操作功能,实现资源计费的费用详情查询功能 资源结算服务类接口传递以下参数:应包含:授权令牌、时间标识、资源结算相关服务接口的对象 ID、用户 ID、定价模型、申请 用户和组织机构名;宜包含:资源类型
33、、价格、计费类型、计费单位、计费折扣、订单时间、联系方式和账户信息。7.1.6 资源日志服务类 资源日志服务类接口主要包括资源日志提交方式接口、资源日志位置接口和资源日志详情接口,各接口应符合表10给出的功能要求。表10 资源日志服务类接口 接口类型 接口功能 功能描述 资源日志服务 资源日志提交方式 描述平台当前资源的日志提交方式,包括文件方式、HTTP 方式、SNMP 方式,实现日志提交方式的增加、删除、修改和查询功能 资源日志位置 描述平台资源日志的位置信息,包括 HTTP/HTTPS 地址、文件路径,实现资源日志位置对象的增加、删除、修改和查询功能 资源日志详情 描述平台资源日志的详细
34、信息,实现资源日志详情对象的增加和查询功能 资源日志服务类接口传递以下参数:应包含:授权令牌、时间标识、进程名、进程 ID、资源 ID、需要获取的资源日志位置和资源日志提交方式的文本信息;宜包含:日志级别和日志详细内容。7.2 平台服务层与软件服务层交互 7.2.1 概述 平台服务层与软件服务层之间交互接口主要包括用户管理类接口、媒体资源管理类接口和公共服务能力管理类接口。7.2.2 用户管理类 平台服务层提供统一的用户、组织机构、权限管理,对平台的所有用户信息进行统一管理和认证,实现单点登录。用户管理类接口应符合表 11 给出的功能要求。GY/T 3552021 13 表11 用户管理类接口
35、 序号 接口类型 接口功能 功能描述 1 接口认证 获取授权令牌 平台服务层的服务对每个访问的请求进行身份验证,应在请求中带上令牌信息 2 权限管理 获取组织结构信息 获取组织结构信息应先获取授权令牌,调用此接口可获取平台内的组织结构信息 获取指定部门/组的用户信息 获取指定部门/组的用户信息应先获取授权令牌,通过参数中传递的部门/组标识,返回该部门/组下的用户信息列表 获取指定应用的用户信息 获取指定应用的用户信息应先获取授权令牌,通过参数中传递的应用标识,自动匹配该用户所在应用,并返回该应用下的用户信息列表 获取指定用户的信息 获取指定用户信息应先获取授权令牌,通过参数中传递的要查询的用户
36、标识,返回该用户的信息详情 根据用户名查询用户 获取指定用户信息应先获取授权令牌,通过参数中传递的要查询的用户名称,返回该用户的信息详情 获取栏目列表信息 获取栏目列表信息应先获取授权令牌,调用此接口可获取平台内的栏目列表信息 获取指定栏目的用户信息 获取指定栏目的用户信息应先获取授权令牌,通过参数中传递的栏目标识,返回该栏目下的用户信息列表 用户管理类接口应传递的参数包括:应用标识、版本号、企业标识、服务标识、部门/组标识、栏目标识、用户标识、用户名称、密钥以及由时间标识生成的相应的授权令牌。7.2.3 媒体资源管理类 对媒体资源的格式和访问方式进行统一规范,使平台具备管理来自多种类型的媒体
37、资源的接口能力,实现媒体资源统一的存储管理和跨应用的内容共享。媒体资源管理类接口应符合表 12 给出的功能要求。表12 媒体资源管理类接口 接口类型 接口功能 功能描述 媒体资源管理 FTP 上传 提供 FTP 服务,上传媒体资源文件 断点续传 提供文件断点续传服务,上传媒体资源文件 文件上传 提供文件上传服务,上传媒体资源文件 断点上传续传进度查询 提供文件断点上传续传进度查询服务,上传媒体资源文件 资源注册 根据传入参数注册资源 资源查询 根据提供的资源注册标识,返回该资源标识所属的资源详细信息 按条件资源查询 根据提供的时间、关键词检索资源,返回对应检索条件的资源详细信息 删除资源 根据
38、提供的资源注册标识,删除该注册标识所属的资源信息 GY/T 3552021 14 表 12(续)接口类型 接口功能 功能描述 媒体资源管理 更新资源素材包信息 根据提供的资源素材包信息,编辑该资源素材包所对应的资源基本信息 新增资源媒体文件信息 根据提供的新增素材包信息,将新的素材信息添加到指定资源中 删除资源媒体文件信息 根据提供的需要删除的素材标识信息,将需要删除的素材信息从指定资源中删除 资源包与已有媒体文件绑定 根据提供的资源标识和素材标志,将资源与素材进行关系绑定 资源分享或移交 根据提供的信息,进行资源的分享或移交 查询个人同步资源 根据提供的信息,进行查询个人同步资源 媒体资源管
39、理类接口应传递以下参数:a)通用参数:授权令牌和时间标识;b)FTP 上传接口:主要包含 FTP 服务的用户名、FTP 服务的密码、FTP 服务器 IP 地址和端口号;c)断点续传接口:主要包含素材名称、素材大小和公共参数信息;d)文件上传接口:主要包含上传令牌、文件的 MD5 值、文件流和公共参数信息;e)断点上传续传进度查询接口:主要包含上传令牌和公共参数信息;f)资源注册接口:主要包含素材包编码后的字符串信息;g)资源查询接口:主要包含注册资源时获取的唯一标识;h)按条件资源查询接口:主要包含开始时间、结束时间、搜索关键词、查询从第几页开始和每页显示条数;i)删除资源接口:主要包含删除的
40、素材包标识;j)更新资源素材包信息接口:主要包含素材包编码后的字符串信息;k)新增资源媒体文件信息接口:主要包含素材包编码后的字符串信息;l)删除资源媒体文件信息接口:主要包含资源标识及需要删除的视频、音频、图片、图形、文稿和其他文件的标识;m)资源包与已有媒体文件绑定接口:主要包含资源标识及需要绑定的视频、音频、图片、图形、文稿和其他文件的标识;n)资源分享或移交接口:主要包含被分享或移交的企业标识、服务标识、应用标志、用户部门ID、用户 ID 和资源唯一标识;o)查询个人同步资源接口:主要包含查询资源的用户 ID。7.2.4 公共服务能力管理类 公共服务能力管理类接口应符合表 13 给出的
41、功能要求。GY/T 3552021 15 表13 公共服务能力管理类接口 序号 接口类型 接口功能 功能描述 1 转码服务 转码任务创建 提供转码任务创建服务 转码状态查询 提供转码状态查询服务 转码任务重试 提供转码任务重试服务 转码模板查询 提供转码模板查询服务 2 拆条服务 拆条任务创建 提供拆条任务创建服务 拆条状态查询 提供拆条状态查询服务 3 技审服务 技审任务创建 提供技审任务创建服务 技审任务查询 提供技审任务查询服务 技审任务重试 提供技审任务重试服务 4 智能处理服务 智能处理任务创建 提供智能处理任务创建服务 智能处理任务查询 提供智能处理任务查询服务 5 截图服务 关键
42、帧截图 提供关键帧截图服务 定时截图 提供定时截图服务 定量截图 提供定量截图服务 首帧截图 提供首帧截图服务 定点截图 提供定点截图服务 6 快编服务 快编任务创建 提供快编任务创建服务 快编状态查询 提供快编状态查询服务 7 收录服务 任务添加 提供收录任务添加服务 模板列表查询 提供收录模板查询服务 模板参数查询 提供收录模板参数查询服务 任务查询 提供收录任务查询服务 8 直播服务 频道开通(推流模式)提供推流模式的直播频道开通服务 频道开通(拉流模式)提供拉流模式的直播频道开通服务 频道关闭 提供直播频道关闭服务 模板查询 提供直播终端编码模板查询服务 模板参数查询 提供直播终端编码
43、模板参数查询服务 频道状态查询 提供频道状态查询服务 9 数据分析服务 分词 将输入的文本内容进行分词,返回分词列表数据 关键词提取 根据输入的文本信息,按照用户指定的数量提取关键词 新闻自动摘要 根据输入的新闻内容,自动提取摘要信息 新闻自动分类 提供新闻内容的自动分类 个性化推荐 根据用户的喜好提供个性化推荐 最新话题 提供最新入库的内容 用户订阅内容 自动推送用户订阅关注的内容 事件脉络 抽取延续时间较长的新闻事件发展的重要阶段,帮助用户快速了解该事件的来龙去脉 情感分析 根据输入的文本信息,判断内容的正负面情绪 GY/T 3552021 16 公共服务能力管理类接口应传递以下参数:a)
44、通用参数:授权令牌和时间标识;b)转码服务接口:主要包含源文件地址、回调通知地址、优先级、转码输出模板、是否切片和转码生成文件存储的路径;c)拆条服务接口:主要包含任务 ID、源文件地址、回调通知地址、优先级和拆分时间点;d)技审服务接口:主要包含任务 ID、源文件地址、回调通知地址、优先级和技审检测参数;e)智能处理服务接口:主要包含任务 ID、文件的访问地址、回调通知地址、优先级和扩展参数;f)截图服务接口:主要包含视频地址、回调通知地址和图片分辨率;g)快编服务接口:主要包含任务 ID、快编需要的具体信息、优先级和回调通知地址;h)收录服务接口:主要包含任务 ID、模板 ID、回调通知地
45、址、视频信号源地址、收录任务开始时间、收录任务结束时间和收录文件的编码参数模板;i)直播服务接口:主要包含信号源地址、终端模板、扩展参数、频道 ID 和模板 ID;j)数据分析服务接口:主要包含需要分词的文本、需要提取关键词的文本内容、提取关键词的数量、需要分析的文本列表、文本信息、用户行为分析记录集、用户行为分析推荐内容、最新入库的内容、用户关注列表、关注内容、时间脉络图片、点坐标和点详情。8 融合媒体云平台内部私有云、公有云和专属云之间交互接口 8.1 概述 在融合媒体云平台中,私有云、公有云和专属云是融合互补的关系,存放在各种云平台中的数据交互接口包括媒体数据迁移类接口、消息传递类接口和
46、运行管理类接口。8.2 媒体数据迁移类 媒体数据迁移类接口应符合表14给出的功能要求。表14 媒体数据迁移类接口 接口类型 接口功能 功能描述 媒体数据迁移 新建任务 根据已设定好的任务流程创建迁移任务 查询任务 根据任务 ID 查询任务信息 获取任务 根据任务 ID 获取任务信息 暂停、继续任务 根据任务 ID 对当前正在执行的任务进行暂停、继续 取消任务 根据任务 ID 删除任务 修改任务优先级 根据任务 ID 修改正在迁移任务的优先级 媒体数据迁移类接口传递以下参数:应包含:授权令牌、时间标识、任务名称、任务 ID、目标应用 URL、通知目标应用时所携带数据、任务完成后的回调 URL、迁
47、移文件信息数组、任务状态和任务完成百分比;宜包含:任务优先级、失败是否继续任务、文件已存在应采取的操作、当前进度描述信息、任务经历的处理节点、任务当前所处流程节点在整个流程中的索引和任务当前所处流程节点的百分比进度。8.3 消息传递类 GY/T 3552021 17 消息传递类接口应符合表15给出的功能要求。表15 消息传递类接口 接口类型 接口功能 功能描述 消息传递 创建队列 用于存储进程间传输的消息 发送消息 用于向指定队列发送消息 获取消息 用于获取指定队列中的消息 删除队列 用于删除指定的消息队列 消息传递类接口应传递的参数包括:授权令牌、时间标识、队列名称、消息接收轮询等待时间和消
48、息正文。8.4 运行管理类 平台服务层运行管理服务应通过调用基础设施服务层云管平台接口实现混合云架构下不同云基础资源环境的统一管理,应定制开发专用的云接入模块,将私有云、公有云和专属云各云平台的计算资源、存储资源、网络资源的资源管理接口封装为统一接口,为软件服务层提供服务。9 融合媒体云平台与外部平台之间交互接口 融合媒体云平台与外部平台交互时应遵循相关行业标准、规范或合作平台的对接要求。对于融合媒体云平台系统内自建或与其他平台合作提供的综合服务类接口,应遵循主管部门制定及所属行业推行的标准、规范:a)政务服务类,包括信息发布、政务公开、政务大厅接入、用户交流互动、用户调查及服务评价等类型的接
49、口,应遵循 GB/T 390442020、GB/T 390462020 的要求;b)电子商务服务类,包括交易、物流、评价、互动等类型的接口,应遵循 GB/T 315242015、GB/T 363182018 的要求;c)党建服务类、公共服务类服务接口应遵循相关行业规范或合作平台的对接要求。GY/T 3552021 18 附 录 A(资料性)接口定义示例 A.1 概述 本文件的接口定义示例包括接口使用的功能描述、参数、返回值等属性,接口定义采用HTTP的POST和GET请求方式描述,具体实现可采用DELETE、PUT请求方法。A.2 任务创建接口 A.2.1 功能描述 创建新的任务 HTTP方法
50、:POST 请求URL:http(s):/domain/service/version/optional/task/create http(s):/域名/服务/版本/可选值/资源/方法 A.2.2 请求参数 Header参数:Content-Type:application/json Body请求参数:应包含:任务名称、创建者唯一标识、任务执行者 可包含:创建者、任务类型、任务状态、扩展信息 请求示例:name:任务一,creator:张三,creator_id:64ec22c795384ae380cda1d5193bcf90,executor_id:64ec22c795384ae380cda