Remote procedure call (RPC) signatures apply to API operations in ApsaraVideo Live. For more information about RPC signatures, see RPC invocation method. The following tables list the operations available for use in ApsaraVideo Live. We recommend that you use server SDKs to call the operations.
Domain name management
Operation | Description |
Adds a domain name to ApsaraVideo Live. This operation allows you to add only one domain name 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 an existing domain name 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 basic information about a domain name. | |
Queries domain names of ApsaraVideo Live in your Alibaba Cloud account. | |
Enables a domain name in the disabled state. After the domain name is enabled, its status changes to online. | |
Disables a domain name. After the domain name is disabled, its status changes to offline. | |
Queries the details of a certificate. | |
Queries certificate information about a domain name. | |
Queries the certificates of a domain name. | |
Enables or disables the Secure Sockets Layer (SSL) certificate for a domain name. When you call this operation to enable the SSL certificate, you can also modify certificate information. | |
Deletes the configurations of multiple domain names at a time. | |
Configures multiple domain names at a time. | |
Queries one or more configurations of a domain name. |
Stream pulling
Operation | Description |
Creates a stream pulling configuration for a live stream. | |
Queries the stream pulling configurations for a domain name. | |
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 URL, start time, and end time. |
Live stream management
Operation | Description |
Queries the blacklist of live stream URLs under a domain name. | |
Queries the operation records of live streams under a domain name or for an application under the domain name. | |
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 domain name or for an application under the domain name. | |
Queries the stream ingest records under a domain name or for an application or a live stream under the domain name 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 domain name. | |
Queries the frame rates and bitrates of all live streams under an ingest domain. | |
Queries the limits on the numbers of ingested streams and transcoded streams under a streaming domain. | |
Queries the status of a single stream. |
Edge node stream relay
Operation | Description |
Queries the configuration of edge node stream relay. | |
Deletes the configuration of edge node stream relay. | |
Sets the configuration of edge node stream relay. |
Live center stream relay
Operation | Description |
Adds a configuration of live center stream relay. | |
Modifies a configuration of live center stream relay. | |
Queries the information about a configuration of live center stream relay. | |
Deletes a configuration of live center stream relay. |
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 domain name. | |
Enables time shifting for a domain name, or an application or a live stream under the domain name. | |
Disables time shifting for a domain name, or an application or a live stream under the domain name. |
Live stream transcoding
Operation | Description |
Creates a transcoding configuration. | |
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 recordings 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 domain name. | |
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 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. | |
Configures authentication for the callback for snapshots. | |
Queries the authentication configuration for the callback for snapshots. | |
Deletes the authentication configuration for the callback for snapshots. |
Resource monitoring
Operation | Description |
Queries the bandwidth data for one or more streaming domains. | |
Queries the network traffic data for one or more streaming 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 streaming 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 accelerated domain names. | |
Queries the numbers of online source streams and transcoded streams. | |
Queries the data of page views (PVs) and unique visitors (UVs) of a streaming domain. |
Resource usage
Operation | Description |
Queries the numbers of live recording channels and container format conversions. | |
Queries the number of snapshots for one or more streaming domains. | |
Queries the resource usage data of specific domain names in a specified billable region. | |
Queries the resource usage data of time shifting for one or more domain names. | |
Queries the transcoding length for one or more domain names. |
Production studio
For more information about the list of API operations related to production studios, see List of operations by function.
Operation | Description |
Creates a production studio. | |
Adds a layout to a production studio. | |
Adds a video source to a production studio. The number of video sources is limited by the number of input channels of the production studio. | |
Duplicates a production studio and obtains a new production studio. | |
Copies the configuration of a PVW scene to a PGM scene. | |
Adds a component to a production studio. | |
Deletes a production studio. | |
Removes a layout from a production studio. | |
Removes a video source from a production studio. | |
Queries the configurations of a production studio. | |
Queries a specified layout or all layouts of a production studio. | |
Queries the list of production studios. | |
Queries the scenes of a production studio. | |
Queries the streaming URLs of a production studio. | |
Queries the video sources of a production studio. | |
Switches a specified scene to a standby video in a production studio. Only a PGM scene can be switched to a standby video. | |
Updates the standby video source in a specified scene. Make sure that the video source is referenced by the scene. | |
Modifies a layout. You need only to pass parameters to be modified to this operation. | |
Modifies a video source of a production studio. | |
Sets all parameters for a production studio. If a parameter is not specified, the production studio does not have the relevant configuration. | |
Sets all parameters, and configures and applies a layout for a scene of a production studio. If a parameter is not specified, the scene does not have the relevant configuration. | |
Starts a production studio. If the production studio does not have a PVW scene or a PGM scene, this operation creates and starts such scenes and starts audio and video processing tasks. | |
Starts a specified PVW scene. | |
Stops a production studio. When a production studio is stopped, its PVW and PGM scenes are stopped, its output configurations are cleared, and all audio and video processing tasks are stopped. | |
Stops a specified PVW scene. | |
Modifies a scene, including the layout, without invalidating the previous configurations. This operation is more efficient than the SetCasterSceneConfig operation. | |
Removes a component from a production studio. | |
Queries the components of a production studio. | |
Modifies a component of a production studio. | |
Adds an episode to a production studio. | |
Modifies the configurations of an episode in a production studio. You cannot change the episode type. | |
Removes an episode from a production studio. | |
Creates an episode list in a production studio. | |
Deletes an episode list from a production studio. | |
Adds an episode list to a production studio. | |
Modifies an episode list of a production studio. | |
Deletes episode lists from a production studio. | |
Queries the information about episode lists in a production studio. | |
Modifies the audio configurations of a scene. | |
Queries the audio configurations of a scene. | |
Configures a channel of a production studio. | |
Queries the channels of a production studio. | |
Clears the configurations of a scene. | |
Adds an episode list to a production studio. | |
Adds episodes to a production studio. If no episode list exists in the production studio, this operation creates an episode list for the production studio. | |
Removes episodes from an episode list. | |
Queries the information about episodes in an episode list. | |
Updates episodes in an episode list. | |
Deletes an episode list. | |
Queries the information about specified episode lists or all episode lists that belong to the current account. | |
Starts playback for an episode list. | |
Stops playback for an episode list. | |
Adds an episode to an episode list. | |
Deletes a specified episode from an episode list. | |
Queries the details of an episode list. | |
Modifies the attributes of an episode list. | |
Switches to a specified episode. |
Live stream watermarks
Operation | Description |
Creates a watermark template. | |
Deletes a specified watermark template. | |
Updates a watermark template. | |
Queries watermark templates. | |
Adds a watermark rule. | |
Deletes a watermark rule. | |
Updates a watermark rule. | |
Queries watermark rules. |