华为云用户手册

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表4 响应Body参数 参数 参数类型 描述 job_id String 任务编号 stream_name String 流名 app_id String 应用id room_id String 房间id user_id String 选看的用户id，单个录制任务内保证唯一 is_record_audio Boolean 是否录制音频。 true：录制音频 false：不录制音频 缺省为true。 video_type String 标识视频流的类型，可选摄像头流或者屏幕分享流，未填写表示不录制视频。 CAMERASTREAM：摄像头视频流 SCREENSTREAM：屏幕分享视频流 默认为CAMERASTREAM。 select_stream_type String 指定窗口拉取的分辨率档位。 LD SD HD FHD 缺省为FHD。 max_idle_time Integer 最长空闲频道时间。 取值范围：[5，43200]，默认值为30。 单位：秒。 如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。 连麦方指：joiner或者publisher的用户。 record_param RecordParam object 录制参数 create_time String 创建时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC state String 任务状态。 INIT：任务正在初始化 RUNNING：任务正在运行 STOPPED：任务已停止 stop_reason String 任务结束原因 TENANT_STOP EXCEED_MAX_IDLE_TIME INTERNAL_ERROR description String 针对任务状态的详细信息描述 start_time String 任务开始时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC stop_time String 任务完成时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表5 RecordParam 参数 参数类型 描述 record_rule_id String 录制规则id。 状态码： 404 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 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"}

响应参数 状态码： 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信息。

响应示例 状态码： 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"}

请求参数 表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参数 参数 参数类型 描述 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 表5 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定义。如果为空则保存到根目录 表6 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天）。 表7 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 表8 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表12 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

地区名称缩写 表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 父主题： 附录

请求参数 表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_id String 应用id auto_record_mode AppAutoRecordMode object 自动录制配置 表5 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 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 app详细信息 { "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 app编号不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"} 状态码： 500 查询失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError"}

单流任务管理接口 表6 单流任务管理接口 接口 说明 POST /v2/apps/{app_id}/individual-stream-jobs 启动单流任务 GET /v2/apps/{app_id}/individual-stream-jobs/{job_id} 查询单流任务状态 DELETE /v2/apps/{app_id}/individual-stream-jobs/{job_id} 停止单流任务 PUT /v2/apps/{app_id}/individual-stream-jobs/{job_id} 更新单流任务

数据统计分析接口 表9 数据统计分析接口 接口 说明 GET /v1/{project_id}/rtc/rooms 查询房间列表 GET /v1/{project_id}/rtc/users 查询用户列表 GET /v1/{project_id}/rtc/realtime/scale 查询实时规模 GET /v1/{project_id}/rtc/realtime/scale/dimension 查询实时规模分布 GET /v1/{project_id}/rtc/realtime/quality 查询实时质量数据 GET /v1/{project_id}/rtc/realtime/network 查询实时网络 GET /v1/{project_id}/rtc/history/usage 查询用量 GET /v1/{project_id}/rtc/history/scale 查询历史规模 GET /v1/{project_id}/rtc/history/quality 查询历史质量 GET /v1/{project_id}/rtc/client/qos/details 查询用户通话指标 GET /v1/{project_id}/rtc/client/event 查询详情事件 GET /v1/{project_id}/rtc/client/abnormalevent 查询指定项目用户异常体验事件 GET /v1/rtc/data/abnormal-events 查询用户异常体验事件 GET /v1/rtc/data/abnormal-event/dimension 查询异常事件用户分布

合流任务管理接口 表5 合流任务管理接口 接口 说明 POST /v2/apps/{app_id}/mix-stream-jobs 启动合流任务 GET /v2/apps/{app_id}/mix-stream-jobs/{job_id} 查询合流任务 PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id} 修改合流任务 DELETE /v2/apps/{app_id}/mix-stream-jobs/{job_id} 停止合流任务

录制规则管理接口 表2 录制规则管理接口 接口 说明 POST /v2/apps/{app_id}/record-rules 创建或更新录制规则 GET /v2/apps/{app_id}/record-rules 查询录制规则列表 GET /v2/apps/{app_id}/record-rules/{rule_id} 查询录制规则 PUT /v2/apps/{app_id}/record-rules/{rule_id} 更新录制规则 DELETE /v2/apps/{app_id}/record-rules/{rule_id} 删除录制规则

响应示例 状态码： 200 查询合流转码成功，查询结果详情 { "job_id" : "607824b4fa163e19fe301cc817dda855", "stream_name" : "m_607824b4fa163e19fe301cc817dda855_gigu", "app_id" : "123456789abcdefghijklmno", "room_id" : "gigu", "mix_param" : { "room_id" : "gigu", "encode_template" : "1920x1080_30_4620", "max_idle_time" : 0, "layout_template" : "nine_grids_view" }, "record_param" : { "record_rule_id" : "5f5e172b9016ed5b0961a43" }, "create_time" : "2021-04-16T16:22:44Z", "update_time" : "2021-04-16T16:22:44Z", "state" : "INIT", "start_time" : "2021-04-16T16:22:44Z", "stop_time" : "0001-01-01T00:00:00Z"} 状态码： 404 查询合流转码失败，任务编号不存在 { "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参数 参数 参数类型 描述 job_id String 任务编号，可以用于修改、查看和停止合流任务 stream_name String 流名 app_id String 应用id room_id String 房间id mix_param MixParam object 合流参数 record_param RecordParam object 录制参数 create_time String 任务创建的时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 任务中的布局更新的时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC state String 任务状态。 INIT：任务正在初始化 RUNNING：任务正在运行 STOPPED：任务已停止 stop_reason String 任务结束原因 TENANT_STOP EXCEED_MAX_IDLE_TIME INTERNAL_ERROR description String 状态描述，对state字段的一些补充说明，可用于人工查阅。 start_time String 任务开始时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC stop_time String 任务结束时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表5 MixParam 参数 参数类型 描述 room_id String 房间id encode_template String 输出编码模板名称 1920*1080_30_4620：输出流是1080p，帧率30，码率4.62Mbps 1920*1080_30_3150：输出流是1080p，帧率30，码率3.15Mbps 1920*1080_15_3460：输出流是1080p，帧率15，码率3.46Mbps 1920*1080_15_2080：输出流是1080p，帧率15，码率2.08Mbps 1280*720_30_3420：输出流是720p，帧率30，码率3.42Mbps 1280*720_30_1710：输出流是720p，帧率30，码率1.71Mbps 1280*720_15_2260：输出流是720p，帧率15，码率2.26Mbps 1280*720_15_1130：输出流是720p，帧率15，码率1.13Mbps 640*480_30_1500：输出流是480p，帧率30，码率1.50Mbps 640*480_15_500：输出流是480p，帧率15，码率500Kbps 640*480_30_1000 输出流是480p，帧率30，码率1000Kbps 480*360_30_490：输出流是360p，帧率30，码率490Kbps 480*360_15_320：输出流是360p，帧率15，码率320Kbps max_idle_time Integer 最长空闲频道时间。 取值范围：[5，43200]，默认值为30。 单位：秒。 如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。 连麦方指：joiner或者publisher的用户。 layout_template String 视频布局模板编号，不混视频的时候，不需要带。 nine_grids_view：九宫格模板（自适应模板） screen_share_left：主视图在左边的屏幕共享模板（自适应模板） screen_share_right：主视图在右边的屏幕共享模板（自适应模板） custom：自定义布局 default_user_background_image String 默认用户背景图地址，图片先上传obs，格式s3://bucket/object，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪，保证铺满。 screen_background_image String 共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。 background_image String 画布背景图地址，使用背景图功能需先上传图片到obs，填写此字段要求格式为s3://bucket/object，其中bucket和object指图片所在的桶和路径，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪，保证铺满。 layout_panes Array of MixLayoutPane objects 需要混流的视频列表。若不需要混流视频，则可不传递该参数。 nine_grids_view模板不需要填写本字段。 user_background_images Array of MixUserBackgroundImage objects 指定用户背景图，优先级大于default_user_background_image 表6 MixLayoutPane 参数 参数类型 描述 id Integer 窗口id，从1开始编号 user_id String 加入房间的用户id video_type String 标识视频流的类型，可选摄像头流或者屏幕分享流。 CAMERASTREAM：摄像头视频流 SCREENSTREAM：屏幕分享视频流 默认为CAMERASTREAM。 x Float 坐标x，归一化百分比，画布上该画面左上角的横坐标的相对值，范围是 [0.0,1.0]。从左到右布局，0.0在最左端，1.0在最右端，小数取值范围在float内，自定义布局场景下填写本字段。 y Float 坐标y，归一化百分比，画布上该画面左上角的纵坐标的相对值，范围是 [0.0,1.0]。从上到下布局，0.0在最上端，1.0在最下端，小数取值范围在float内，自定义布局场景下填写本字段。 width Float 窗格宽，归一化百分比，小数取值范围在float内，自定义布局场景下填写本字段。 height Float 窗格高，归一化百分比，小数取值范围在float内，自定义布局场景下填写本字段。 zorder Integer 叠放顺序，0为最底层，1层在0层之上，以此类推，最大支持25层，自定义布局场景下填写本字段。 crop_mode String 裁剪模式，自定义布局场景下填写本字段，支持两种模式： KEEP_RATIO_PADDING ：保持比例留边。 KEEP_RATIO_CROP ：保持比例裁剪。 filling_policy String 填充策略，仅限屏幕共享模板(包括screen_share_right、screen_share_left)场景下填写本字段，支持两种模式： FIXED_USER ：固定用户填充。 SHARED_SCREEN ：共享屏幕填充。 表7 MixUserBackgroundImage 参数 参数类型 描述 user_id String 需要设置背景图的用户ID image_uri String 需要设置背景图的地址，图片先上传obs，格式s3://bucket/object，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg 表8 RecordParam 参数 参数类型 描述 record_rule_id String 录制规则id。 状态码： 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 错误描述

响应示例 状态码： 200 app详细信息 { "app_id" : "123456789abcdefghijklmno", "record_callback" : { "url" : "http://mydomain.com", "auth_key" : "78912374ae8cdb38", "notify_event_subscription" : [ "RECORD_NEW_FILE_START", "RECORD_FILE_COMPLETE" ], "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"}

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表4 响应Body参数 参数 参数类型 描述 app_id String 应用id record_callback AppCallbackUrl object 回调信息 表5 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 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表11 响应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信息。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint，比如“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1234 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

响应参数 状态码： 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 错误描述

请求参数 表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信息。

状态码 调用 实时音视频 API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 网关超时。 父主题： 附录

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

响应示例 状态码： 400 操作失败 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"} 状态码： 401 请求失败，携带的X-Auth-Token错误 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"} 状态码： 500 查询失败，服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError"}