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 sub-streaming domain to a main 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 information of an ingest domain, a main streaming domain, or a sub-streaming domain. | |
Queries the basic information about a domain name. | |
Queries domain names of ApsaraVideo Live in your Alibaba Cloud account. | |
Enables a disabled domain name. 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 certificates. | |
Queries the information about all certificates that you have configured. | |
Queries the accelerated domain names that match a certificate. | |
Enables or disables the certificate of a domain name, and modifies the 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 of triggered stream pulling. | |
Queries the configurations of triggered stream pulling for a streaming domain. | |
Deletes a configuration of triggered stream pulling. | |
Modifies the stream pulling settings of a live stream, including the origin URL, start time, and end time. |
Live stream management
Operation | Description |
Queries the live streams that are blacklisted 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 active 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 maximum allowed numbers of ingested streams and transcoded streams under a streaming domain. | |
Queries the status of a single stream. |
Edge stream relay
Operation | Description |
Queries the configuration of edge stream relay. | |
Deletes the configuration of edge stream relay. | |
Sets the configuration of edge 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. |
Primary/secondary stream mixing
Operation | Description |
Adds a configuration of primary/secondary stream mixing. | |
Deletes a configuration of primary/secondary stream mixing. | |
Queries configurations of primary/secondary stream mixing. |
Stream delay
Operation | Description |
Adds a stream delay configuration. | |
Queries stream delay configurations. | |
Queries the information about a stream delay configuration. | |
Updates a stream delay configuration. | |
Deletes a stream delay configuration. |
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. |
Live streaming security
Operation | Description |
Queries configurations of stream-level region blocking. | |
Configures stream-level region blocking. | |
Deletes a configuration of stream-level region blocking. |
Time shifting
Operation | Description |
Queries the time shifting configurations of 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 |
Adds a transcoding configuration for a streaming domain. | |
Adds a custom transcoding configuration for a streaming domain. | |
Adds a Real-Time Streaming (RTS) transcoding configuration for a streaming domain. | |
Deletes a transcoding configuration. | |
Queries the transcoding configurations of a streaming domain. | |
Inserts supplemental enhancement information (SEI) to transcoded streams. |
Live recordings stored in ApsaraVideo VOD
Operation | Description |
Adds a Live-to-VOD configuration to store recordings in the media library of ApsaraVideo VOD. | |
Updates a Live-to-VOD configuration. | |
Queries Live-to-VOD configurations. | |
Deletes a Live-to-VOD configuration. |
Live recordings stored in OSS
Operation | Description |
Configures the recording feature for an application to store recordings in Object Storage Service (OSS). | |
Updates a recording configuration for an application or a live stream. | |
Controls recordings manually on demand. For example, you can start or stop recording at any time. | |
Deletes a recording configuration. | |
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 configuration of a streaming domain. | |
Queries the recording callback configuration of a streaming domain. | |
Modifies the recording callback configuration of a streaming domain. | |
Deletes live stream recordings. |
Live stream snapshots
Operation | Description |
Configures the snapshot feature for a streaming domain. The captured snapshots are stored in OSS. The configuration takes effect after you restart stream ingest. | |
Deletes the snapshot configuration for live streams in an application. The deletion takes effect after you restart stream ingest. | |
Queries the snapshot configuration of a streaming domain. | |
Modifies the snapshot configuration 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 snapshot callbacks. | |
Modifies the configuration of snapshot callbacks. | |
Queries the configuration of snapshot callbacks. | |
Deletes the configuration of snapshot callbacks. |
Live stream encapsulation
Operation | Description |
Adds a live stream encapsulation configuration. | |
Updates a live stream encapsulation configuration. | |
Queries live stream encapsulation configurations. | |
Deletes a live stream encapsulation configuration. |
Content moderation
Operation | Description |
Adds a video moderation configuration for live streams in an application under a domain name. | |
Configures callbacks for video moderation results. As a result, a callback URL that is used to receive the callback notifications is added. | |
Queries video moderation configurations. | |
Queries the configuration of callbacks for video moderation results. | |
Modifies a video moderation configuration. | |
Modifies the configuration of callbacks for video moderation results. As a result, the callback URL that is used to receive the callback notifications is changed. | |
Deletes a video moderation configuration. | |
Deletes the configuration of callbacks for video moderation results. | |
Adds an audio moderation configuration. | |
Configures callbacks for audio moderation results. | |
Deletes an audio moderation configuration. | |
Deletes the configuration of callbacks for audio moderation results. | |
Modifies the configuration of callbacks for audio moderation results. | |
Modifies an audio moderation configuration. | |
Queries audio moderation configurations. | |
Queries the configuration of callbacks for audio moderation results. |
Live streaming latency
Operation | Description |
Queries the live streaming latency. | |
Configures the live streaming latency. |
Global Accelerator (GA)
Operation | Description |
Queries available access points where acceleration circuits start. | |
Creates a GA instance and binds it to an acceleration circuit. | |
Queries the binding information between GA instances and acceleration circuits. | |
Unbinds a GA instance from an acceleration circuit. |
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 accelerated domain names. | |
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 total number of live streams within a specific time period. Data is collected on a daily basis. | |
Queries the data of page views (PVs) and unique visitors (UVs) of a streaming domain. |
EdgeScript
Operation | Description |
Queries the configuration in the canary release environment. | |
Sets or modifies domain name configurations in the canary release environment. | |
Deletes domain name configurations in the canary release environment. | |
Publishes the configurations of an accelerated domain name from the canary release environment to the production environment. | |
Rolls back the configurations of an accelerated domain name in the canary release environment. |
Resource usage
Operation | Description |
Queries the number of live recording channels and the length of container format conversion. | |
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 usage data of live center stream relay. | |
Queries the time shifting usage data. | |
Queries the transcoding usage data for one or more domain names. | |
Queries the production studio usage data. | |
Queries the live monitoring usage data for one or more domain names. | |
Queries the stream delay usage data. | |
Queries the co-streaming usage data. | |
Queries the mixed-stream transcoding usage data. |
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 for a production studio. | |
Adds an input source to a production studio. The number of input sources is limited by the number of input channels of the production studio. | |
Duplicates a production studio and obtains a new production studio. | |
Applies the configuration of a PVW scene to a PGM scene. | |
Adds a component to a production studio. | |
Deletes a production studio. | |
Restarts a production studio. | |
Deletes a layout in a production studio. | |
Removes an input 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 input sources of a production studio. | |
Switches a specified scene to the standby resource in a production studio. Only a PGM scene is supported. | |
Updates the standby resource in a specified scene. Make sure that the resource is referenced by the scene. | |
Modifies a layout of a production studio. You need only to pass in parameters that you want to update. | |
Modifies an input 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. | |
Deletes a component in 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. | |
Deletes an episode in a production studio. | |
Creates an episode list in a production studio. | |
Deletes an episode list in a production studio. | |
Adds the episode list for carousel playback in a production studio. | |
Modifies the episode list for carousel playback in a production studio. | |
Deletes the episode list for carousel playback in a production studio. | |
Queries the information about the episode list for carousel playback 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. | |
Deletes the settings of a scene. | |
Adds information about an episode list in a production studio. | |
Adds episodes to an episode list. 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. | |
Edits an episode list. | |
Deletes an episode list. | |
Queries the information about one or more episode lists. | |
Starts playing an episode list. | |
Stops playing an episode list. | |
Adds an episode to an episode list. | |
Removes an episode from an episode list. | |
Queries the details of an episode list. | |
Modifies the attributes of an episode list. | |
Switches to a specified episode. | |
Configures a layout for a virtual studio. | |
Deletes a layout in a virtual studio. | |
Modifies a layout of a virtual studio. | |
Queries one or more layouts of a virtual studio. |
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. |
Live monitoring
Operation | Description |
Creates a monitoring session. | |
Updates the configurations of a monitoring session. | |
Queries the list of created monitoring sessions. | |
Starts live monitoring. | |
Stops live monitoring. | |
Deletes a monitoring session. |
ApsaraVideo Real-time Communication
Operation | Description |
Queries online users in a channel. | |
Removes one or more users from a channel. | |
Deletes a channel. | |
Queries the status of a stream relay task. | |
Creates a mixed-stream relay task. | |
Updates a mixed-stream relay task. | |
Stops a mixed-stream relay task. | |
Starts a stream relay task. | |
Updates a stream relay task. | |
Stops a stream relay task. | |
Creates a callback to subscribe to channel or user events. | |
Deletes a callback that is used to subscribe to channel or user events. |
Live subtitles (in public preview)
Operation | Description |
Adds a subtitle template. | |
Updates a subtitle template. | |
Queries subtitle templates. | |
Deletes a specified subtitle template. | |
Adds a subtitle rule. | |
Updates a subtitle rule. | |
Queries subtitle rules. | |
Deletes a subtitle rule. |
Tools
Operation | Description |
Checks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP). |