Help Center> Live> API Reference> Before You Start
Updated on 2022-09-14 GMT+08:00

Before You Start

Overview

HUAWEI CLOUD Live helps you deliver live streaming content to a global audience with low latency.

This document describes how to use application programming interfaces (APIs) to perform operations on Live resources, such as transcoding, managing, and recording live video streams. For details about all supported operations, see API Overview.

If you plan to access Live through an API, ensure that you are familiar with Live concepts. For details, see Service Overview.

You can configure referer validation, URL validation, and access control lists (ACLs) on the Live console to control who can and cannot access your content. Only users who meet the configured rules can play videos. For details, see Access Control.

API Calling

Live 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. Endpoints vary depending on regions. For the endpoints of Live, see Table 1. You can also query the endpoints of services on Regions and Endpoints.

Table 1 Live endpoints

Region Name

Region

Endpoint

CN North-Beijing4

cn-north-4

live.cn-north-4.myhuaweicloud.com

AP-Singapore

ap-southeast-3

live.ap-southeast-3.myhuaweicloud.com

AP-Bangkok

ap-southeast-2

live.ap-southeast-2.myhuaweicloud.com

Constraints and Limitations

API request throttling is configured for Live 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

Max. User Requests

Max. API Requests

Transcoding template management

  • Creating a transcoding template
  • Deleting a transcoding template
  • Modifying a transcoding template
  • Querying transcoding templates

100 times/minute

1000 times/minute

Stream management

  • Disabling a push stream
  • Modifying the attribute of a disabled stream

4000 times/minute

12,000 times/minute

  • Resuming a push stream
  • Querying disabled streams

3000 times/minute

6000 times/minute

Querying ongoing streams

1000 times/minute

2000 times/minute

Log management

Obtaining livestreaming logs

300 times/minute

3000 times/minute

Recording management

  • Creating a recording template
  • Querying recording templates
  • Modifying a recording template
  • Deleting a recording template
  • Querying recording templates
  • Submitting a recording command

300 times/minute

3000 times/minute

Creating a video recording index

1200 times/minute

3000 times/minute

Recording callback management

  • Creating a recording callback
  • Querying recording callbacks
  • Modifying a recording callback
  • Querying recording callbacks
  • Deleting a recording callback

300 times/minute

300 times/minute

Statistical analysis

Querying the distribution of livestreaming metrics by region

5 times per second

15 times per second

Statistical analysis

  • Querying the duration of transcoded outputs
  • Querying the number of recording channels
  • Querying the number of snapshots
  • Querying playback profiles

60 times/minute

5000 times/minute

  • Querying the peak bandwidth
  • Querying the total playback traffic
  • Querying HTTP status codes
  • Querying upstream bandwidth
  • Querying the number of stream push channels
  • Querying historical streams

20 times/minute

5000 times/minute

Stream analytics

  • Querying the stream frame rate
  • Querying the stream bitrate

20 times/minute

5000 times/minute

Querying stream analytics

Once per second

5 times per second

Concepts

  • Account

    A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used 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 domain name, 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 communicate with each other. For low network latency and quick resource access, select the nearest region. The choice of regions may also be subject to legal compliance requirements.

  • AZ

    An AZ is one or more physical data centers within a region. It has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, networking, storage, and other resources are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers for high availability.

  • Project

    Projects group and isolate resources (including compute, storage, and network 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