All Products
Search
Document Center

API overview

Last Updated: May 19, 2022

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

API

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 in your Alibaba Cloud account.

StartLiveDomain

Enables a domain name in the disabled state. After a 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 one or more domain names.

DescribeLiveDomainConfigs

Queries one or more configurations of a domain name.

Stream pulling

API

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 URLs, start time, and end time.

Live stream management

API

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 the live streams under an ingest domain.

DescribeLiveDomainLimit

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

Live stream transfer

API

Description

DescribeLiveEdgeTransfer

Queries the configurations of live stream transfer.

DeleteLiveEdgeTransfer

Deletes the configurations of live stream transfer.

SetLiveEdgeTransfer

Sets the configurations of live stream transfer.

Stream ingest callbacks

API

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

API

Description

DescribeLiveShiftConfigs

Queries the time shifting configurations under a domain name.

OpenLiveShift

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

CloseLiveShift

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

Live stream transcoding

API

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 streaming domain.

AddTrancodeSEI

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

Live to VOD

API

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

API

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

API

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.

Resource monitoring

API

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 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 streaming domain.

Resource usage

API

Description

DescribeLiveDomainRecordUsageData

Queries the number 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 for one or more domain names in a specified 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.