【PDF】视频直播 - 资源下载

编辑：

kr9梯

2019-11-21

视频直播 API 参考文档版本

保留一切权利. 非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传播. 商标声明和其他华为商标均为华为技术有限公司的商标. 本文档提及的其他所有商标或注册商标,由各自的所有人拥有. 注意您购买的产品、服务或特性等应受华为公司商业合同和条款的约束,本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内.除非合同另有约定,华为公司对本文档内容不做任何明示或默示的声明或保证. 由于产品版本升级或其他原因,本文档内容会不定期进行更新.除非另有约定,本文档仅作为使用指导,本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保. 文档版本

2 API 概览.2

3 约束与限制.4

4 调用方式.5 4.1 请求结构.5 4.2 公共参数.6 4.3 返回结果.8 4.4 请求签名.8

5 域名管理.18

6 通知管理.19

7 鉴权管理.20

8 转码模板管理.21 8.1 查询直播转码模板.21 8.2 配置直播转码模板.24 8.3 创建直播转码模板.27 8.4 删除直播转码模板.29

9 流管理.31 9.1 查询禁播黑名单列表.31 9.2 修改禁播属性.33 9.3 禁播(禁止直播推流)35 9.4 禁播恢复(恢复直播推流)36 9.5 查询流禁播历史.37 9.6 查询直播推流列表.39 9.7 查询直播加速的带宽数据.42 9.8 查询直播加速的流量数据.44 9.9 查询直播播放在线人数.46

10 录制管理.48 10.1 查询录制配置.48 10.2 创建录制配置.50 视频直播 API 参考目录文档版本

1 简介文档版本

1 2API 概览转码模板管理接口接口说明 POST /v1/{project_id}/template/ transcodings 创建直播转码模板 DELETE /v1/{project_id}/template/ transcodings 删除直播转码模板 PUT /v1/{project_id}/template/ transcodings 配置直播转码模板 GET /v1/{project_id}/template/ transcodings 查询直播转码模板流管理接口接口说明 POST /v1/{project_id}/stream/blocks 禁播(禁止直播推流) PUT /V1/{project_id}/stream/blocks 修改禁播属性 DELETE /v1/{project_id}/stream/blocks 禁播恢复(恢复直播推流) GET /v1/{project_id}/stream/publish_list 查询直播推流列表 GET /v1/{project_id}/stream/bandwidth 查询直播加速的带宽数据 GET /v1/{project_id}/stream/traffic 查询直播加速的流量数据 GET /v1/{project_id}/stream/users 查询直播播放在线人数视频直播 API 参考

2 API 概览文档版本

2 录制管理接口接口说明 POST /v1/{project_id}/record/config 创建录制配置 GET /v1/{project_id}/record/config 查询录制配置 DELETE /v1/{project_id}/record/config 删除录制配置视频直播 API 参考

2 API 概览文档版本

3 3约束与限制目前直播暂只支持创建1个应用,即 AppName 默认为 live ,若您需要自定义 AppName,请先提交工单申请. 视频直播 API 参考

3 约束与限制文档版本

4 4调用方式 4.1 请求结构 4.2 公共参数 4.3 返回结果 4.4 请求签名 4.1 请求结构调用华为云视频直播服务的API是通过向指定服务地址发送请求,并按照API文档说明在请求中添加相应的公共参数和接口参数来完成的. 华为云视频直播服务API的请求结构组成如下所示. 请求方法在HTTP协议中,请求可以使用多种请求方法例如GET、PUT、POST、DELETE,用于指明以何种方式来访问指定的资源,目前直播服务提供的REST接口支持的请求方法如下表所示: 方法说明 GET 请求服务器返回指定资源. PUT 请求服务器更新指定资源. POST 请求服务器新增资源或执行特殊操作. DELETE 请求服务器删除指定资源,如删除对象等. 服务地址客户端的应用通过URL(Unified Resource Locator)来调用API获取资源.URL的一般格式为:https://Endpoint/URI,其中Endpoint即为API的接入地址,您可以华为云地区和终端节点页面查询获取. 视频直播 API 参考

4 调用方式文档版本

5 直播服务的Endpoint当前为live.cn-north-1.myhuaweicloud.com. 通信协议为保障通信的安全性,华为云视频直播服务推荐使用HTTPS请求通信. 请求参数 API请求参数包含两部分:公共请求参数和接口请求参数.其中,公共请求参数是每个接口都要用到的请求参数,具体请参见公共参数.接口请求参数指各API所特有的,具体请参见各API的请求参数部分的描述. 4.2 公共参数公共参数指的是所有接口调用都需要用到的参数.若非必须,在每个接口的参数说明中不再单独描述,但每次请求都需要携带这些参数,才能正常请求调用. 公共请求消息头参数每个接口调用都需要携带的消息头参数. 表4-1 公共请求消息头参数消息头名称描述是否必选 Host 主机地址.直播服务的Host为: live.cn- north-1.myhuaweicloud.com 是Content-Type 发送的实体的MIME类型.默认值:application/ json 是Content-Length 资源内容的长度. 否X-sdk-date 请求的发生时间,格式为 (YYYYMMDD'

HHMMSS'

).取值为当前系统的GMT时间. 否Authorization 请求消息中携带的鉴权信息. 否X-Auth-Token 如果使用Token认证的方式,此字段携带认证密钥.类型:字符串.默认值:无. 否API 公共参数 API的调用URI中包含 project_id , project_id 是指您在公有云上注册成功后所拥有的项目编号,如创建直播域名接口:POST /v1/{project_id}/domain. 您可以参见如下方法获取 project_id : 步骤1 注册华为云,完成实名认证. 步骤2 在账号中心的左侧导航树中选择基本信息 ,进入基本信息页面. 视频直播 API 参考

4 调用方式文档版本

6 步骤3 在基本信息页面单击管理我的凭证 ,进入凭证管理页面. 步骤4 选择项目列表页签,在项目列表中根据所属区域及项目获取对应的项目ID . 目前视频直播服务仅有华北-北京一 ,您只需要获取该区域对应的项目ID 即可. ----结束公共响应消息头参数每个接口调用都会返回的响应头参数表4-2 公共响应消息头参数消息头名称描述是否必选 Content-Type 发送给接收者的实体正文的媒体类型. 类型:字符串. 默认值:application/json;

charset=UTF-8. 是X-request-id 此字段携带请求ID号,以便任务跟踪. 类型:字符串. request_id-timestamp-hostname(request_id在服务器端生成UUID, timestamp为当前时间戳, hostname为处理当前接口的服务器名称). 默认值:无. 是X-ratelimit 此字段携带总计流控请求数. 类型:整型. 默认值:无. 否视频直播 API 参考

4 调用方式文档版本

7 消息头名称描述是否必选 X-ratelimit- used 此字段携带剩下请求数. 类型:整型. 默认值:无. 否X-ratelimit- window 此字段携带流控单位,有分钟、小时、天三种. 类型:字符串. 默认值:小时. 否4.3 返回结果调用API服务后返回数据采用统一格式. 返回2xx的HTTP状态码代表调用成功,返回4xx或5xx的HTTP状态码代表调用失败.统一返回json格式的响应. 成功结果以查询直播播放在线人数为例,若调用成功,其返回如下所示: { total : 1, user_info : [ { user_num : 1000, timestamp : 2018-05-19T21:10:15Z } ] } 若接口调用成功,HTTP 请求返回一个 2xx 的HTTP状态码.返回的消息体中是具体的返回参数. 错误结果若调用失败,其返回如下所示: { error_code : LIVE.100011001 , error_msg : Request Illegal } 若接口调用失败,将不会有返回结果数据.HTTP 请求返回一个 4xx 或5xx 的HTTP状态码.返回的消息体中是具体的错误代码(error_code)及错误信息(error_msg).您可以根据每个接口对应的错误码来定位错误原因. 4.4 请求签名 API会对每个访问请求进行身份验证,即每个请求都需要在公共请求参数中包含签名信息(Signature)以验证请求者身份. 签名信息由安全凭证生成,安全凭证包括 AK和SK.若您还没有安全凭证,请先前往账号中心申请,否则将无法调用直播的API. 视频直播 API 参考

4 调用方式文档版本

8 l AK(Access Key ID):访问密钥ID.与私有访问密钥关联的唯一标识符;

访问密钥 ID和私有访问密钥一起使用,对请求进行加密签名. l SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改. 获取 AK 和SK 注意:访问密钥对账号具有完全的访问权限,如果访问密钥泄露,会带来数据泄露风险,为了账号安全性,建议您定期更换并妥善保存访问密钥.每个账号最多只能创建2 个密钥. 步骤1 注册华为云,完成实名认证. 步骤2 在账号中心的左侧导航树中选择基本信息 ,进入基本信息页面. 步骤3 在基本信息页面单击管理我的凭证 ,进入凭证管理页面. 步骤4 选择管理访问密钥页签,单击新增访问密钥 ,在弹出的页面中输入华为云账号密码及短信验证码. 步骤5 单击确定 ,即可下载一个命名为 credentials.csv 的文件,其中包含AK和SK. ----结束请求签名您在调用API时,需要按照下面的方法对请求进行签名验证. 步骤1 获取API网关签名工具,解压得到JAR包. 视频直播 API 参考

4 调用方式文档版本

9 步骤2 创建JAVA工程,将JAR包引用到依赖路径中. 步骤3 创建用于签名的请求com.cloud.sdk.DefaultRequest. 步骤4 设置DefaultRequest的目标API URL、HTTPS方法及内容等信息. 步骤5 对DefaultRequest进行签名. 1. 调用SignerFactory.getSigner(String serviceName, String regionName)获取一个签名工具实现的实例. 2. 调用Signer.sign(Request request, Credentials credentials)对步骤3创建的请求进行签名. 以下为代........

注：以上内容是本站开源项目的机器提供的预览内容，更完整和更好的阅读体验请直接免费下载资源后阅读

下载（注：源文件不在本站服务器，都将跳转到源网站下载）

备用下载

PDF《视频直播》