All Products
Search
Document Center

ApsaraVideo Live:List of operations by function

Last Updated:Sep 26, 2024

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 sub-streaming domain to a main 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 information of an ingest domain, a main streaming domain, or a sub-streaming domain.

DescribeLiveDomainDetail

Queries the basic information about a domain name.

DescribeLiveUserDomains

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

StartLiveDomain

Enables a disabled domain name. 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 certificates.

DescribeLiveHttpsDomainList

Queries the information about all certificates that you have configured.

DescribeLiveDomainByCertificate

Queries the accelerated domain names that match a certificate.

SetLiveDomainCertificate

Enables or disables the certificate of a domain name, and modifies the 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 of triggered stream pulling.

DescribeLiveLazyPullStreamConfig

Queries the configurations of triggered stream pulling for a streaming domain.

DeleteLiveLazyPullStreamInfoConfig

Deletes a configuration of triggered stream pulling.

UpdateLivePullStreamInfoConfig

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

Live stream management

Operation

Description

DescribeLiveStreamsBlockList

Queries the live streams that are blacklisted 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 active 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 maximum allowed numbers of ingested streams and transcoded streams under a streaming domain.

DescribeLiveStreamState

Queries the status of a single stream.

Edge stream relay

Operation

Description

DescribeLiveEdgeTransfer

Queries the configuration of edge stream relay.

DeleteLiveEdgeTransfer

Deletes the configuration of edge stream relay.

SetLiveEdgeTransfer

Sets the configuration of edge 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.

Primary/secondary stream mixing

Operation

Description

AddLiveStreamMerge

Adds a configuration of primary/secondary stream mixing.

DeleteLiveStreamMerge

Deletes a configuration of primary/secondary stream mixing.

DescribeLiveStreamMerge

Queries configurations of primary/secondary stream mixing.

Stream delay

Operation

Description

CreateLiveDelayConfig

Adds a stream delay configuration.

ListLiveDelayConfig

Queries stream delay configurations.

DescribeLiveDelayConfig

Queries the information about a stream delay configuration.

UpdateLiveDelayConfig

Updates a stream delay configuration.

DeleteLiveDelayConfig

Deletes a stream delay configuration.

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.

Live streaming security

Operation

Description

DescribeStreamLocationBlock

Queries configurations of stream-level region blocking.

SetLiveStreamBlock

Configures stream-level region blocking.

DeleteLiveStreamBlock

Deletes a configuration of stream-level region blocking.

Time shifting

Operation

Description

DescribeLiveShiftConfigs

Queries the time shifting configurations of 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

Adds a transcoding configuration for a streaming domain.

AddCustomLiveStreamTranscode

Adds a custom transcoding configuration for a streaming domain.

AddRtsLiveStreamTranscod

Adds a Real-Time Streaming (RTS) transcoding configuration for a streaming domain.

DeleteLiveStreamTranscode

Deletes a transcoding configuration.

DescribeLiveStreamTranscodeInfo

Queries the transcoding configurations of a streaming domain.

AddTrancodeSEI

Inserts supplemental enhancement information (SEI) to transcoded streams.

Live recordings stored in ApsaraVideo VOD

Operation

Description

AddLiveRecordVodConfig

Adds a Live-to-VOD configuration to store recordings in the media library of ApsaraVideo VOD.

UpdateLiveRecordVodConfig

Updates a Live-to-VOD configuration.

DescribeLiveRecordVodConfigs

Queries Live-to-VOD configurations.

DeleteLiveRecordVodConfig

Deletes a Live-to-VOD configuration.

Live recordings stored in OSS

Operation

Description

AddLiveAppRecordConfig

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

UpdateLiveAppRecordConfig

Updates a recording configuration for an application or a live stream.

RealTimeRecordCommand

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

DeleteLiveAppRecordConfig

Deletes a recording configuration.

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 configuration of a streaming domain.

DescribeLiveRecordNotifyConfig

Queries the recording callback configuration of a streaming domain.

UpdateLiveRecordNotifyConfig

Modifies the recording callback configuration of a streaming domain.

DeleteLiveStreamRecordIndexFiles

Deletes live stream recordings.

Live stream snapshots

Operation

Description

AddLiveAppSnapshotConfig

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

DeleteLiveAppSnapshotConfig

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

DescribeLiveSnapshotConfig

Queries the snapshot configuration of a streaming domain.

UpdateLiveAppSnapshotConfig

Modifies the snapshot configuration 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.

AddLiveSnapshotNotifyConfig

Configures snapshot callbacks.

UpdateLiveSnapshotNotifyConfig

Modifies the configuration of snapshot callbacks.

DescribeLiveSnapshotNotifyConfig

Queries the configuration of snapshot callbacks.

DeleteLiveSnapshotNotifyConfig

Deletes the configuration of snapshot callbacks.

Live stream encapsulation

Operation

Description

AddLivePackageConfig

Adds a live stream encapsulation configuration.

UpdateLivePackageConfig

Updates a live stream encapsulation configuration.

DescribeLivePackageConfig

Queries live stream encapsulation configurations.

DeleteLivePackageConfig

Deletes a live stream encapsulation configuration.

Content moderation

Operation

Description

AddLiveSnapshotDetectPornConfig

Adds a video moderation configuration for live streams in an application under a domain name.

AddLiveDetectNotifyConfig

Configures callbacks for video moderation results. As a result, a callback URL that is used to receive the callback notifications is added.

DescribeLiveSnapshotDetectPornConfig

Queries video moderation configurations.

DescribeLiveDetectNotifyConfig

Queries the configuration of callbacks for video moderation results.

UpdateLiveSnapshotDetectPornConfig

Modifies a video moderation configuration.

UpdateLiveDetectNotifyConfig

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.

DeleteLiveSnapshotDetectPornConfig

Deletes a video moderation configuration.

DeleteLiveDetectNotifyConfig

Deletes the configuration of callbacks for video moderation results.

AddLiveAudioAuditConfig

Adds an audio moderation configuration.

AddLiveAudioAuditNotifyConfig

Configures callbacks for audio moderation results.

DeleteLiveAudioAuditConfig

Deletes an audio moderation configuration.

DeleteLiveAudioAuditNotifyConfig

Deletes the configuration of callbacks for audio moderation results.

UpdateLiveAudioAuditNotifyConfig

Modifies the configuration of callbacks for audio moderation results.

UpdateLiveAudioAuditConfig

Modifies an audio moderation configuration.

DescribeLiveAudioAuditConfig

Queries audio moderation configurations.

DescribeLiveAudioAuditNotifyConfig

Queries the configuration of callbacks for audio moderation results.

Live streaming latency

Operation

Description

DescribeLiveStreamDelayConfig

Queries the live streaming latency.

SetLiveStreamDelayConfig

Configures the live streaming latency.

Global Accelerator (GA)

Operation

Description

DescribeLivePrivateLineAreas

Queries available access points where acceleration circuits start.

CreateLivePrivateLine

Creates a GA instance and binds it to an acceleration circuit.

DescribeLivePrivateLineAvailGa

Queries the binding information between GA instances and acceleration circuits.

DeleteLivePrivateLine

Unbinds a GA instance from an acceleration circuit.

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 accelerated domain names.

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.

DescribeLiveStreamsTotalCount

Queries the total number of live streams within a specific time period. Data is collected on a daily basis.

DescribeLiveDomainPvUvData

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

EdgeScript

Operation

Description

DescribeLiveDomainStagingConfig

Queries the configuration in the canary release environment.

SetLiveDomainStagingConfig

Sets or modifies domain name configurations in the canary release environment.

DeleteLiveSpecificStagingConfig

Deletes domain name configurations in the canary release environment.

PublishLiveStagingConfigToProduction

Publishes the configurations of an accelerated domain name from the canary release environment to the production environment.

RollbackLiveStagingConfig

Rolls back the configurations of an accelerated domain name in the canary release environment.

Resource usage

Operation

Description

DescribeLiveDomainRecordUsageData

Queries the number of live recording channels and the length of container format conversion.

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.

DescribeLivePushProxyUsageData

Queries the usage data of live center stream relay.

DescribeLiveDomainTimeShiftData

Queries the time shifting usage data.

DescribeLiveDomainStreamTranscodeData

Queries the transcoding usage data for one or more domain names.

DescribeLiveProducerUsageData

Queries the production studio usage data.

DescribeLiveDomainMonitoringUsageData

Queries the live monitoring usage data for one or more domain names.

DescribeLiveDelayedStreamingUsage

Queries the stream delay usage data.

DescribeLiveGrtnDuration

Queries the co-streaming usage data.

DescribeMeterLiveBypassDuration

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

CreateCaster

Creates a production studio.

AddCasterLayout

Adds a layout for a production studio.

AddCasterVideoResource

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.

CopyCaster

Duplicates a production studio and obtains a new production studio.

CopyCasterSceneConfig

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

AddCasterComponent

Adds a component to a production studio.

DeleteCaster

Deletes a production studio.

RestartCaster

Restarts a production studio.

DeleteCasterLayout

Deletes a layout in a production studio.

DeleteCasterVideoResource

Removes an input 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 input sources of a production studio.

EffectCasterUrgent

Switches a specified scene to the standby resource in a production studio. Only a PGM scene is supported.

EffectCasterVideoResource

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

ModifyCasterLayout

Modifies a layout of a production studio. You need only to pass in parameters that you want to update.

ModifyCasterVideoResource

Modifies an input 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

Deletes a component in 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

Deletes an episode in a production studio.

AddCasterEpisodeGroup

Creates an episode list in a production studio.

DeleteCasterEpisodeGroup

Deletes an episode list in a production studio.

AddCasterProgram

Adds the episode list for carousel playback in a production studio.

ModifyCasterProgram

Modifies the episode list for carousel playback in a production studio.

DeleteCasterProgram

Deletes the episode list for carousel playback in a production studio.

DescribeCasterProgram

Queries the information about the episode list for carousel playback 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

Deletes the settings of a scene.

AddCasterEpisodeGroupContent

Adds information about an episode list in a production studio.

AddPlaylistItems

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.

DeletePlaylistItems

Removes episodes from an episode list.

ListPlaylistItems

Queries the information about episodes in an episode list.

EditPlaylist

Edits an episode list.

DeletePlaylist

Deletes an episode list.

ListPlaylist

Queries the information about one or more episode lists.

StartPlaylist

Starts playing an episode list.

StopPlaylist

Stops playing an episode list.

AddShowIntoShowList

Adds an episode to an episode list.

RemoveShowFromShowList

Removes an 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.

AddStudioLayout

Configures a layout for a virtual studio.

DeleteStudioLayout

Deletes a layout in a virtual studio.

ModifyStudioLayout

Modifies a layout of a virtual studio.

DescribeStudioLayouts

Queries one or more layouts of a virtual studio.

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.

Live monitoring

Operation

Description

CreateLiveStreamMonitor

Creates a monitoring session.

UpdateLiveStreamMonitor

Updates the configurations of a monitoring session.

DescribeLiveStreamMonitor

Queries the list of created monitoring sessions.

StartLiveStreamMonitor

Starts live monitoring.

StopLiveStreamMonitor

Stops live monitoring.

DeleteLiveStreamMonitor

Deletes a monitoring session.

ApsaraVideo Real-time Communication

Operation

Description

DescribeChannelParticipants

Queries online users in a channel.

RemoveTerminals

Removes one or more users from a channel.

DeleteChannel

Deletes a channel.

GetMPUTaskStatus

Queries the status of a stream relay task.

StartLiveMPUTask

Creates a mixed-stream relay task.

UpdateLiveMPUTask

Updates a mixed-stream relay task.

StopLiveMPUTask

Stops a mixed-stream relay task.

StartMPUTask

Starts a stream relay task.

UpdateMPUTask

Updates a stream relay task.

StopMPUTask

Stops a stream relay task.

CreateEventSub

Creates a callback to subscribe to channel or user events.

DeleteEventSub

Deletes a callback that is used to subscribe to channel or user events.

Live subtitles (in public preview)

Operation

Description

AddLiveAISubtitle

Adds a subtitle template.

UpdateLiveAISubtitle

Updates a subtitle template.

DescribeLiveAISubtitle

Queries subtitle templates.

DeleteLiveAISubtitle

Deletes a specified subtitle template.

AddLiveAIProduceRules

Adds a subtitle rule.

UpdateLiveAIProduceRules

Updates a subtitle rule.

DescribeLiveAIProduceRules

Queries subtitle rules.

DeleteLiveAIProduceRules

Deletes a subtitle rule.

Tools

Operation

Description

DescribeLiveIpInfo

Checks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP).