All Products
Search
Document Center

ApsaraVideo Live:API overview

Last Updated:Nov 09, 2022

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

AddLiveDomain

Adds a domain name to ApsaraVideo Live. This operation allows you to add only one domain name at a time.

AddLiveDomainPlayMapping

Maps a main streaming domain to a sub-streaming domain.

DeleteLiveDomainPlayMapping

Deletes the mapping between a main streaming domain and a sub-streaming domain.

AddLiveDomainMapping

Maps a streaming domain to an ingest domain.

DeleteLiveDomain

Removes an existing domain name from ApsaraVideo Live.

DeleteLiveDomainMapping

Deletes the mapping between a streaming domain and an ingest domain.

DescribeLiveDomainMapping

Queries the mapping configuration of an ingest domain, a main streaming domain, or a sub-streaming domain.

DescribeLiveDomainDetail

Queries basic information about a domain name.

DescribeLiveUserDomains

Queries domain names of ApsaraVideo Live in your Alibaba Cloud account.

StartLiveDomain

Enables a domain name in the disabled state. After the domain name is enabled, its status changes to online.

StopLiveDomain

Disables a domain name. After the domain name is disabled, its status changes to offline.

DescribeLiveCertificateDetail

Queries the details of a certificate.

DescribeLiveDomainCertificateInfo

Queries certificate information about a domain name.

DescribeLiveCertificateList

Queries the certificates of a domain name.

SetLiveDomainCertificate

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.

BatchDeleteLiveDomainConfigs

Deletes the configurations of multiple domain names at a time.

BatchSetLiveDomainConfigs

Configures multiple domain names at a time.

DescribeLiveDomainConfigs

Queries one or more configurations of a domain name.

Stream pulling

Operation

Description

AddLivePullStreamInfoConfig

Creates a stream pulling configuration for a live stream.

DescribeLivePullStreamConfig

Queries the stream pulling configurations for a domain name.

DeleteLivePullStreamInfoConfig

Deletes a stream pulling configuration.

SetLiveLazyPullStreamInfoConfig

Creates a configuration that triggers stream pulling.

DescribeLiveLazyPullStreamConfig

Queries the configurations that trigger stream pulling under a streaming domain.

DeleteLiveLazyPullStreamInfoConfig

Deletes a configuration that triggers stream pulling.

UpdateLivePullStreamInfoConfig

Modifies the stream pulling configuration of a live stream, including the origin URL, start time, and end time.

Live stream management

Operation

Description

DescribeLiveStreamsBlockList

Queries the blacklist of live stream URLs under a domain name.

DescribeLiveStreamsControlHistory

Queries the operation records of live streams under a domain name or for an application under the domain name.

DescribeLiveStreamBitRateData

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.

DescribeLiveStreamsOnlineList

Queries the information about all live streams under a domain name or for an application under the domain name.

DescribeLiveStreamsPublishList

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.

ForbidLiveStream

Disables the ingest of a live stream and resumes stream ingest at a specific point in time.

ResumeLiveStream

Resumes the ingest of a live stream.

DescribeLiveDomainOnlineUserNum

Queries the number of online users at a specific point in time for all live streams under a domain name.

DescribeLiveDomainFrameRateAndBitRateData

Queries the frame rates and bitrates of all live streams under an ingest domain.

DescribeLiveDomainLimit

Queries the limits on the numbers of ingested streams and transcoded streams under a streaming domain.

DescribeLiveStreamState

Queries the status of a single stream.

Edge node stream relay

Operation

Description

DescribeLiveEdgeTransfer

Queries the configuration of edge node stream relay.

DeleteLiveEdgeTransfer

Deletes the configuration of edge node stream relay.

SetLiveEdgeTransfer

Sets the configuration of edge node stream relay.

Live center stream relay

Operation

Description

AddLiveCenterTransfer

Adds a configuration of live center stream relay.

UpdateLiveCenterTransfer

Modifies a configuration of live center stream relay.

DescribeLiveCenterTransfer

Queries the information about a configuration of live center stream relay.

DeleteLiveCenterTransfer

Deletes a configuration of live center stream relay.

Stream ingest callbacks

Operation

Description

SetLiveStreamsNotifyUrlConfig

Configures stream ingest callbacks for an ingest domain.

DescribeLiveStreamsNotifyUrlConfig

Queries the callback configuration for stream ingest under an ingest domain.

DeleteLiveStreamsNotifyUrlConfig

Deletes the callback configuration for stream ingest under an ingest domain.

Time shifting

Operation

Description

DescribeLiveShiftConfigs

Queries the time shifting configurations under a domain name.

OpenLiveShift

Enables time shifting for a domain name, or an application or a live stream under the domain name.

CloseLiveShift

Disables time shifting for a domain name, or an application or a live stream under the domain name.

Live stream transcoding

Operation

Description

AddLiveStreamTranscode

Creates a transcoding configuration.

AddCustomLiveStreamTranscode

Creates a custom transcoding configuration for live streams under a streaming domain.

AddRtsLiveStreamTranscod

Creates a Real-Time Streaming (RTS) transcoding configuration for live streams under a streaming domain.

DeleteLiveStreamTranscode

Deletes a transcoding configuration.

DescribeLiveStreamTranscodeInfo

Queries the transcoding configurations of live streams under a streaming domain.

AddTrancodeSEI

Inserts supplemental enhancement information (SEI) to a live stream when the live stream is transcoded.

Live to VOD

Operation

Description

AddLiveRecordVodConfig

Configures the Live to VOD feature to store recordings in a media library of ApsaraVideo VOD.

DeleteLiveRecordVodConfig

Deletes the configurations of the Live to VOD feature.

DescribeLiveRecordVodConfigs

Queries the configurations of the Live to VOD feature.

Live stream recording

Operation

Description

AddLiveAppRecordConfig

Configures the recording feature for an application to store recordings in Object Storage Service (OSS).

RealTimeRecordCommand

Controls recordings manually on demand. For example, you can start or stop recording at any time.

DeleteLiveAppRecordConfig

Deletes the recording configurations of an application.

DescribeLiveRecordConfig

Queries the recording configurations of all applications under a domain name.

DescribeLiveStreamRecordContent

Queries the recordings of a live stream.

CreateLiveStreamRecordIndexFiles

Creates an index file for a recording.

DescribeLiveStreamRecordIndexFile

Queries the configuration of an index file.

DescribeLiveStreamRecordIndexFiles

Queries all index files within a specific time period.

AddLiveRecordNotifyConfig

Configures recording callbacks for a streaming domain.

DeleteLiveRecordNotifyConfig

Deletes the recording callback configurations of a streaming domain.

DescribeLiveRecordNotifyConfig

Queries the recording callback configurations of a streaming domain.

UpdateLiveRecordNotifyConfig

Modifies the recording callback configurations of a streaming domain.

Live snapshots

Operation

Description

AddLiveAppSnapshotConfig

Configures the snapshot feature for a streaming domain. The captured snapshots are stored in OSS. The configurations take effect after you restart stream ingest.

DeleteLiveAppSnapshotConfig

Deletes snapshot configurations for live streams in an application. The deletion takes effect after you restart stream ingest.

DescribeLiveSnapshotConfig

Queries the snapshot configurations of a streaming domain.

UpdateLiveAppSnapshotConfig

Modifies the snapshot configurations of a streaming domain. The captured snapshots are stored in OSS. The modification takes effect after you restart stream ingest.

DescribeLiveStreamSnapshotInfo

Queries the snapshots that are captured within a specific time period.

SetSnapshotCallbackAuth

Configures authentication for the callback for snapshots.

QuerySnapshotCallbackAuth

Queries the authentication configuration for the callback for snapshots.

DeleteSnapshotCallbackAuth

Deletes the authentication configuration for the callback for snapshots.

Resource monitoring

Operation

Description

DescribeLiveDomainBpsData

Queries the bandwidth data for one or more streaming domains.

DescribeLiveDomainTrafficData

Queries the network traffic data for one or more streaming domains.

DescribeLiveDomainPushBpsData

Queries the bandwidth data for one or more ingest domains.

DescribeLiveDomainPushTrafficData

Queries the network traffic data for one or more ingest domains.

DescribeLiveDomainRealTimeBpsData

Queries the bandwidth data that is collected every minute for one or more streaming domains.

DescribeLiveDomainRealTimeTrafficData

Queries the network traffic data that is collected every minute for one or more domain names for CDN.

DescribeLiveStreamHistoryUserNum

Queries the number of historical online users for a live stream.

DescribeLiveDomainRealTimeHttpCodeData

Queries the proportions of HTTP status codes in a minute for accelerated domain names.

DescribeLiveStreamCount

Queries the numbers of online source streams and transcoded streams.

DescribeLiveDomainPvUvData

Queries the data of page views (PVs) and unique visitors (UVs) of a streaming domain.

Resource usage

Operation

Description

DescribeLiveDomainRecordUsageData

Queries the numbers of live recording channels and container format conversions.

DescribeLiveDomainSnapshotData

Queries the number of snapshots for one or more streaming domains.

DescribeDomainUsageData

Queries the resource usage data of specific domain names in a specified billable region.

DescribeLiveDomainTimeShiftData

Queries the resource usage data of time shifting for one or more domain names.

DescribeLiveDomainStreamTranscodeData

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

CreateCaster

Creates a production studio.

AddCasterLayout

Adds a layout to a production studio.

AddCasterVideoResource

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.

CopyCaster

Duplicates a production studio and obtains a new production studio.

CopyCasterSceneConfig

Copies the configuration of a PVW scene to a PGM scene.

AddCasterComponent

Adds a component to a production studio.

DeleteCaster

Deletes a production studio.

DeleteCasterLayout

Removes a layout from a production studio.

DeleteCasterVideoResource

Removes a video source from a production studio.

DescribeCasterConfig

Queries the configurations of a production studio.

DescribeCasterLayouts

Queries a specified layout or all layouts of a production studio.

DescribeCasters

Queries the list of production studios.

DescribeCasterScenes

Queries the scenes of a production studio.

DescribeCasterStreamUrl

Queries the streaming URLs of a production studio.

DescribeCasterVideoResources

Queries the video sources of a production studio.

EffectCasterUrgent

Switches a specified scene to a standby video in a production studio. Only a PGM scene can be switched to a standby video.

EffectCasterVideoResource

Updates the standby video source in a specified scene. Make sure that the video source is referenced by the scene.

ModifyCasterLayout

Modifies a layout. You need only to pass parameters to be modified to this operation.

ModifyCasterVideoResource

Modifies a video source of a production studio.

SetCasterConfig

Sets all parameters for a production studio. If a parameter is not specified, the production studio does not have the relevant configuration.

SetCasterSceneConfig

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.

StartCaster

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.

StartCasterScene

Starts a specified PVW scene.

StopCaster

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.

StopCasterScene

Stops a specified PVW scene.

UpdateCasterSceneConfig

Modifies a scene, including the layout, without invalidating the previous configurations. This operation is more efficient than the SetCasterSceneConfig operation.

DeleteCasterComponent

Removes a component from a production studio.

DescribeCasterComponents

Queries the components of a production studio.

ModifyCasterComponent

Modifies a component of a production studio.

AddCasterEpisode

Adds an episode to a production studio.

ModifyCasterEpisode

Modifies the configurations of an episode in a production studio. You cannot change the episode type.

DeleteCasterEpisode

Removes an episode from a production studio.

AddCasterEpisodeGroup

Creates an episode list in a production studio.

DeleteCasterEpisodeGroup

Deletes an episode list from a production studio.

AddCasterProgram

Adds an episode list to a production studio.

ModifyCasterProgram

Modifies an episode list of a production studio.

DeleteCasterProgram

Deletes episode lists from a production studio.

DescribeCasterProgram

Queries the information about episode lists in a production studio.

UpdateCasterSceneAudio

Modifies the audio configurations of a scene.

DescribeCasterSceneAudio

Queries the audio configurations of a scene.

SetCasterChannel

Configures a channel of a production studio.

DescribeCasterChannels

Queries the channels of a production studio.

DeleteCasterSceneConfig

Clears the configurations of a scene.

AddCasterEpisodeGroupContent

Adds an episode list to a production studio.

AddPlaylistItems

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.

DeletePlaylistItems

Removes episodes from an episode list.

ListPlaylistItems

Queries the information about episodes in an episode list.

EditPlaylist

Updates episodes in an episode list.

DeletePlaylist

Deletes an episode list.

ListPlaylist

Queries the information about specified episode lists or all episode lists that belong to the current account.

StartPlaylist

Starts playback for an episode list.

StopPlaylist

Stops playback for an episode list.

AddShowIntoShowList

Adds an episode to an episode list.

RemoveShowFromShowList

Deletes a specified episode from an episode list.

DescribeShowList

Queries the details of an episode list.

ModifyShowList

Modifies the attributes of an episode list.

PlayChoosenShow

Switches to a specified episode.

Live stream watermarks

Operation

Description

AddLiveStreamWatermark

Creates a watermark template.

DeleteLiveStreamWatermark

Deletes a specified watermark template.

UpdateLiveStreamWatermark

Updates a watermark template.

DescribeLiveStreamWatermark

Queries watermark templates.

AddLiveStreamWatermarkRule

Adds a watermark rule.

DeleteLiveStreamWatermarkRule

Deletes a watermark rule.

UpdateLiveStreamWatermarkRule

Updates a watermark rule.

DescribeLiveStreamWatermarkRule

Queries watermark rules.