Before You Start

Overview

With years of technological experience in video services, Huawei Cloud SparkRTC provides audio and video services featuring high concurrency, low latency, uninterrupted HD, security, and reliability. It is perfect for real-time and interactive scenarios, such as online education, cloud conferencing, and social 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.

API Calling

SparkRTC supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

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 Name	Region	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 describes the API request throttling.

**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 per 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 per 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	10 times per second
Room management	Removing an online user Dismissing a room	60 times per minute
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 exceptions Querying exception distribution	30 times per minute