All Products
Search
Document Center

List of operations by function

Last Updated: May 28, 2021

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

AddLiveDomain

Adds a live domain to ApsaraVideo Live. This operation allows you to add only one live domain 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 a stream pushing domain.

DeleteLiveDomain

Removes a live domain from ApsaraVideo Live.

DeleteLiveDomainMapping

Deletes the mapping between a streaming domain and a stream pushing domain.

DescribeLiveDomainMapping

Queries the mapping configuration of a stream pushing domain, a main streaming domain, or a sub-streaming domain.

DescribeLiveDomainDetail

Queries the basic information about a live domain.

DescribeLiveUserDomains

Queries the live domains within your Alibaba Cloud account based on the specified query criteria.

StartLiveDomain

Enables a disabled live domain. After the live domain is enabled, its status changes to online.

StopLiveDomain

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

DescribeLiveCertificateDetail

Queries the details of a certificate.

DescribeLiveDomainCertificateInfo

Queries the certificate information about a live domain.

DescribeLiveCertificateList

Queries the certificates of a live domain.

SetLiveDomainCertificate

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.

BatchDeleteLiveDomainConfigs

Deletes the configurations of multiple live domains at a time.

BatchSetLiveDomainConfigs

Configures one or more live domains.

DescribeLiveDomainConfigs

Queries one or more configurations of a live domain.

Stream pulling

Operation

Description

AddLivePullStreamInfoConfig

Creates a stream pulling configuration for a live stream.

DescribeLivePullStreamConfig

Queries the stream pulling configurations under a live domain.

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.

Live stream management

Operation

Description

DescribeLiveStreamsBlockList

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

DescribeLiveStreamsControlHistory

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

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 live domain or for an application under the live domain.

DescribeLiveStreamsPublishList

Queries the stream pushing records under a live domain or for an application or a live stream under the live domain within a specific time period.

ForbidLiveStream

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

ResumeLiveStream

Resumes the pushing of a live stream.

DescribeLiveDomainOnlineUserNum

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

DescribeLiveDomainFrameRateAndBitRateData

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

DescribeLiveDomainLimit

Queries the quantity limits on stream pushing and transcoding under a streaming domain.

Stream pushing callbacks

Operation

Description

SetLiveStreamsNotifyUrlConfig

Configures stream pushing callbacks for a stream pushing domain.

DescribeLiveStreamsNotifyUrlConfig

Queries the callback configuration for stream pushing under a stream pushing domain.

DeleteLiveStreamsNotifyUrlConfig

Deletes the callback configuration for stream pushing under a stream pushing domain.

Time shifting

Operation

Description

DescribeLiveShiftConfigs

Queries the time shifting configurations under a live domain.

OpenLiveShift

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

CloseLiveShift

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

Live stream transcoding

Operation

Description

AddLiveStreamTranscode

Creates a transcoding configuration for a streaming domain.

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 live 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 recording 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 live domain.

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 stream 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 pushing.

DeleteLiveAppSnapshotConfig

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

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 pushing.

DescribeLiveStreamSnapshotInfo

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

Resource monitoring

Operation

Description

DescribeLiveDomainBpsData

Queries the bandwidth for one or more live domains.

DescribeLiveDomainTrafficData

Queries the network traffic for one or more live domains.

DescribeLiveDomainRealTimeBpsData

Queries the bandwidth data that is collected every minute for one or more live 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 that are collected every minute for one or more domain names for CDN.

DescribeLiveStreamCount

Queries the number of online original streams and transcoded streams among live streams.

DescribeLiveDomainPvUvData

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

Resource usage

Operation

Description

DescribeLiveDomainRecordData

Queries the recording duration for one or more live domains.

DescribeLiveDomainSnapshotData

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

DescribeDomainUsageData

Queries the resource usage data for one or more live domains in a specified region.

DescribeLiveDomainTimeShiftData

Queries the resource usage data of time shifting for one or more live domains.

DescribeLiveDomainStreamTranscodeData

Queries the transcoding length for one or more domain names.