华为云用户手册

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表4 响应Body参数 参数 参数类型 描述 dimensions Array of AbnormalEventDimensionValue objects 异常体验列表 表5 AbnormalEventDimensionValue 参数 参数类型 描述 abnormal_type Integer 异常类型： 1：进房慢(5s加入房间失败) 2：视频卡顿 3：音频卡顿 abnormal_type_desc String 异常类型描述与异常类型对应，支持国际化，取值范围为： 进房慢(5s加入房间失败) 视频卡顿 音频卡顿 abnormal_factor Integer 异常因素 当异常类型为1时，异常因素取值范围为： 1：建链失败 2：房间非空闲 3：服务器异常 4：服务器反馈503 5：鉴权失败 6：鉴权重试 7：时钟同步失败 8：url错误 9：终端内部异常 90000004：SDK发出的加入房间信令响应超时 90100009：web侧没有收到MSP下发的配置信息 90100008：websocket链路建链失败 10000001：服务侧返回的异常信息 31000003：服务侧返回的异常信息 32000030：服务侧返回的异常信息 15：浏览器设置sdp异常 当异常类型为2或者3时，异常因素取值范围为： 1：系统CPU占用高 2：App CPU占用高 3：音频上行网络延时 4：音频上行网络抖动 5：视频上行网络延时 6：视频上行网络抖动 7：音频下行网络延时 8：音频下行网络抖动 9：视频下行网络延时 10：视频下行网络抖动 11：上行音频丢包 12：上行视频丢包 13：下行音频丢包 14：下行视频丢包 15：下行音频无声音 16：其他 17：对端用户离线 18：对端用户无码流 19：对端用户无帧率 20：本端服务器下行无码流 21：本端服务器下行无帧率 abnormal_factor_desc String 异常因素描述，支持国际化 当异常类型为1时，异常因素描述与异常因素对应，取值范围为： 建链失败 房间非空闲 服务器异常 服务器反馈503 鉴权失败 鉴权重试 时钟同步失败 url错误 终端内部异常 SDK发出的加入房间信令响应超时 web侧没有收到MSP下发的配置信息 websocket链路建链失败 服务侧返回的异常信息 服务侧返回的异常信息 服务侧返回的异常信息 浏览器设置sdp异常 当异常类型为2或者3时，异常因素描述与异常因素对应，取值范围为： 系统CPU占用高 App CPU占用高 音频上行网络延时 音频上行网络抖动 视频上行网络延时 视频上行网络抖动 音频下行网络延时 音频下行网络抖动 视频下行网络延时 视频下行网络抖动 上行音频丢包 上行视频丢包 下行音频丢包 下行视频丢包 下行音频无声音 其他 对端用户离线 对端用户无码流 对端用户无帧率 本端服务器下行无码流 本端服务器下行无帧率 其他情况，异常因素描述为：其他 user_count Long 异常影响的用户数 状态码： 400 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/rtc/data/abnormal-event/dimension 表1 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用ID room_id 否 String 房间ID dimension 否 String 分组类型，支持同时指定两种类型 abnormal_type：异常类型 abnormal_factor：异常因素 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-23T07:00:00Z，不填写则默认为当前时间。

响应示例 状态码： 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"} 状态码： 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 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表示流中断就生成新文件。 状态码： 400 表12 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表14 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表16 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 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 }}

请求参数 表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 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表示流中断就生成新文件。

响应参数 状态码： 201 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表7 响应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 任务结束原因 description String 针对任务状态的详细信息描述 start_time String 任务开始时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC stop_time String 任务完成时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC 表8 RecordParam 参数 参数类型 描述 record_rule_id String 录制规则id。 状态码： 400 表9 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表11 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表13 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 POST https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/individual-stream-jobs{ "room_id" : 100, "user_id" : "user001", "is_record_audio" : true, "video_type" : "CAMERASTREAM", "select_stream_type" : "FHD", "max_idle_time" : 30, "record_param" : { "record_rule_id" : "5f5e172b9016ed5b0961a43" }}

响应示例 状态码： 201 任务创建成功，返回job的概要信息，如包含job_id { "job_id" : 1, "app_id" : 1, "room_id" : 100, "user_id" : "user001", "is_record_audio" : true, "video_type" : "CAMERASTREAM", "select_stream_type" : "FHD", "max_idle_time" : 30, "record_param" : { "record_rule_id" : "5f5e172b9016ed5b0961a43" }, "create_time" : "2006-01-02T15:04:05.075Z", "start_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信息。 表3 请求Body参数 参数 是否必选 参数类型 描述 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的用户。 publish_param 否 PublishParam object 转推参数 record_param 否 RecordParam object 录制参数 表4 PublishParam 参数 是否必选 参数类型 描述 rtmp_urls 是 Array of strings 合流任务完成后，转推的RTMP推流地址。 表5 RecordParam 参数 是否必选 参数类型 描述 record_rule_id 是 String 录制规则id。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 scale Array of RtcHistoryScaleTimeValue objects 时间戳及相应时间的指标数值列表 表6 RtcHistoryScaleTimeValue 参数 参数类型 描述 date String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DD user_count Long 通话人数，指总的uid个数 session_count Long 通话人次，指总的session个数 room_count Long 房间数 max_online_user_count Long 最大同时在线人数 max_online_room_count Long 最大同时在线房间数 communication_duration Long 音视频通话总时长，单位秒 video_communication_duration Long 视频通话总时长，单位秒 audio_communication_duration Long 音频通话总时长，单位秒 状态码： 400 表7 响应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 查询成功返回。 { "scale" : [ { "date" : "2020-06-04", "user_count" : 1, "session_count" : 1, "room_count" : 3, "max_online_user_count" : 5, "max_online_room_count" : 4, "communication_duration" : 123, "video_communication_duration" : 234, "audio_communication_duration" : 132 } ]} 状态码： 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present"}

URI GET /v1/{project_id}/rtc/history/scale 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 metric 是 Array 查询的数据类型 UserCount：通话人数，不同频道中的相同用户ID计为多人 SessionCount：通话人次，用户每次加入频道计为一个通话人次 RoomCount：房间数，从有用户加入房间到所有用户离开房间计为一个通话房间 MaxOnlineUserCount：最大同时在线人数 MaxOnlineRoomCount：最大同时在线房间数 CommunicationDuration：音视频通话总时长 VideoCommunicationDuration：视频通话总时长 AudioCommunicationDuration：音频通话总时长 start_date 否 String 查询起始时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23，不写默认读取过去1天数据。 end_date 否 String 查询结束时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23。

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

请求参数 表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 错误描述。

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

请求参数 表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 查询成功返回。 { "network" : [ { "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/network 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间ID metric 是 String 查询的数据类型： VideoUpstreamExcellentTransRate：客户端视频上行优质传输率 AudioUpstreamExcellentTransRate：客户端音频上行优质传输率 VideoExcellentTransRate：端到端视频优质传输率 AudioExcellentTransRate：端到端音频优质传输率 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，不写默认为当前时间。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 network 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 表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"}

请求参数 表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相同。

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，不写默认为当前时间。

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

响应示例 状态码： 200 查询成功返回。 { "scale" : [ { "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/scale 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间ID metric 是 String 查询的数据类型： OnlineUsers：在线用户数 RoomCount：在线房间数 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-23T07:00:00Z，不写默认为当前时间。

请求参数 表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相同。