Help Center/ SparkRTC/ API Reference/ Before You Start
Updated on 2026-04-27 GMT+08:00
View PDF
Share

Before You Start

SparkRTC, built on Huawei's long-established video technologies and expertise, delivers a high-concurrency and high-definition (HD) experience in real time. It offers dependable security at low latency and is an ideal option for a broad array of real-time communication (RTC) scenarios, such as online education, cloud conferencing, social networking, and entertainment.

This document describes how to use APIs to perform operations such as managing applications and mixed stream recording jobs. For details about all supported operations, see API Overview.

Before calling SparkRTC APIs, ensure that you have fully understood related concepts. For details, see Service Overview.

SparkRTC provides Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.

Endpoints

An endpoint is the request address for calling an API. SparkRTC is a global service deployed for all physical regions. Table 1 lists SparkRTC endpoints.

Table 1 SparkRTC endpoints

Region

Detail

Endpoint

All

All

rtc-api.myhuaweicloud.com

Constraints

API request throttling is configured for SparkRTC to prevent service interruption caused by repeated API calls in a short period.

Table 2 API request throttling

API Category

API Name

Request Throttling

Application management
  • Creating an application
  • Querying applications
  • Querying an application
  • Deleting an application
  • Enabling an application
  • Disabling an application

60 times/minute

Recording template management
  • Creating or updating a recording template
  • Querying recording templates
  • Querying a recording template
  • Updating a recording template
  • Deleting a recording template

Automatic recording configuration
  • Updating the automatic recording configuration
  • Querying the automatic recording configuration

Application callback management
  • Configuring a recording event callback
  • Querying a recording event callback

Mixed stream recording job management
  • Starting a mixed stream recording job
  • Querying a mixed stream recording job
  • Modifying a mixed stream recording job
  • Stopping a mixed stream recording job

10 times/second

Single stream recording job management
  • Starting a single stream recording job
  • Querying a single stream recording job
  • Stopping a single stream recording job
  • Updating a single stream recording job

Room management
  • Removing an online user
  • Dismissing a room

60 times/minute

OBS bucket management
  • Querying OBS buckets
  • Querying objects in an OBS bucket
  • Granting or canceling authorization of accessing OBS buckets

Twice per second

Statistical analysis
  • Querying rooms
  • Querying users
  • Querying real-time scale data
  • Querying real-time scale data distribution
  • Querying real-time quality data
  • Querying real-time network data
  • Querying usage
  • Querying historical scale data
  • Querying historical quality data
  • Querying user call indicators
  • Querying event details
  • Querying abnormal user experience events of a specified project
  • Querying exceptions
  • Querying exception distribution

30 times/minute

Concepts

  • Account

    An account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. An account is a payment entity. Accounts should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.

  • IAM user

    An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).

    An IAM user can view the account ID and user ID on the My Credentials page of the console. The account, username, and password will be required for API authentication.

  • Region

    A region is a physical location where cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, but AZs in different regions cannot. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.

  • AZ

    An AZ contains one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Compute, networking, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ, high-availability systems.

  • Project

    Projects group and isolate resources (including compute, storage, and networking resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.

    Figure 1 Project isolating model