更新时间:2024-11-07 GMT+08:00

使用前必须

华为云实时音视频服务(SparkRTC)凭借在视频业务领域长期技术积累,快速为行业提供高并发、低延迟、高清流畅、安全可靠的全场景、全互动、全实时的音视频服务,适用于在线教育、云会议、社交文娱等场景。

您可以使用本文档提供的API对华为云实时音视频服务进行相关操作,如应用管理、合流任务管理等。支持的全部操作请参见API概览

在调用华为云实时音视频服务的API之前,请确保已经充分了解华为云实时音视频服务的相关概念,详细信息请参见产品介绍

实时音视频提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API

终端节点

终端节点即调用API的请求地址,SparkRTC部署时不区分物理区域,为全局服务。因此,SparkRTC的终端节点如表1所示。

表1 SparkRTC的终端节点

区域名称

区域

终端节点(Endpoint)

所有

ALL

rtc-api.myhuaweicloud.com

约束与限制

华为云实时音视频服务设置了API流控,避免出现因短时间内重复调用API,服务中断的情况。

表2 API流控说明

接口分类

接口名称

接口流控

应用管理

  • 创建应用
  • 查询应用列表
  • 查询单个应用
  • 删除应用
  • 启用应用
  • 停用应用

60次/分钟

录制规则管理

  • 创建或更新录制规则
  • 查询录制规则列表
  • 查询录制规则
  • 更新录制规则
  • 删除录制规则

自动录制配置

  • 更新自动录制配置
  • 查询自动录制配置

应用回调管理

  • RTC增值(录制)事件回调配置
  • 查询增值(录制)事件回调配置

合流任务管理

  • 启动合流任务
  • 查询合流任务
  • 修改合流任务
  • 停止合流任务

10次/秒

单流任务管理

  • 启动单流任务
  • 查询单流任务状态
  • 停止单流任务
  • 更新单流任务

房间管理

  • 踢除在线用户
  • 解散房间

60次/分钟

OBS桶管理

  • 查询OBS桶列表
  • 查询OBS桶下对象列表
  • OBS桶授权及取消授权

2次/秒

数据统计分析

  • 查询房间列表
  • 查询用户列表
  • 查询实时规模
  • 查询实时规模分布
  • 查询实时质量数据
  • 查询实时网络
  • 查询用量
  • 查询历史规模
  • 查询历史质量
  • 查询用户通话指标
  • 查询详情事件
  • 查询指定项目用户异常体验事件
  • 查询用户异常体验事件
  • 查询异常事件用户分布

30次/分钟

基本概念

  • 账号

    用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用创建的用户进行日常管理工作。

  • 用户

    由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。

    在“我的凭证”下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。

  • 区域

    指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。

  • 可用区

    一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。

  • 项目

    区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。

    图1 项目隔离模型