华为云用户手册

截图管理接口 表5 截图管理接口 接口 说明 POST /v1/{project_id}/stream/snapshot 创建直播截图配置 PUT /v1/{project_id}/stream/snapshot 修改直播截图配置 GET /v1/{project_id}/stream/snapshot 查询直播截图配置 DELETE /v1/{project_id}/stream/snapshot 删除直播截图配置

流管理接口 表3 流管理接口 接口 说明 POST /v1/{project_id}/stream/blocks 禁止直播推流 GET /v1/{project_id}/stream/blocks 查询禁止直播推流列表 DELETE /v1/{project_id}/stream/blocks 禁推恢复 PUT /v1/{project_id}/stream/blocks 修改禁推属性 GET /v1/{project_id}/realtime/streams 查询直播中的流信息

录制回调管理接口 表8 录制回调管理接口 接口 说明 POST /v1/{project_id}/record/callbacks 创建录制回调配置 GET /v1/{project_id}/record/callbacks 查询录制回调配置列表 PUT /v1/{project_id}/record/callbacks/{id} 修改录制回调配置 GET /v1/{project_id}/record/callbacks/{id} 查询录制回调配置 DELETE /v1/{project_id}/record/callbacks/{id} 删除录制回调配置

HTTPS证书管理接口 表9 HTTPS证书管理接口 接口 说明 PUT /v1/{project_id}/guard/https-cert 修改指定域名的HTTPS证书配置 GET /v1/{project_id}/guard/https-cert 查询指定域名的HTTPS证书配置 DELETE /v1/{project_id}/guard/https-cert 删除指定域名的HTTPS证书配置

数据统计分析接口 表11 数据统计分析接口 接口 说明 GET /v2/{project_id}/stats/bandwidth/detail 查询播放带宽趋势 GET /v2/{project_id}/stats/traffic/detail 查询播放流量趋势 GET /v2/{project_id}/stats/bandwidth/peak 查询播放带宽峰值 GET /v2/{project_id}/stats/traffic/summary 查询播放流量汇总 GET /v2/{project_id}/stats/user 查询观众趋势 GET /v2/{project_id}/stats/httpcodes 查询直播拉流HTTP状态码 GET /v2/{project_id}/stats/transcode 查询转码用量 GET /v2/{project_id}/stats/record 查询录制用量 GET /v2/{project_id}/stats/snapshot 查询截图用量 GET /v2/{project_id}/stats/up-bandwidth/detail 查询上行带宽数据 GET /v2/{project_id}/stats/stream-count 查询域名维度推流路数 GET /v2/{project_id}/stats/history/streams 查询历史推流列表 GET /v2/{project_id}/stats/stream-portraits 查询播放画像信息 GET /v2/{project_id}/stats/area/detail 查询直播各区域指标分布

域名管理接口 表1 域名管理接口 接口 说明 POST /v1/{project_id}/domain 创建直播域名 DELETE /v1/{project_id}/domain 删除直播域名 PUT /v1/{project_id}/domain 修改直播域名 GET /v1/{project_id}/domain 查询直播域名 PUT /v1/{project_id}/domains_mapping 域名映射 DELETE /v1/{project_id}/domains_mapping 删除直播域名映射关系 GET /v1/{project_id}/cdn/ip-info 查询IP归属信息

转码模板管理接口 表2 转码模板管理接口 接口 说明 POST /v1/{project_id}/template/transcodings 创建直播转码模板 DELETE /v1/{project_id}/template/transcodings 删除直播转码模板 PUT /v1/{project_id}/template/transcodings 配置直播转码模板 GET /v1/{project_id}/template/transcodings 查询直播转码模板

国家名称缩写 表1 国家名称缩写 国家 英文缩写 阿富汗 AF 奥兰群岛 AX 阿尔巴尼亚 AL 阿尔及利亚 DZ 美属萨摩亚 AS 安道尔 AD 安哥拉 AO 安圭拉 AI 安提瓜和巴布达 AG 阿根廷 AR 亚美尼亚 AM 阿鲁巴 AW 澳大利亚 AU 奥地利 AT 阿塞拜疆 AZ 孟加拉 BD 巴林 BH 巴哈马 BS 巴巴多斯 BB 比利时 BE 伯利兹 BZ 贝宁 BJ 百慕大 BM 不丹 BT 玻利维亚 BO 波斯尼亚和黑塞哥维那 BA 博茨瓦纳 BW 布维岛 BV 巴西 BR 文莱 BN 保加利亚 BG 布基纳法索 BF 布隆迪 BI 柬埔寨 KH 喀麦隆 CM 加拿大 CA 佛得角 CV 中非 CF 乍得 TD 智利 CL 圣诞岛 CX 科科斯（基林）群岛 CC 哥伦比亚 CO 科摩罗 KM 刚果（金） CD 刚果 CG 库克群岛 CK 哥斯达黎加 CR 科特迪瓦 CI 中国 CN 克罗地亚 HR 捷克 CZ 塞浦路斯 CY 丹麦 DK 吉布提 DJ 多米尼加 DM 厄瓜多尔 EC 埃及 EG 赤道几内亚 GQ 厄立特里亚 ER 爱沙尼亚 EE 埃塞俄比亚 ET 法罗群岛 FO 斐济 FJ 芬兰 FI 法国 FR 法国大都会 FX 法属圭亚那 GF 法属波利尼西亚 PF 加蓬 GA 冈比亚 GM 格鲁吉亚 GE 德国 DE 加纳 GH 直布罗陀 GI 希腊 GR 格林纳达 GD 瓜德罗普岛 GP 关岛 GU 危地马拉 GT 根西岛 GG 几内亚比绍 GW 几内亚 GN 圭亚那 GY 海地 HT 洪都拉斯 HN 匈牙利 HU 冰岛 IS 印度 IN 印度尼西亚 ID 伊拉克 IQ 爱尔兰 IE 马恩岛 IM 意大利 IT 牙买加 JM 日本 JP 泽西岛 JE 约旦 JO 哈萨克斯坦 KZ 肯尼亚 KE 基里巴斯 KI 韩国 KR 科威特 KW 吉尔吉斯斯坦 KG 老挝 LO 拉脱维亚 LV 黎巴嫩 LB 莱索托 LS 利比里亚 LR 利比亚 LY 列支敦士登 LI 立陶宛 LT 卢森堡 LU 北马其顿 MK 马拉维 MW 马来西亚 MY 马达加斯加 MG 马尔代夫 MV 马里 ML 马耳他 MT 马绍尔群岛 MH 马提尼克岛 MQ 毛里塔尼亚 MR 毛里求斯 MU 马约特 YT 墨西哥 MX 密克罗尼西亚 MF 摩尔多瓦 MD 摩纳哥 MC 蒙古 MN 黑山 ME 蒙特塞拉特 MS 摩洛哥 MA 莫桑比克 MZ 缅甸 MM 纳米比亚 NA 瑙鲁 NR 尼泊尔 NP 荷兰 NL 新喀里多尼亚 NC 新西兰 NZ 尼加拉瓜 NI 尼日尔 NE 尼日利亚 NG 纽埃 NU 诺福克岛 NF 挪威 NO 阿曼 OM 巴基斯坦 PK 帕劳 PW 巴拿马 PA 巴布亚新几内亚 PG 秘鲁 PE 菲律宾 PH 皮特凯恩群岛 PN 波兰 PL 葡萄牙 PT 波多黎各 PR 卡塔尔 QA 留尼汪岛 RE 罗马尼亚 RO 卢旺达 RW 圣赫勒拿 SH 圣基茨和尼维斯 KN 圣卢西亚 LC 圣文森特和格林纳丁斯 VG 萨尔瓦多 SV 萨摩亚 WS 圣马力诺 SM 圣多美和普林西比 ST 沙特阿拉伯 SA 塞内加尔 SN 塞舌尔 SC 塞拉利昂 SL 新加坡 SG 塞尔维亚 RS 斯洛伐克 SK 斯洛文尼亚 SI 所罗门群岛 SB 索马里 SO 南非 ZA 西班牙 ES 斯里兰卡 LK 苏里南 SR 斯威士兰 SZ 瑞典 SE 瑞士 CH 塔吉克斯坦 TJ 坦桑尼亚 TZ 泰国 TH 特立尼达和多巴哥 TT 东帝汶 TL 多哥 TG 托克劳 TK 汤加 TO 突尼斯 TN 土耳其 TR 土库曼斯坦 TM 图瓦卢 TV 乌干达 UG 乌克兰 UA 阿拉伯联合酋长国 AE 英国 UK 美国 US 乌拉圭 UY 乌兹别克斯坦 UZ 瓦努阿图 VU 梵蒂冈 VA 委内瑞拉 VE 越南 VN 瓦利斯群岛和富图纳群岛 WF 也门 YE 赞比亚 ZM 津巴布韦 ZW 父主题： 附录

约束与限制 视频直播 服务设置了API流控限制，避免因短时间内重复调用API导致服务中断的情况出现。API流控限制说明如表2所示。 表2 API流控限制 接口分类 接口名称 用户流量限制 API流量限制 域名管理 创建直播域名 查询直播域名 300次/分钟 3000次/分钟 删除直播域名 修改直播域名 域名映射 删除直播域名映射关系 配置域名IPV6开关 100次/分钟 1000次/分钟 查询IP归属信息 5次/秒 5次/秒 转码模板管理 创建直播转码模板 删除直播转码模板 配置直播转码模板 查询直播转码模板 100次/分钟 1000次/分钟 流管理 禁止直播推流 修改禁推属性 4000次/分钟 12000次/分钟 禁推恢复 查询禁止直播推流列表 3000次/分钟 6000次/分钟 查询直播中的流信息 1000次/分钟 2000次/分钟 鉴权管理 查询指定域名的Key防盗链配置 修改指定域名的Key防盗链配置 删除指定域名的Key防盗链配置 150次/分钟 300次/分钟 截图管理 创建直播截图配置 修改直播截图配置 查询直播截图配置 删除直播截图配置 150次/分钟 300次/分钟 日志管理 获取直播播放日志 300次/分钟 3000次/分钟 录制管理 创建录制规则 查询录制规则列表 修改录制规则 删除录制规则 查询录制规则配置 提交录制控制命令 300次/分钟 3000次/分钟 创建录制视频索引文件 1200次/分钟 3000次/分钟 录制回调管理 创建录制回调配置 查询录制回调配置列表 修改录制回调配置 查询录制回调配置 删除录制回调配置 300次/分钟 300次/分钟 HTTPS证书管理 修改指定域名的HTTPS证书配置 查询指定域名的HTTPS证书配置 删除指定域名的HTTPS证书配置 150次/分钟 300次/分钟 OBS桶管理 OBS桶授权及取消授权 150次/分钟 300次/分钟 数据统计分析 查询播放带宽趋势接口 500次/分钟 5000次/分钟 数据统计分析 查询转码用量接口 查询录制用量接口 查询截图用量接口 查询播放画像信息接口 60次/分钟 5000次/分钟 查询播放流量趋势接口 查询播放带宽峰值接口 查询播放流量汇总接口 查询观众趋势接口 查询直播拉流HTTP状态码接口 查询上行带宽数据接口 查询域名维度推流路数接口 查询历史推流列表接口 20次/分钟 5000次/分钟 查询直播各区域指标分布接口 50次/秒 150次/秒 流监控 查询推流帧率数据接口 查询推流码率数据接口 20次/分钟 5000次/分钟 查询流监控数据接口 1次/秒 5次/秒 查询CDN上行推流质量数据接口 60次/秒 300次/秒

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用创建的用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型

概述 视频直播服务（Live）是在华为云提供的可信，开放，全球服务直播内容接入与分发网络的基础上，将华为公司在视频领域的多年技术积累和电信级运营和运维能力开放出来，构建了便捷接入、高清流畅、低延迟、高并发的一站式视频直播解决方案。 您可以使用本文档提供API对视频直播进行相关操作，如视频直播流的转码、管理、录制等。支持的全部操作请参见API概览。 在调用视频直播API之前，请确保已经充分了解视频直播相关概念，详细信息请参见产品介绍。 当前视频直播服务仅支持通过控制台配置直播播放的Refer防盗链和IP黑名单，对访问者的身份进行识别和过滤，符合规则的可以顺利播放直播资源，具体操作请参见配置直播鉴权。

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，Live的终端节点如表1所示。您也可以从地区和终端节点中查询服务的终端节点。 表1 Live的终端节点 区域名称 区域 终端节点（Endpoint） 华北-北京一 cn-north-1 live.cn-north-1.myhuaweicloud.com 华北-北京四 cn-north-4 live.cn-north-4.myhuaweicloud.com 亚太-新加坡 ap-southeast-3 live.ap-southeast-3.myhuaweicloud.com

URI GET /v1/{project_id}/stream/blocks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 域名 app_name 否 String 应用名称，不指定则查询domain下所有应用的禁止直播推流信息 stream_name 否 String 流名称 page 否 Integer 分页编号。 默认为0。 size 否 Integer 每页记录数。 取值范围：1-100。 默认为10。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必填，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填，携带项目ID信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 查询结果的总元素数量 blocks Array of StreamForbiddenList objects 禁推黑名单列表 表5 StreamForbiddenList 参数 参数类型 描述 app_name String 应用名称 stream_name String 流名称 resume_time String 恢复流时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间，不指定则默认7天，最大禁推为90天 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询禁止直播推流列表成功 { "total" : 2, "blocks" : [ { "app_name" : "live", "stream_name" : "test_001", "resume_time" : "2018-05-19T21:10:15Z" }, { "app_name" : "live", "stream_name" : "test_002", "resume_time" : "2018-06-12T20:10:10Z" } ]} 状态码： 400 查询禁止直播推流列表失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"}

返回示例 处理成功返回 { "total": 1, "record_config": [ { "domain": "cxf-live.huawei.com", "app_name": "live", "record_type": "configer_record", "record_duration": 1200, "record_format": "mp4", "record_location": "vod", "record_prefix": "Record_{DomainName}_{AppName}_{StreamName}_{StartTime}_{EndTime}", "obs_addr": { "bucket": "", "location": "", "object": "" }, "create_time": "2019-03-20T15:42:04.706+08:00" "stream_name":"", "start_time":"", "end_time":"" } ]} 处理失败返回 { "error_code": "LIVE.100011001", "error_msg": "Request Illegal"}

返回参数 查询录制配置成功 表1 查询成功返回参数说明 参数 类型 说明 total Integer 查询结果的总模板数量。 record_config Array of RecordConfigInfo objects 录制配置数组。 表2 RecordConfigInfo参数说明 参数 类型 说明 domain String 播放域名。 push_domain String 推流域名。 app_name String 应用名称。 record_duration Integer 周期录制时长，最小15分钟，最大6小时，默认1小时。单位：秒。 record_format String 录制格式，默认为flv。 record_location String 录制存储位置， 默认为vod。 record_prefix String 录制文件前缀， DomainName，AppName，StreamName必须，默认Record_{DomainName}_{AppName}_{StreamName}_{StartTime}_{EndTime} create_time String 创建时间。 start_time String 开始时间。 end_time String 结束时间。 stream_name String 流名称。 查询录制配置失败 表3 查询失败返回参数说明 参数 类型 说明 error_code String 错误码。 error_msg String 错误描述。

地区/国家代码对照表 计费大区 地区/国家 代码 AP1 亚太1区 中国香港 HK 中国澳门 MO 中国台湾 TW 日本 JP 韩国 KR AP2 亚太2区 泰国 TH 印度尼西亚 ID 菲律宾 PH 马来西亚 MY 新加坡 SG 柬埔寨 KH 老挝 LA 越南 VN AP3 亚太3区 印度 IN 澳大利亚 AU 孟加拉 BD MEAA 中东非洲 沙特阿拉伯 SA 伊拉克 IQ 阿联酋 AE 科威特 KW 卡塔尔 QA 阿曼 OM 巴林 BH 阿塞拜疆 AZ 土耳其 TR 南非 ZA 埃及 EG 加纳 GH 肯尼亚 KE 尼日利亚 NG SA 南美 阿根廷 AR 巴西 BR 智利 CL 哥伦比亚 CO 墨西哥 MX 秘鲁 PE EU 欧洲 哈萨克斯坦 KZ 蒙古国 MN 乌兹别克斯坦 UZ 保加利亚 BG 白俄罗斯 BY 西班牙 ES 法国 FR 英国 GB 德国 DE 希腊 GR 爱尔兰 IE 意大利 IT 荷兰 NL 波兰 PL 罗马尼亚 RO 俄罗斯 RU 瑞典 SE 父主题： 附录

操作步骤 获取用户Token，用于调用直播接口时进行认证鉴权。 详细信息请参见构造请求。以“华北-北京四”为示例，若您需要调用其它区域的直播接口，请替换成对应区域的IAM终端节点。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "projectname" } } }} 如图1所示，红框中的信息为获取用户Token。 图1 获取用户Token 选择POST请求方法，并输入请求URI。 POST https://live.cn-north-4.myhuaweicloud.com/v1/{project_id}/template/transcodings “live.cn-north-4.myhuaweicloud.com”为直播服务的终端节点，您可以在区域和终端节点中获取。 调用IAM接口的区域需与调用直播接口的区域一致，如调用“cn-north-4”区域的IAM接口获取用户Token，则该Token仅能用于调用“cn-north-4”区域直播接口的鉴权。 在请求消息头中增加“X-Auth-Token”，值设置为1中获取的用户Token。 在请求消息体中传入如下所示的参数，具体参数说明可参考创建直播转码模板接口。 { "domain": "play.example.com", "app_name": "live", "quality_info": [ { "templateName": "", "quality": "lsd", "hdlb": "off", "PVC": "off", "codec": "H264", "width": 854, "height": 480, "bitrate": 600, "video_frame_rate": 0, "protocol": "HLS", "iFrameInterval": 0 } ]} 请求响应成功后，无返回参数，状态码为201 Created。 若请求失败，返回如下所示的错误码及错误描述，状态码为400 Bad Request。 "error_code": "LIVE.100011001","error_msg": "模板配置校验失败"

修订记录 表1 修订记录 发布日期 修改说明 2023-05-12 第四十八次发布： 本次变更如下： 增加错误码LIVE.100011022。 2023-05-06 第四十七次发布： 本次变更如下： 修改查询播放流量汇总接口描述，增加查询数据会延迟10分钟左右的描述。 2023-04-23 第四十六次发布： 本次变更如下： 修改查询转码用量接口描述，增加转码数据延时1小时的描述。 2023-04-18 第四十五次发布： 本次变更如下： 调整查询直播各区域指标分布接口的用户和API流量限制，用户流量限制由1次/秒变更为50次/秒，API流量限制由5次/秒变更为150次/秒。 2023-03-21 第四十四次发布： 本次变更如下： 新增鉴权、截图、HTTPS证书和OBS桶管理接口组。 修改创建录制规则和修改录制规则接口的“default_record_config”、“hls_config”和 “record_cycle” 字段的默认值。 2023-02-09 第四十三次发布： 本次变更如下： 修改创建录制规则和修改录制规则接口的“record_prefix”、“record_ts_prefix”参数的描述。 2023-01-18 第四十二次发布： 本次变更如下： 创建直播转码模板、创建录制规则接口新增计费说明。 “使用前必读”章节新增域名管理接口流控限制。 2023-01-06 第四十一次发布： 本次变更如下： 新增查询CDN上行推流质量数据接口。 修改查询播放带宽趋势、查询播放流量趋势、查询播放带宽峰值和查询播放流量汇总接口的“play_domains”参数为非必填。 查询播放带宽趋势、查询播放流量趋势、查询播放带宽峰值、查询播放流量汇总和查询流维度的观众趋势接口新增“service_type”参数。 查询上行带宽数据接口新增“type”参数。 2022-12-29 第四十次正式发布： 本次变更如下： 修改地区/国家代码对照表。 2022-12-27 第三十九次正式发布 本次变更如下： 新增查询直播各区域指标分布接口。 删除上行带宽数据接口“type”参数。 创建录制回调配置、修改录制回调配置接口增加成功状态的响应参数、请求参数key。 修改配置域名IPV6开关接口的请求示例。 修改地区/国家代码对照表。 2022-12-20 第三十八次正式发布 本次变更如下： 查询上行带宽数据接口新增“type”参数。 2022-12-07 第三十七次正式发布 本次变更如下： v1接口增加AK/SK鉴权头域。 下线查询直播各区域指标分布接口。 2022-11-08 第三十六次正式发布 本次变更如下： 删除查询播放带宽趋势接口中的“service_type”参数。 2022-09-29 第三十五次正式发布 本次变更如下： 删除录制回调管理接口中的“call_back_ssl_ca”和“call_back_ssl_verify”参数。 2022-09-27 第三十四次正式发布 本次变更如下： 修改查询录制规则配置接口的示例代码，删除“start_time”、“project_id”和“end_time”参数。 2022-09-08 第三十三次正式发布： 本次变更如下： 修改地区/国家代码对照表。 2022-09-06 第三十二次正式发布： 本次变更如下： 录制管理接口组新增创建录制视频索引文件接口。 2022-08-26 第三十一次正式发布： 本次变更如下： 修改查询直播各区域指标分布接口的“area”字段描述和返回体中的“name”字段描述。 修改查询转码用量接口、查询录制用量接口和查询截图用量接口的最大查询周期为1年。 新增地区/国家代码对照表。 2022-07-05 第三十次正式发布： 本次变更如下： 查询播放带宽趋势接口新增“service_type”参数。 所有接口中的响应Header参数“X-request-id”修改为“X-Request-Id”。 修改查询直播域名接口的响应示例。 2022-07-01 第二十九次正式发布 本次变更如下： 修改查询播放画像接口的参考示例。 2022-03-25 第二十八次正式发布 本次变更如下： 修改直播转码模板删除成功的状态码为200。 2022-03-01 第二十七次正式发布 本次变更如下： 调整查询直播中的流信息接口的用户和API流量限制，用户流量限制由4000次/分钟变更为1000次/分钟，API流量限制由8000次/分钟变更为2000次/分钟。 调整禁推恢复接口的用户和API流量限制，用户流量限制由4000次/分钟变更为3000次/分钟，API流量限制由8000次/分钟变更为6000次/分钟。 调整查询禁止直播推流列表接口的用户和API流量限制，用户流量限制由300次/分钟变更为3000次/分钟，API流量限制由3000次/分钟变更为6000次/分钟。 调整禁止直播推流和修改禁推属性接口的API流量限制，由8000次/分钟变更为12000次/分钟。 2022-02-28 第二十六次正式发布 本次变更如下： 删除查询直播转码任务数接口。 调整查询播放带宽趋势接口的用户流量限制，由300次/分钟变更为500次/分钟。 2022-02-22 第二十五次正式发布 本次变更如下： 流监控中增加查询流监控数据接口。 2022-01-26 第二十四次正式发布 本次变更如下： 修改录制管理接口组，删除“PLAN_RECORD”、“ON_DEMAND_RECORD”相关参数和说明。 修改录制回调管理接口组，删除“on_demand_callback_url”相关参数和说明。 数据统计分析中增加查询直播转码任务数接口和查询直播各区域指标分布接口。 2021-12-21 第二十三次正式发布 本次变更如下： 修改流管理接口组和转码模板管理接口组中“domain”参数的描述，变更为推流域名。 2021-12-16 第二十二次正式发布 本次变更如下： 修改创建录制规则接口的“default_record_config”参数为必填。 修改查询录制回调配置列表和查询录制规则列表接口的“offset”、“limit”参数的描述。 2021-11-26 第二十一次正式发布 本次变更如下： 查询录制用量接口，增加“publish_domain”参数。 查询推流帧率数据接口，增加返回的帧率数据列表粒度为1秒钟的描述。 查询推流码率数据接口，增加返回的码率数据列表粒度为1秒钟的描述。 查询历史推流列表接口，删除最大查询周期1个月的描述。 2021-10-27 第二十次正式发布 本次变更如下： 查询推流帧率数据和查询推流码率数据接口修改“data_list”参数描述，增加帧率和码率单位。 2021-09-26 第十九次正式发布 本次变更如下： 修改查询播放画像信息接口，增加约束描述，不统计协议为HLS的播放时长（play_duration）信息。 修改查询转码用量接口，增加“stream”参数。 2021-09-10 第十八次正式发布 本次变更如下： 录制管理中增加提交录制控制命令接口。 修改查询直播中的流信息接口，增加“video_frame_rate”、“audio_frame_rate”等参数。 2021-08-12 第十七次正式发布 本次变更如下： 查询播放带宽趋势接口和查询观众趋势接口增加“country”参数。 新增“国家名称缩写”章节内容。 2021-06-02 第十六次正式发布 本次变更如下： 创建录制规则接口修改“record_format”字段的格式，设置格式时必须使用大写字母。 2021-03-05 第十五次正式发布 本次变更如下： 上线录制管理接口组和录制回调管理接口组。 2021-01-28 第十四次正式发布 本次变更如下： 上线域名管理接口组和日志管理接口。 2021-01-19 第十三次正式发布 本次变更如下： 流管理中增加查询直播中的流信息接口。 2020-11-13 第十二次正式发布 本次变更如下： 数据统计分析中增加查询转码用量接口、查询录制用量接口和查询截图用量接口。 2020-09-17 第十一次正式发布 本次变更如下： 禁止直播推流接口修改“resume_time”字段的取值范围，默认值为7天，最大支持90天。 2020-08-25 第十次正式发布 本次变更如下： 数据统计分析中增加查询上行带宽数据接口、查询域名维度推流路数接口和查询历史推流列表接口。 2020-08-12 第九次正式发布 本次变更如下： 数据统计分析中增加查询直播拉流HTTP状态码接口。 2020-08-05 第八次正式发布 本次变更如下： 上线数据统计分析接口组和流监控接口组。 2020-07-30 第七次正式发布 本次变更如下： 增两个API应用示例，示例2：创建录制配置和示例3：禁止直播推流。 2020-05-20 第六次正式发布 本次变更如下： 所有接口增加“调试”内容，支持跳转到 API Explorer 进行接口调试。 2020-04-10 第五次正式发布 本次变更如下： 下线“查询直播推流列表”接口，后续将上线相关新接口。 2019-11-14 第四次正式发布 本次变更如下： 上线新版“查询直播推流列表”接口。 2019-07-27 第三次正式发布 本次变更如下： 修改转码模板管理接口，增加“iFrameInterval”、“GOP”等参数。 2019-06-27 第二次正式发布 本次变更如下： 增加应用示例章节，以具体接口为例，介绍如何调用直播API。 修改API参考文档，增加使用前必读和如何调用API章节。 2018-11-20 第一次正式商用发布。

操作步骤 登录视频直播控制台，获取需要配置录制规则的播放域名。 获取用户Token，用于调用直播接口时进行认证鉴权。 详细信息请参见构造请求。以“华北-北京四”为示例，若您需要调用其它区域的直播接口，请替换成对应区域的IAM终端节点。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "projectname" } } }} 如图1所示，红框中的信息为获取用户Token。 图1 获取用户Token 调用创建录制规则接口，配置录制规则参数。 选择POST请求方法并输入URI。 https://{endpoint}/v1/{project_id}/record/rules 请求消息头中增加“X-Auth-Token”，值设置为步骤2中获取的用户Token。 Request Body中传入参数如下： { "publish_domain" : "publish.xxx.com", "app" : "live", "stream" : "*", "record_type" : "CONTINUOUS_RECORD", "default_record_config" : { "record_format" : [ "HLS", "FLV" ], "hls_config" : { "record_cycle" : 3600, "record_prefix" : "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}", "record_ts_prefix" : "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}", "record_slice_duration" : 10, "record_max_duration_to_merge_file" : 0 }, "flv_config" : { "record_cycle" : 9000, "record_prefix" : "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}", "record_max_duration_to_merge_file" : 0 }, "obs_addr" : { "bucket" : "mybucket", "location" : "cn-north-4", "object" : "record/" } }} 请求响应成功后，无返回参数，返回状态码201。 开始直播推流，推流过程中会根据录制配置生成对应录制文件，并存储至OBS中。录制文件的获取方法请参见管理录制文件。

省份名称缩写 表1 省份名称缩写 省份 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX 山东 SD 福建 FJ 安徽 AH 四川 SC 西藏 XZ 陕西 SN 青海 QH 新疆 XJ 甘肃 GS 贵州 GZ 湖北 HB 湖南 HN 河南 HA 香港 HK 澳门 MO 台湾 TW 父主题： 附录

URI GET /v1/{project_id}/stream/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 直播播放域名 app_name 否 String 应用名称 stream_name 否 String 流名称 start_time 否 String 查询开始时间，UTC时间，格式：yyyy-mm-ddThh:mm:ssZ。 无开始时间表示查询最近统计周期在线人数数据 只能查询最近90天内的数据 end_time 否 String 查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 start_time与end_time均不存在时，服务端从最近一个统计周期的数据里查询。 start_time存在、end_time不存在时，end_time取当前时间。 start_time不存在、end_time存在时，请求非法。 只能查询最近90天内的数据，start_time和end_time的跨度不能大于30天。 step 否 Integer 统计周期。 单位：分钟, 最大为30天，且小于查询开始时间与结束时间的差值

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 查询结果的总元素数量 user_info Array of UserInfo objects 正在推流的音视频信息 表5 UserInfo 参数 参数类型 描述 user_num Integer 直播流的在线人数 timestamp String 操作执行的时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询直播播放在线人数成功 { "total" : 1, "user_info" : [ { "user_num" : 1024, "timestamp" : "2018-05-19T21:10:15Z" } ]} 状态码： 400 查询直播播放在线人数失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"}

请求参数 参数 类型 说明 是否必选 domain String 播放域名。 是 app_name String 应用名称。 是 record_duration Integer 周期录制时长，最小15分钟，最大6小时，默认1小时。单位：秒。 否 record_format String 录制格式flv，默认为flv。 否 record_location String 录制存储位置， 默认为vod。 否 record_prefix String 录制文件前缀， DomainName，AppName，StreamName必须，默认Record_{DomainName}/{AppName}/{StreamName}/{StartTime}-{EndTime} 否 create_time String 创建时间。 否 start_time String 开始时间。 否 end_time String 结束时间。 否 stream_name String 流名称。 否 push_domain String 推流域名。 否

请求示例 POST /v1/{project_id}/record/config { "domain": "push.hwcloud.cn", "app_name": "live", "record_duration": 900, "record_format": "flv", "record_location": "vod", "record_prefix": "{DomainName}/{AppName}/{StreamName}/{StartTime}-{EndTime}"}

请求示例 PUT https://{endpoint}/v1/{project_id}/template/transcodings{ "domain" : "play.example.huawei.com", "app_name" : "live", "quality_info" : [ { "quality" : "SD", "PVC" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "protocol" : "HLS" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必填，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填，携带项目ID信息。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名 app_name 是 String 应用名称 trans_type 否 String 转码流触发模式。 play：拉流触发转码。 publish：推流触发转码。 默认为play quality_info 是 Array of QualityInfo objects 视频质量信息 表4 QualityInfo 参数 是否必选 参数类型 描述 quality 是 String 包含如下取值： lud： 超高清，系统缺省名称； lhd： 高清，系统缺省名称； lsd： 标清，系统缺省名称； lld： 流畅，系统缺省名称； userdefine： 视频质量自定义。填写userdefine时，templateName字段不能为空。 templateName 否 String 自定义模板名称。 仅在quality参数为userdefine时必填；quality参数不为userdefine时，templateName字段无效； 多个自定义模板名称之间不能重复； 自定义模板名称不能与其他模板的quality参数重复。 PVC 否 String 是否使用窄带高清转码，模板组里不同模板的PVC选项必须相同。 on：启用。 off：不启用。 默认为off hdlb 否 String 是否启用高清低码，较PVC相比画质增强。 on：启用。 off：不启用。 默认为off。 codec 否 String 视频编码格式，模板组里不同模板的编码格式必须相同。 H264：使用H.264。 H265：使用H.265。 默认为H264。 width 否 Integer 视频宽度（单位：像素） H264 取值范围：32-3840，必须为2的倍数 。 H265 取值范围：320-3840 ，必须为4的倍数。 height 否 Integer 视频高度（单位：像素） H264 取值范围：32-2160，必须为2的倍数。 H265 取值范围：240-2160，必须为4的倍数。 bitrate 是 Integer 转码视频的码率（单位：Kbps）。 取值范围：40-30000。 video_frame_rate 否 Integer 转码视频帧率（单位：fps）。 取值范围：0-60，0表示保持帧率不变。 protocol 否 String 转码输出支持的协议类型。当前只支持RTMP和HLS，且模板组里不同模板的输出协议类型必须相同。 RTMP HLS DASH 默认为RTMP。 iFrameInterval 否 Integer I帧间隔（单位：帧）。 取值范围：0-500。 默认为25。 gop 否 Integer 按时间设置I帧间隔，与“iFrameInterval”选择一个设置即可。 取值范围：[0,10] 默认值：4