华为云用户手册

操作步骤 进入金山云KS3对象存储控制台界面，单击左侧导航树存储空间。 在存储空间列表中，单击目标存储空间名称，打开该存储空间内容管理页面。 找到您需要解冻的文件，单击文件名或操作列的“详情”。 在文件详情页，单击“解冻”按钮， 单击“确定”。 解冻操作预计1分钟。 解冻状态默认持续24小时，最多可延长7天，到期后文件自动恢复归档状态。 您还可以通过调用Restore Object接口解冻归档对象，更多详情，请参见金山云对象存储Restore Object接口相关文档。 解冻完成后，请参考金山云KS3迁移至华为云OBS教程，将数据迁移到华为云OBS。

修订记录 发布日期 修订记录 2024-05-07 第十五次正式发布。 新增阿里云OSS配置同步请求 新增腾讯云COS配置同步请求 2024-03-22 第十四次正式发布。 新增自动检查并重启失败的迁移任务 新增青云QingStor迁移至华为云OBS教程 新增谷歌云storage迁移至华为云OBS教程 新增亚马逊云S3迁移至华为云教程 新增微软云Blob迁移至华为云OBS教程 新增其他迁移场景 2022-11-10 第十三次正式发布。 更新各云服务商迁移教程。 2022-06-01 第十二次正式发布。 新增归档数据迁移方案章节。 2021-11-16 第十一次正式发布。 新增HTTP/HTTPS 数据源迁移至华为云OBS教程章节。 2021-10-27 第十次正式发布。 新增金山云KS3迁移至华为云OBS教程章节。 2021-10-25 第九次正式发布。 新增优刻得US3迁移至华为云OBS教程章节。 2021-10-20 第八次正式发布。 新增百度云BOS迁移至华为云OBS教程章节。 2021-07-28 第七次正式发布。 新增七牛云迁移至华为云OBS教程章节。 2021-06-26 第六次正式发布。 新增腾讯云COS迁移至华为云OBS教程章节。 2021-06-15 第五次正式发布。 新增阿里云OSS迁移至华为云OBS教程章节。 2021-05-21 第四次正式发布。 新增华为云OBS之间迁移教程章节。 2021-03-16 第三次正式发布。 更新使用“回源配置方案”迁移增量对象数据章节。 更新使用“源端/目的端双写方案”方案迁移增量对象数据章节。 更新使用"多次同步方案"迁移增量对象数据章节。 更新迁移归档存储数据章节。 2020-12-08 第二次正式发布。 新增使用“回源配置方案”迁移增量对象数据。 新增使用“源端/目的端双写方案”方案迁移增量对象数据。 新增使用"多次同步方案"迁移增量对象数据。 新增迁移归档存储数据。 2019-08-31 第一次正式发布。

操作场景 当源端对象存储有数据处于归档状态，直接使用 OMS 迁移，解冻时间长导致迁移时间较长，可参考以下方案。 如果不提前使用恢复归档存储，全量依靠OMS自动恢复功能，每个对象触发解冻后，会等待1-5分钟（具体时间由源端对象存储决定），最终导致迁移速度缓慢，影响您的整体迁移进度。 在OBS桶中仅开启归档数据直读功能，仅支持直接下载归档存储数据，并未修改相应存储类型，因此OMS无法正常直接下载对象。 归档存储开启直读，和使用OMS自动恢复归档存储，源端 对象存储服务 都会收取相应费用，详见产品价格详情。 迁移归档数据时，目的端桶类型建议选择为“标准存储”，待迁移完成确认数据无误后，再通过对象生命周期将对应数据的存储类型改为“归档存储”。

最佳实践汇总 本文汇总了基于 对象存储迁移 服务（Object Storage Migration Service，OMS）常见应用场景的操作实践，每个实践我们提供详细的方案描述和操作指导，用于指导您快速实现对象存储数据迁移。 表1 OMS最佳实践一览表 最佳实践 使用场景 优势 使用“回源配置方案”迁移增量对象数据 大批量数据迁移场景使用，优先选择此方案。此方案受OBS限制，具体的约束请见数据回源。 业务零中断，增量迁移间未同步的数据通过回源配置保证用户无感知。 可靠性高：割接前用户业务校验充分，增量迁移时全量扫描校验确保数据无遗漏。 使用“源端/目的端双写方案”方案迁移增量对象数据 适用大批量数据迁移且OBS回源不支持场景。由于需要客户同时对源端和目的端写数据，因此总体费用比“回源配置方案”高。 适用于双云备份场景： 业务零中断，业务切换时间根据客户业务确认，可随意调整。 一次迁移，操作简单。 使用"多次同步方案"迁移增量对象数据 少量数据快速增量迁移场景使用： 客户自动识别增量对象列表，然后使用OMS对象列表迁移； 记录迁移开始时间，设置迁移指定时间 速度快，业务短时间中断，操作简单。 增量迁移时长评估： 增量迁移时长=识别增量数据的时间（源端桶和目的端桶比对识别新增数据）+增量数据迁移时间。 迁移归档存储数据 源端存在归档存储数据，可使用此方案。 先解冻后迁移，相对直接使用OMS迁移：迁移速度较快。

版本发布记录 表1 Redis 6内核版本发布记录 版本 日期 特性描述 6.2.10 2023年11月 修复cluster因为publish消息至所有连接节点导致的内存增长后无法下降的问题。 2023年5月 支持写带宽控制。 2023年3月 修复带宽流控统计。 2023年3月 修复带宽module中的连接类型错误。 2022年10月 修复更新密文时的内存释放错误。 2022年5月 sentinel支持拓展功能。 2022年5月 支持过期键老化速度优化。 2022年5月 合入Redis社区6.2.10版本。 表2 Redis 5内核版本发布记录 版本 日期 特性描述 5.0.14 2023年11月 新增persistence-error-check配置项。 2023年10月 支持集群模式磁盘故障下倒换。 2023年4月 修改内核，定制化slowlog输出。 2023年3月 优化流控默认参数。 2023年1月 更改计数器流控为令牌桶。 2022年10月 添加 watch，wait，psubscribe到只读命令。 2022年10月 支持运行时动态重命名命令功能。 2022年4月 合入Redis社区5.0.14版本。 2021年10月 修复中文格式乱码问题。 2021年10月 过期key内核老化速度优化。 2021年9月 内核过期速度优化。 2021年8月 支持写带宽控制。 2021年8月 支持带宽控制和命令时延记录。 2021年4月 修复redis代码中announce模块存在数据溢出风险的问题。 2021年1月 修复新创建的redis实例无法写入AOF的问题。 2020年10月 修复用户的身份验证命令。 2020年10月 在通用模块API函数中支持流。 2020年5月 修复migrate日志、slowlog和monitor输出中可能出现明文密码的问题。 2020年4月 合入Redis社区5.0.9版本。 2020年3月 修复aof rewrite小概率存在无法结束的bug。 2020年3月 修复lua相关的内存泄漏。 2019年11月 合入Redis社区5.0.7版本。 表3 Redis 4内核版本发布记录 版本 日期 特性描述 4.0.14 2023年4月 支持动态重命名。 2023年3月 日志修改。 2022年10月 添加watch，wait，psubscribe到只读命令。 2022年7月 支持rename-command命令。 2021年12月 修复安全漏洞CVE-2020-14147。 2021年10月 过期key内核老化速度优化。 2021年9月 内核过期速度优化。 2021年8月 支持写带宽控制。 2021年4月 优化重构monitor代码，去除数据面冗余文件。 2020年8月 删除Lua中的随机值函数。 2020年4月 修复使用redis crash时日志打印不适用bio线程的问题。 2020年3月 解决EulerOS中glibc版本过老问题。 2020年1月 增加maxrss配置项，删除maxkeys配置项。 2020年1月 支持maxkeys配置，keys个数据超过maxkeys时，强制淘汰。 2019年7月 修复安全漏洞CVE-2019-10193。 2019年7月 修复安全漏洞CVE-2019-10192。 2019年3月 合入Redis社区4.0.14版本。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 app_id String 应用id record_callback AppCallbackUrl object 回调信息 表6 AppCallbackUrl 参数 参数类型 描述 url String 回调通知url地址，url必须以http://或https://开头，需要支持POST调用。 auth_key String 回调秘钥，主要用于鉴权。如果不设置或者为空，则回调不会增加鉴权头域字段。 notify_event_subscription Array of strings 订阅云端录制通知消息。 取值如下： RECORD_NEW_FILE_START：开始创建新的录制文件。 RECORD_FILE_COMPLETE：录制文件生成完成。 update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 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参数 参数 是否必选 参数类型 描述 url 是 String 回调通知url地址，url必须以http://或https://开头，需要支持POST调用。 auth_key 否 String 回调秘钥，主要用于鉴权

请求示例 配置指定应用id的增值（录制）事件上报回调，回调通知的地址：http://mydomain.com/callback，回调秘钥：8923ab*******************cef453 PUT https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-callback { "url" : "http://mydomain.com/callback", "auth_key" : "8923ab*******************cef453" }

响应示例 状态码： 200 配置成功 { "app_id" : "123456789abcdefghijklmno", "record_callback" : { "url" : "http://mydomain.com", "auth_key" : "78912374ae8cdb38", "notify_event_subscription" : [ "RECORD_NEW_FILE_START", "RECORD_FILE_COMPLETE", "RTC_USER_ROLE_CHANGED", "RTC_AUDIO_STREAM_OPEN", "RTC_AUDIO_STREAM_CLOSE", "RTC_VIDEO_STREAM_OPEN", "RTC_VIDEO_STREAM_CLOSE" ], "update_time" : "2020-07-26T07:53:05.075Z" } } 状态码： 400 配置失败，语义有误，当前请求无法被服务器理解，或参数有误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 404 配置失败，应用不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 500 配置失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }

操作步骤 获取用户Token，用于调用SparkRTC接口时进行认证鉴权。 在“我的凭证”页面获取username、password、domainname，调用如下接口 获取Token 。详细信息请参见构造请求。 POST https://iam.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名。 "password": "password", //用户登录密码。 "domain": { "name": "domainname" //用户所属的账号名。 } } } }, "scope": { "domain": { "name": "domainname" //用户所属的账号名。 } } } } 如图1所示，红框中的信息为获取用户Token。 图1 获取用户Token 调用创建应用接口创建SparkRTC应用。 选择POST请求方法并输入URI。 https://rtc-api.myhuaweicloud.com/v2/apps 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 Request Body中传入如下参数： { "app_name" : "rtctest" } 请求响应成功后，返回已创建应用的ID。 { "app_id": "5ff9701f2346968bb306cb43", } 调用创建或更新录制规则接口，创建录制规则。 选择POST请求方法并输入URI。 https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-rules 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 Request Body中传入如下参数： { "obs_addr": { "bucket": "obsName", "location": "cn-north-4", "object": "Record/", "project_id": "01234567890123456789012345678901" }, "record_formats": ["MP4"], "mp4_config": {} } 请求响应成功后，返回已创建的录制规则。 { "app_id": "5ff9701f2346968bb306cb43", "rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab", "create_time": "2021-04-21T10:29:33Z", "hls_config": { "record_cycle": 0, "record_max_duration_to_merge_file": 0 }, "mp4_config": { "record_cycle": 7200, "record_max_duration_to_merge_file": 0, "record_prefix": "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time}" }, "obs_addr": { "bucket": "obsName", "location": "cn-north-4", "object": "Record/", "project_id": "01234567890123456789012345678901" }, "record_formats": [ "MP4" ], "update_time": "2021-04-21T10:29:33Z" } 调用RTC增值（录制）事件回调配置接口，配置录制回调。 选择PUT请求方法并输入URI。 https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-callback 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 Request Body中传入如下参数： { "url": "http://mydomain.com/callback", "auth_key": "8923ab8c2dcef4538923ab8c2dcef453" } 请求响应成功后，返回已创建的回调信息。 { "app_id": "5ff9701f2346968bb306cb43", "record_callback": { "auth_key": "8923ab8c2dcef4538923ab8c2dcef453", "update_time": "2021-04-07T12:05:18.0718Z", "url": "http://mydomain.com/callback", "notify_event_subscription": [ "RECORD_NEW_FILE_START", "RECORD_FILE_COMPLETE", "CLOUD_RECORD_OVER" ] } } 终端用户通过SparkRTC APP加入某个SparkRTC房间，SparkRTC APP的集成开发请参见客户端SDK。 调用启动合流任务接口，创建录制任务。 选择POST请求方法并输入URI。 https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/mix-stream-jobs 请求消息头中增加“X-Auth-Token”，值设置为步骤1中获取的用户Token。 Request Body中传入如下参数： { "mix_param": { "room_id": "room001", "encode_template": "1920x1080_30_4620", "max_idle_time": 30, "layout_template": "nine_grids_view" //若视频布局为屏幕共享，则填写为screen_share_left或screen_share_right。 }, "record_param": { "record_rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab" } } layout_template：视频布局模板编号。 nine_grids_view：九宫格模板（自适应模板）。 每个用户画面平铺在画布上，大小一致。根据用户数量，动态调整每个画面的大小和位置，最多支持25个画面。不同人数的实际布局效果如下图所示： 如果实际视频流的宽高比与视窗的宽高比不一致，则视频画面会裁剪以适配视窗的大小。 如果中途有流退出房间，则该条流的画面会被后进入房间的流顶替。 如果房间内的人数不足，则剩余位置显示背景色。 如果用户只发送音频，仍然会占用画面位置。 支持背景图，如果房间内人数不足，则显示背景图。 screen_share_left、screen_share_right：主视图在左边、右边的屏幕共享模板（自适应模板）。 屏幕分享（或者主讲人摄像头画面）始终占据屏幕左侧或者右侧大画面位置，其他用户依次垂直排列于旁边，最多支持17个画面。不同人数的实际布局效果如下图所示： 大视窗画面，可选择主讲摄像头流或共享屏幕流。 大视窗画面，显示指定的UID用户的视频，如果未指定或者指定用户未进入频道，则大视窗区域显示背景色。 左侧大视窗为了保持内容的完整性采用缩放方式处理，右侧小视窗采用裁剪方式适配视窗的大小。 右侧小视窗画面按照加入房间的时间先后顺序排列。 右侧小视窗有流退出房间，则该条流的画面会被后进入房间的流顶替。 如果房间内的人数不足，则剩余位置显示背景色。 如果用户只发送音频，仍然会占用画面位置。 支持背景图，如果房间内人数不足，则显示背景图。 请求响应成功后，返回合流录制任务信息。 { "app_id": "5ff9701f2346968bb306cb43", "create_time": "2021-04-21T11:47:32Z", "job_id": "607f9fc100d861eeefff9b300b388dab", "job_unique_id": "87b1f2b8da9c44cd", "mix_param": { "room_id": "room001", "layout_template": "nine_grids_view", "encode_template": "1920x1080_30_4620", "max_idle_time": 30 }, "push_param": { "rtmp_urls": null }, "record_param": { "record_rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab" }, "room_id": "room001", "start_time": "2021-04-21T11:47:32Z", "state": "INIT", "stop_time": "0001-01-01T00:00:00Z", "stream_name": "m_607f9fc100d861eeefff9b300b388dab_room001", "update_time": "2021-04-21T11:47:32Z" } SparkRTC房间结束音视频互动后，您可以在配置的OBS桶中获取录制文件。

请求示例 创建或更新一个录制规则，区域为北京四，录制文件将被保存在名为obsName的桶上，录制文件格式为MP4，录制周期为60秒 POST https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-rules { "obs_addr" : { "bucket" : "obsName", "location" : "cn-north-4", "object" : "Record/", "project_id" : "ad7456ce8ef89adf567" }, "record_formats" : [ "MP4" ], "mp4_config" : { "record_cycle" : 60, "record_max_duration_to_merge_file" : 0 } }

响应示例 状态码： 201 创建配置成功 { "app_id" : "123456abc", "rule_id" : "456789abc", "create_time" : "2006-01-02T15:04:05.075Z", "obs_addr" : { "bucket" : "obsName", "location" : "cn-north-4", "object" : "Record/", "project_id" : "ad7456ce8ef89adf567" }, "record_formats" : [ "MP4" ], "mp4_config" : { "record_cycle" : 60, "record_max_duration_to_merge_file" : 0 }, "update_time" : "2006-01-02T15:04:05.075Z" } 状态码： 200 更新配置成功 { "app_id" : "123456abc", "rule_id" : "456789abc", "create_time" : "2006-01-02T15:04:05.075Z", "obs_addr" : { "bucket" : "obsName", "location" : "cn-north-4", "object" : "Record/", "project_id" : "ad7456ce8ef89adf567" }, "record_formats" : [ "MP4" ], "mp4_config" : { "record_cycle" : 60, "record_max_duration_to_merge_file" : 0 }, "update_time" : "2006-01-02T15:04:05.075Z" } 状态码： 400 配置失败，语义有误，当前请求无法被服务器理解，或参数有误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 404 配置失败，应用不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 500 配置失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }

响应参数 状态码： 201 表7 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表8 响应Body参数 参数 参数类型 描述 rule_id String 规则id，由服务端返回。创建或修改规则的时候不携带 app_id String 应用id obs_addr RecordObsFileAddr object 保存录制文件所在的桶信息 record_formats Array of strings 录制格式：HLS格式或者MP4格式 hls_config HLSRecordConfig object hls格式录制规则管理 mp4_config MP4RecordConfig object mp4格式录制规则管理 create_time String 创建时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表9 RecordObsFileAddr 参数 参数类型 描述 location String OBS Bucket所在RegionID cn-north-4 project_id String OBS Bucket所在Region的项目ID bucket String OBS的bucket名称 object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表10 HLSRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，43200]或者0，如果为0则整个流录制为一个文件。 单位：秒。 record_prefix String 录制m3u8文件含路径和文件名的前缀 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_slice_duration Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2，60]，缺省为10。 单位：秒。 record_max_duration_to_merge_file Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[-1，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 如果为-1则表示流中断恢复后追加到原来的文件中（相隔不超过30天）。 表11 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，10800]。 单位：秒。 record_prefix String 录制文件含路径和文件名的前缀。 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_max_duration_to_merge_file Integer 录制MP4拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[0，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 状态码： 200 表12 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 rule_id String 规则id，由服务端返回。创建或修改规则的时候不携带 app_id String 应用id obs_addr RecordObsFileAddr object 保存录制文件所在的桶信息 record_formats Array of strings 录制格式：HLS格式或者MP4格式 hls_config HLSRecordConfig object hls格式录制规则管理 mp4_config MP4RecordConfig object mp4格式录制规则管理 create_time String 创建时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表14 RecordObsFileAddr 参数 参数类型 描述 location String OBS Bucket所在RegionID cn-north-4 project_id String OBS Bucket所在Region的项目ID bucket String OBS的bucket名称 object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表15 HLSRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，43200]或者0，如果为0则整个流录制为一个文件。 单位：秒。 record_prefix String 录制m3u8文件含路径和文件名的前缀 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_slice_duration Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2，60]，缺省为10。 单位：秒。 record_max_duration_to_merge_file Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[-1，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 如果为-1则表示流中断恢复后追加到原来的文件中（相隔不超过30天）。 表16 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长。 取值范围：[60，10800]。 单位：秒。 record_prefix String 录制文件含路径和文件名的前缀。 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_max_duration_to_merge_file Integer 录制MP4拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[0，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 状态码： 400 表17 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表19 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表20 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表21 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表22 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 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参数 参数 是否必选 参数类型 描述 obs_addr 是 RecordObsFileAddr object 保存录制文件所在的桶信息 record_formats 是 Array of strings 录制格式：支持HLS格式和MP4格式（HLS和MP4为大写）。 若配置HLS则必须携带HLSRecordConfig参数 若配置MP4则需要携带MP4RecordConfig hls_config 否 HLSRecordConfig object HLS格式录制规则管理 mp4_config 否 MP4RecordConfig object MP4格式录制规则管理 表4 RecordObsFileAddr 参数 是否必选 参数类型 描述 location 是 String OBS Bucket所在RegionID cn-north-4 project_id 是 String OBS Bucket所在Region的项目ID bucket 是 String OBS的bucket名称 object 否 String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表5 HLSRecordConfig 参数 是否必选 参数类型 描述 record_cycle 是 Integer 周期录制时长。 取值范围：[60，43200]或者0，如果为0则整个流录制为一个文件。 单位：秒。 record_prefix 否 String 录制m3u8文件含路径和文件名的前缀 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_slice_duration 否 Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2，60]，缺省为10。 单位：秒。 record_max_duration_to_merge_file 否 Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[-1，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。 如果为-1则表示流中断恢复后追加到原来的文件中（相隔不超过30天）。 表6 MP4RecordConfig 参数 是否必选 参数类型 描述 record_cycle 是 Integer 周期录制时长。 取值范围：[60，10800]。 单位：秒。 record_prefix 否 String 录制文件含路径和文件名的前缀。 默认{app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 可自定义以下特殊变量： {app_id}：应用id {record_format}：录制格式 {stream}：流名 {file_start_time}：文件生成时间 record_max_duration_to_merge_file 否 Integer 录制MP4拼接时长，如果流中断超过该时间，则生成新文件。 取值范围：[0，300]，缺省为0。 单位：秒。 如果为0表示流中断就生成新文件。

请求参数 表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信息，与路径参数中的项目ID相同。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 usage Array of RtcHistoryUsage objects 时间戳及相应时间的指标数值列表 表6 RtcHistoryUsage 参数 参数类型 描述 date String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DD video_sd Long 标清视频时长，单位秒 video_hd Long 高清视频时长，单位秒 video_hdp Long 超高清视频时长，单位秒 audio Long 音频时长，单位秒 total_duration Long 音视频总时长，单位秒 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 查询成功返回。 { "usage" : [ { "date" : "2020-06-04", "video_sd" : 1, "video_hd" : 1, "video_hdp" : 1, "audio" : 1, "total_duration" : 4 } ] } 状态码： 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }

URI GET /v1/{project_id}/rtc/history/usage 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 metric 是 String 查询的数据类型 CommunicationDuration：音视频通话时长 start_date 是 String 查询起始时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23，不写默认读取过去1天数据数据。 end_date 是 String 查询结束时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23。

响应示例 状态码： 200 app详细信息 { "app_name" : "example", "app_id" : "123456789abcdefghijklmno", "state" : { "state" : "ACTIVATION", "update_time" : "2020-07-26T07:03:05.075Z" }, "scope" : "DOMESTIC", "tenant_name" : "hwstaff_pub_videortc", "domain" : "123456789abcdefghijklmno.rtc.huawei.com", "create_time" : "2020-07-26T07:03:05.075Z", "authentication" : { "enable" : true, "expire" : 300, "app_key" : "12345ABCDEF12345", "update_time" : "2020-07-26T07:03:05.075Z" }, "callbacks" : { "record_callback" : { "url" : "http://mydomain.com", "auth_key" : "78912374ae8cdb38", "update_time" : "2020-07-26T07:53:05.075Z" } }, "auto_record_mode" : { "mode" : "AUTO_RECORD_OFF", "update_time" : "2020-07-26T07:53:05.075Z" } } 状态码： 400 语义有误，当前请求无法被服务器理解，或参数有误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 404 app编号不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 500 查询失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 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 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表4 响应Body参数 参数 参数类型 描述 app_name String app名称 app_id String 应用id state AppState object app状态 scope String RTC覆盖范围。 取值如下： DOMESTIC：国内范围。 OVERSEA：海外范围。 GLOBAL：全球范围。 tenant_name String 账号名 domain String 域名 ，App对应域名 create_time String 创建时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC authentication AppAuth object 鉴权配置 callbacks AppCallbacks object 回调配置 auto_record_mode AppAutoRecordMode object 自动录制配置 表5 AppState 参数 参数类型 描述 state String 状态 ACTIVATION：开启 DEACTIVATION：停用 ARREARS：欠费 DELETED：已删除 update_time String app鉴权的更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表6 AppAuth 参数 参数类型 描述 enable Boolean 开启或关闭URL鉴权 expire Integer 接入RTC建链认证时的signature的有效期。单位：秒。默认300秒。signature由app_key生成 app_key String app鉴权秘钥 update_time String app鉴权的更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表7 AppCallbacks 参数 参数类型 描述 push_callback AppCallbackUrl object 转推回调 record_callback AppCallbackUrl object 录制回调 表8 AppCallbackUrl 参数 参数类型 描述 url String 回调通知url地址，url必须以http://或https://开头，需要支持POST调用。 auth_key String 回调秘钥，主要用于鉴权。如果不设置或者为空，则回调不会增加鉴权头域字段。 notify_event_subscription Array of strings 订阅云端录制通知消息。 取值如下： RECORD_NEW_FILE_START：开始创建新的录制文件。 RECORD_FILE_COMPLETE：录制文件生成完成。 update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 表9 AppAutoRecordMode 参数 参数类型 描述 mode String 录制模式。 AUTO_RECORD_OFF：关闭自动录制。 AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 record_rule_id String 录制规则id。 update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 状态码： 400 表10 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表12 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表14 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 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参数 参数 是否必选 参数类型 描述 mode 是 String 录制模式。 AUTO_RECORD_OFF：关闭自动录制。 AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 record_rule_id 否 String 录制规则id。

响应示例 状态码： 200 任务创建成功，返回app的概要信息，如包含app_id { "app_id" : "123456789abcdefghijklmno", "auto_record_mode" : { "mode" : "AUTO_RECORD_OFF", "update_time" : "2020-07-26T07:53:05.075Z" } } 状态码： 400 更新自动录制任务失败，语义有误，当前请求无法被服务器理解，或参数有误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 404 更新自动录制任务失败，应用不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } 状态码： 500 更新自动录制任务失败，服务器错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" }

接口约束 开启自动单流录制功能之后，只针对新创建的房间有效，对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则： {appid}_{roomid}_{userid}_{media_type}_{video_type} {media_type}可取值为v（代表纯视频录制），av（代表音视频录制）。 {video_type}可取值为m（代表录主流摄像头视频），a（代表录辅流视频）。 可能的组合有_av_m（自动录制主流和音频）和_v_a（自动录制辅流视频，无音频）。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 app_id String 应用id auto_record_mode AppAutoRecordMode object 自动录制配置 表6 AppAutoRecordMode 参数 参数类型 描述 mode String 录制模式。 AUTO_RECORD_OFF：关闭自动录制。 AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 record_rule_id String 录制规则id。 update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表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信息，与路径参数中的项目ID相同。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 quality Array of TimeDoubleValueData objects 时间戳及相应时间的指标数值列表 表6 TimeDoubleValueData 参数 参数类型 描述 time String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ value Double 当前时间返回参数取值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 查询成功返回。 { "quality" : [ { "time" : "2020-06-04T07:00:00Z", "value" : 0 } ] } 状态码： 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }

URI GET /v1/{project_id}/rtc/realtime/quality 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间ID metric 是 String 查询的数据类型： JoinSuccessRate：加入房间成功率 JoinSuccess5SecsRate：5秒加入成功率 VideoFreezeRate：视频卡顿率 AudioFreezeRate：音频卡顿率 sdk_type 是 String sdk类型 native：非web版sdk webrtc：web版sdk start_time 否 String 查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认读取过去1小时数据。 end_time 否 String 查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认为当前时间。

响应参数 状态码： 204 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 状态码： 404 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述