The following tables list the API operations available for use in ApsaraVideo Live. We recommend that you use server SDKs to call the API operations.
Live domain management
Operation |
Description |
|---|---|
Adds a live domain to ApsaraVideo Live. This operation allows you to add only one live domain at a time. |
|
Maps a main streaming domain to a sub-streaming domain. |
|
Deletes the mapping between a main streaming domain and a sub-streaming domain. |
|
Maps a streaming domain to an ingest domain. |
|
Removes a live domain from ApsaraVideo Live. |
|
Deletes the mapping between a streaming domain and an ingest domain. |
|
Queries the mapping configuration of an ingest domain, a main streaming domain, or a sub-streaming domain. |
|
Queries the basic information about a live domain. |
|
Queries the live domains within your Alibaba Cloud account based on the specified query criteria. |
|
Enables a disabled live domain. After the live domain is enabled, its status changes to online. |
|
Disables a live domain. After the live domain is disabled, its status changes to offline. |
|
Queries the details of a certificate. |
|
Queries the certificate information about a live domain. |
|
Queries the certificates of a live domain. |
|
Enables or disables the Secure Sockets Layer (SSL) certificate for a live domain. When you call this operation to enable the SSL certificate, you can also modify the certificate information. |
|
Deletes the configurations of multiple live domains at a time. |
|
Configures one or more live domains. |
|
Queries one or more configurations of a live domain. |
Stream pulling
Operation |
Description |
|---|---|
Creates a stream pulling configuration for a live stream. |
|
Queries the stream pulling configurations under a live domain. |
|
Deletes a stream pulling configuration. |
|
Creates a configuration that triggers stream pulling. |
|
Queries the configurations that trigger stream pulling under a streaming domain. |
|
Deletes a configuration that triggers stream pulling. |
|
Modifies the stream pulling configuration of a live stream, including the origin URLs, start time, and end time. |
Live stream management
Operation |
Description |
|---|---|
Queries the blacklist of live stream URLs under a live domain. |
|
Queries the operation records of live streams under a live domain or for an application under the live domain. |
|
Queries the frame rates and bitrates of a live stream that is transmitted based on Real-Time Messaging Protocol (RTMP) within a specific time period. You can call this operation to query historical data. |
|
Queries the information about all live streams under a live domain or for an application under the live domain. |
|
Queries the stream ingest records under a live domain or for an application or a live stream under the live domain within a specific time period. |
|
Disables the ingest of a live stream and resumes stream ingest at a specific point in time. |
|
Resumes the ingest of a live stream. |
|
Queries the number of online users at a specific point in time for all live streams under a live domain. |
|
Queries the frame rates and bitrates of all live streams under a live domain. |
|
Queries the quantity limits on stream ingest and transcoding under a streaming domain. |
Stream ingest callbacks
Operation |
Description |
|---|---|
Configures stream ingest callbacks for an ingest domain. |
|
Queries the callback configuration for stream ingest under an ingest domain. |
|
Deletes the callback configuration for stream ingest under an ingest domain. |
Time shifting
Operation |
Description |
|---|---|
Queries the time shifting configurations under a live domain. |
|
Enables time shifting for a live domain, or an application or a live stream under the live domain. |
|
Disables time shifting for a live domain, or an application or a live stream under the live domain. |
Live stream transcoding
Operation |
Description |
|---|---|
Creates a transcoding configuration for a streaming domain. |
|
Creates a custom transcoding configuration for live streams under a streaming domain. |
|
Creates a real-time streaming (RTS) transcoding configuration for live streams under a streaming domain. |
|
Deletes a transcoding configuration. |
|
Queries the transcoding configurations of live streams under a streaming domain. |
|
Inserts supplemental enhancement information (SEI) to a live stream when the live stream is transcoded. |
Live to VOD
Operation |
Description |
|---|---|
Configures the Live to VOD feature to store recordings in a media library of ApsaraVideo VOD. |
|
Deletes the configurations of the Live to VOD feature. |
|
Queries the configurations of the Live to VOD feature. |
Live stream recording
Operation |
Description |
|---|---|
Configures the recording feature for an application to store recordings in Object Storage Service (OSS). |
|
Controls recording manually on demand. For example, you can start or stop recording at any time. |
|
Deletes the recording configurations of an application. |
|
Queries the recording configurations of all applications under a live domain. |
|
Queries the recordings of a live stream. |
|
Creates an index file for a recording. |
|
Queries the configuration of an index file. |
|
Queries all index files within a specific time period. |
|
Configures recording callbacks for a streaming domain. |
|
Deletes the recording callback configurations of a streaming domain. |
|
Queries the recording callback configurations of a streaming domain. |
|
Modifies the recording callback configurations of a streaming domain. |
Live stream snapshots
Operation |
Description |
|---|---|
Configures the snapshot feature for a streaming domain. The captured snapshots are stored in OSS. The configurations take effect after you restart stream ingest. |
|
Deletes snapshot configurations for live streams in an application. The deletion takes effect after you restart stream ingest. |
|
Queries the snapshot configurations of a streaming domain. |
|
Modifies the snapshot configurations of a streaming domain. The captured snapshots are stored in OSS. The modification takes effect after you restart stream ingest. |
|
Queries the snapshots that are captured within a specific time period. |
Resource monitoring
Operation |
Description |
|---|---|
Queries the bandwidth data for one or more live domains. |
|
Queries the network traffic data for one or more live domains. |
|
Queries the bandwidth data for one or more ingest domains. |
|
Queries the network traffic data for one or more ingest domains. |
|
Queries the bandwidth data that is collected every minute for one or more live domains. |
|
Queries the network traffic data that is collected every minute for one or more domain names for CDN. |
|
Queries the number of historical online users for a live stream. |
|
Queries the proportions of HTTP status codes in a minute for domain names for CDN. |
|
Queries the number of online original streams and transcoded streams among live streams. |
|
Queries the data of page views (PVs) and unique visitors (UVs) of a live domain. |
Resource usage
Operation |
Description |
|---|---|
Queries the recording duration for one or more live domains. |
|
Queries the number of snapshots for one or more live domains. |
|
Queries the resource usage data for one or more live domains in a specified region. |
|
Queries the resource usage data of time shifting for one or more live domains. |
|
Queries the transcoding length for one or more domain names. |