检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 图1 管理控制台
/v1/{project_id}/rtc/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用id room_id 否 String
/v1/{project_id}/rtc/rooms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String
背景音乐是否支持循环播放? 支持,调用startAudioFile接口,设置循环次数“cycle”为0,表示无限循环播放。 父主题: SDK使用
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。 图1 获取账号ID 父主题: 附录
查询历史规模 功能介绍 查询指标过去每天的规模数量,可查询最近31天的数据。当天未结束,无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表4 响应Body参数
domain 否 String 域名 app_id 是 String 应用id room_id 是 String 房间ID user_id 否 String 发送端用户 peer_id 否 String 需查询接收端用户id stream_id 否 String 流号 direction
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询结果起始编号,此处代表分页的页码 limit 否 Integer 查询结果集数量,此处代表每一页的条数 请求参数
参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 metric 是 String 查询的数据类型 CommunicationDuration:音视频通话时长
响应Body参数 参数 参数类型 描述 job_id String 任务编号,可以用于修改、查看和停止合流任务 stream_name String 流名 app_id String 应用id room_id String 房间id mix_param MixParam object 合流参数
查询历史质量 功能介绍 查询质量指标过去每天的体验数据,可查询最近31天的数据。当天未结束,无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
GET /v1/{project_id}/rtc/realtime/scale/dimension 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述
/v1/{project_id}/rtc/realtime/network 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识
描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 查询指定应用id和规则id的单个录制规则 GET https://rtc-api
com/v2/apps/{app_id}/individual-stream-jobs/{job_id} 响应示例 状态码: 200 查询成功,返回查询结果详情 { "job_id" : 1, "app_id" : 1, "room_id" : 100, "user_id" : "user001"
/v1/{project_id}/rtc/realtime/scale 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id
使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表4 响应Body参数
/v1/{project_id}/rtc/client/event 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id
使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表4 响应Body参数