All Products
Search
Document Center

ApsaraVideo Live:List of operations by function

Last Updated:Dec 18, 2024
This product(live/2016-11-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Domain name management

APITitleDescription
AddLiveDomainAddLiveDomainAdds a domain name to ApsaraVideo Live.
AddLiveDomainPlayMappingAddLiveDomainPlayMappingMaps a sub-streaming domain to a main streaming domain.
DeleteLiveDomainPlayMappingDeleteLiveDomainPlayMappingDeletes the mapping between a main streaming domain and a sub-streaming domain.
AddLiveDomainMappingAddLiveDomainMappingCreates the mapping between a streaming domain and an ingest domain.
DeleteLiveDomainDeleteLiveDomainRemoves a domain name from ApsaraVideo Live.
DeleteLiveDomainMappingDeleteLiveDomainMappingDeletes the mapping between a streaming domain and an ingest domain.
DescribeLiveDomainMappingDescribeLiveDomainMappingQueries the mappings of an ingest domain, a main streaming domain, or a sub-streaming domain.
DescribeLiveDomainDetailDescribeLiveDomainDetailQueries the basic information about a domain name.
DescribeLiveUserDomainsDescribeLiveUserDomainsQueries domain names of ApsaraVideo Live in your Alibaba Cloud account.
StartLiveDomainStartLiveDomainEnables a disabled domain name. After the domain name is enabled, its status changes to online.
StopLiveDomainStopLiveDomainDisables an enabled domain name. After the domain name is disabled, its status changes to offline.
DescribeLiveCertificateDetailDescribeLiveCertificateDetailQueries the details of a certificate.
DescribeLiveDomainCertificateInfoDescribeLiveDomainCertificateInfoQueries certificate information about a domain name.
DescribeLiveCertificateListDescribeLiveCertificateListQueries the certificates of one or more specified domain names or all certificates within your Alibaba Cloud account.
SetLiveDomainCertificateSetLiveDomainCertificateEnables or disables the certificate of a domain name, and modifies the certificate information.
BatchDeleteLiveDomainConfigsBatchDeleteLiveDomainConfigsDeletes the configurations of multiple domain names at a time.
BatchSetLiveDomainConfigsBatchSetLiveDomainConfigsConfigures multiple domain names at a time.
DescribeLiveDomainConfigsDescribeLiveDomainConfigsQueries one or more configurations of a domain name.
DescribeLiveDomainByCertificateDescribeLiveDomainByCertificateQueries the accelerated domain names that match a certificate.
DescribeLiveHttpsDomainListDescribeLiveHttpsDomainListQueries the information about all certificates that you have configured.
ModifyLiveDomainSchdmByPropertyModifyLiveDomainSchdmByPropertyModifies the acceleration region of a domain name.
DescribeLiveUserTagsDescribeLiveUserTags
VerifyLiveDomainOwnerVerifyLiveDomainOwnerVerifies the ownership of a domain name.

Prefetch

APITitleDescription
SetLiveStreamPreloadTasksSetLiveStreamPreloadTasksConfigures a prefetch task. You can specify multiple URLs to prefetch at a time.
DescribeLiveStreamPreloadTasksDescribeLiveStreamPreloadTasksQueries prefetch tasks in the last three days.
HotLiveRtcStreamHotLiveRtcStreamConfigures prefetch for a live stream that is ingested based on Real-Time Communication (RTC).

Live stream pulling

APITitleDescription
AddLivePullStreamInfoConfigAddLivePullStreamInfoConfigCreates a stream pulling configuration for a live stream.
DescribeLivePullStreamConfigDescribeLivePullStreamConfigQueries the stream pulling configurations for a domain name.
DeleteLivePullStreamInfoConfigDeleteLivePullStreamInfoConfigDeletes a stream pulling configuration.
SetLiveLazyPullStreamInfoConfigSetLiveLazyPullStreamInfoConfigCreates a configuration of triggered stream pulling.
DescribeLiveLazyPullStreamConfigDescribeLiveLazyPullStreamConfigQueries the configurations of triggered stream pulling for a streaming domain.
DeleteLiveLazyPullStreamInfoConfigDeleteLiveLazyPullStreamInfoConfigDeletes a configuration of triggered stream pulling.
UpdateLivePullStreamInfoConfigUpdateLivePullStreamInfoConfigModifies the stream pulling settings of a live stream, including the origin URL, start time, and end time.

Live stream management

APITitleDescription
DescribeLiveStreamsBlockListDescribeLiveStreamsBlockListQueries the live streams that are blacklisted under a domain name.
DescribeLiveStreamsControlHistoryDescribeLiveStreamsControlHistoryQueries the operation history of live streams under a domain name or in an application.
DescribeLiveStreamBitRateDataDescribeLiveStreamBitRateDataQueries the frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) stream within a specified time period. You can call this operation to query historical data.
DescribeLiveStreamsOnlineListDescribeLiveStreamsOnlineListQueries the information about all active streams under a specified domain name or the active streams of an application under a specified domain name.
DescribeLiveStreamsPublishListDescribeLiveStreamsPublishListQueries the stream ingest records of a domain name or an application or stream under a domain name.
ForbidLiveStreamForbidLiveStreamDisables a live stream. You can specify the time when the live stream is resumed.
ResumeLiveStreamResumeLiveStreamResumes the ingest of a live stream.
DescribeLiveDomainOnlineUserNumDescribeLiveDomainOnlineUserNumQueries the number of online users at a specified point in time for all live streams under a specified domain name.
DescribeLiveDomainFrameRateAndBitRateDataDescribeLiveDomainFrameRateAndBitRateDataQueries the frame rates and bitrates of all live streams under an ingest domain.
DescribeLiveDomainLimitDescribeLiveDomainLimitQueries the maximum numbers of ingested and transcoded streams for a streaming domain.
DescribeLiveStreamStateDescribeLiveStreamStateQueries the status of a stream in real time.

Edge node stream relay

APITitleDescription
DescribeLiveEdgeTransferDescribeLiveEdgeTransferQueries the configuration of edge stream relay.
DeleteLiveEdgeTransferDeleteLiveEdgeTransferDeletes the configuration of edge stream relay.
SetLiveEdgeTransferSetLiveEdgeTransferSets the configuration of edge stream relay.

Live center stream relay

APITitleDescription
AddLiveCenterTransferAddLiveCenterTransferAdds a configuration of live center stream relay.
UpdateLiveCenterTransferUpdateLiveCenterTransferModifies the configurations of live center stream relay.
DescribeLiveCenterTransferDescribeLiveCenterTransferQueries the information about a configuration of live center stream relay.
DeleteLiveCenterTransferDeleteLiveCenterTransferDeletes a configuration of live center stream relay.

Primary/secondary stream mixing

APITitleDescription
DeleteLiveStreamMergeDeleteLiveStreamMergeDeletes an active mixed stream.
AddLiveStreamMergeAddLiveStreamMergeInvoke AddLiveStreamMerge to add primary and backup stream merging configuration.
DescribeLiveStreamMergeDescribeLiveStreamMergeInvoke DescribeLiveStreamMerge to query the primary-standby stream merging configuration.

Stream delay

APITitleDescription
DeleteLiveDelayConfigDeleteLiveDelayConfigDeletes a stream delay configuration.
UpdateLiveDelayConfigUpdateLiveDelayConfigUpdates a stream delay configuration.
DescribeLiveDelayConfigDescribeLiveDelayConfigQueries the information about a stream delay configuration.
ListLiveDelayConfigListLiveDelayConfigQueries stream delay configurations.
CreateLiveDelayConfigCreateLiveDelayConfigAdds a stream delay configuration.

Stream ingest callback

APITitleDescription
SetLiveStreamsNotifyUrlConfigSetLiveStreamsNotifyUrlConfigConfigures stream ingest callbacks under an ingest domain.
DescribeLiveStreamsNotifyUrlConfigDescribeLiveStreamsNotifyUrlConfigQueries the callback configuration for stream ingest under an ingest domain.
DeleteLiveStreamsNotifyUrlConfigDeleteLiveStreamsNotifyUrlConfigDeletes the callback configuration for stream ingest under an ingest domain.
DescribeLiveStreamsNotifyRecordsDescribeLiveStreamsNotifyRecordsQueries stream ingest callback records.

Live streaming security

APITitleDescription
DeleteLiveStreamBlockDeleteLiveStreamBlockDeletes a configuration of stream-level region blocking.
SetLiveStreamBlockSetLiveStreamBlockConfigures stream-level region blocking.
DescribeStreamLocationBlockDescribeStreamLocationBlockQueries configurations of stream-level region blocking.

Time shifting

APITitleDescription
DescribeLiveShiftConfigsDescribeLiveShiftConfigsQueries the time shifting configurations of a domain name.
OpenLiveShiftOpenLiveShiftEnables time shifting for a domain name, or an application or a live stream under the domain name.
CloseLiveShiftCloseLiveShiftDisables time shifting for a domain name, or an application or a live stream under the domain name.

Live stream transcoding

APITitleDescription
AddLiveStreamTranscodeAddLiveStreamTranscodeAdds transcoding configurations for a streaming domain.
AddCustomLiveStreamTranscodeAddCustomLiveStreamTranscodeAdds a custom transcoding configuration for a streaming domain.
AddRtsLiveStreamTranscodeAddRtsLiveStreamTranscodeCreates a Real-Time Streaming (RTS) transcoding configuration for a streaming domain.
UpdateCustomLiveStreamTranscodeUpdateCustomLiveStreamTranscodeUpdates a custom transcoding configuration.
UpdateLiveStreamTranscodeUpdateLiveStreamTranscodeUpdates a default transcoding configuration.
UpdateRtsLiveStreamTranscodeUpdateRtsLiveStreamTranscodeUpdates a custom Real-Time Streaming (RTS) transcoding configuration.
DeleteLiveStreamTranscodeDeleteLiveStreamTranscodeDeletes a transcoding configuration.
DescribeLiveStreamTranscodeInfoDescribeLiveStreamTranscodeInfoQueries the transcoding configurations of a streaming domain.
AddTrancodeSEIAddTrancodeSEIInserts supplemental enhancement information (SEI) to transcoded streams.

Store live recordings to ApsaraVideo VOD

APITitleDescription
AddLiveRecordVodConfigAddLiveRecordVodConfigAdds a Live-to-VOD configuration to store recordings in the media library of ApsaraVideo VOD.
UpdateLiveRecordVodConfigUpdateLiveRecordVodConfigUpdates a Live-to-VOD configuration.
DeleteLiveRecordVodConfigDeleteLiveRecordVodConfigDeletes a Live-to-VOD configuration.
DescribeLiveRecordVodConfigsDescribeLiveRecordVodConfigsQueries Live-to-VOD configurations.

Store recordings to OSS

APITitleDescription
AddLiveAppRecordConfigAddLiveAppRecordConfigConfigure APP recording, with output saved to OSS.
RealTimeRecordCommandRealTimeRecordCommandControls recordings manually on demand. For example, you can call this operation to start or stop recording at a specific point in time.
UpdateLiveAppRecordConfigUpdateLiveAppRecordConfigUpdates a recording configuration for an application. The recordings are stored in Object Storage Service (OSS).
DeleteLiveAppRecordConfigDeleteLiveAppRecordConfigDeletes a recording configuration at the application level.
DeleteLiveStreamRecordIndexFilesDeleteLiveStreamRecordIndexFilesDeletes live stream recordings.
DescribeLiveRecordConfigDescribeLiveRecordConfigQueries all recording configurations of an application for a streaming domain.
DescribeLiveStreamRecordContentDescribeLiveStreamRecordContentQueries the recordings of a live stream.
CreateLiveStreamRecordIndexFilesCreateLiveStreamRecordIndexFilesCreates an M3U8 index file for a recording in a specified time period.
DescribeLiveStreamRecordIndexFileDescribeLiveStreamRecordIndexFileQueries the information about an index file.
DescribeLiveStreamRecordIndexFilesDescribeLiveStreamRecordIndexFilesQueries all index files within a specific time period.
AddLiveRecordNotifyConfigAddLiveRecordNotifyConfigConfigures recording callbacks for a domain name.
DeleteLiveRecordNotifyConfigDeleteLiveRecordNotifyConfigDeletes the configuration of callbacks for live stream recording under a domain name.
DescribeLiveRecordNotifyConfigDescribeLiveRecordNotifyConfigQueries the configuration of callbacks for live stream recording under a domain name.
UpdateLiveRecordNotifyConfigUpdateLiveRecordNotifyConfigModifies the recording callback configuration of a streaming domain.

Live snapshot

APITitleDescription
AddLiveAppSnapshotConfigAddLiveAppSnapshotConfigConfigures the snapshot feature for a streaming domain. The captured snapshots are stored in Object Storage Service (OSS). The configuration takes effect after you restart stream ingest.
DeleteLiveAppSnapshotConfigDeleteLiveAppSnapshotConfigDeletes the snapshot configuration for live streams in an application. The deletion takes effect after you restart stream ingest.
DeleteSnapshotFilesDeleteSnapshotFilesDeletes snapshots.
DescribeLiveSnapshotConfigDescribeLiveSnapshotConfigQueries the snapshot configurations of a streaming domain.
UpdateLiveAppSnapshotConfigUpdateLiveAppSnapshotConfigModifies a snapshot configuration of a streaming domain. The captured snapshots are stored in Object Storage Service (OSS). The modification takes effect after you restart stream ingest.
DescribeLiveStreamSnapshotInfoDescribeLiveStreamSnapshotInfoQueries the snapshots that were captured within a specific time period.
DescribeLiveSnapshotNotifyConfigDescribeLiveSnapshotNotifyConfigQueries the configuration of snapshot callbacks.
DeleteLiveSnapshotNotifyConfigDeleteLiveSnapshotNotifyConfigDeletes the configuration of snapshot callbacks.
AddLiveSnapshotNotifyConfigAddLiveSnapshotNotifyConfigConfigures snapshot callbacks.
UpdateLiveSnapshotNotifyConfigUpdateLiveSnapshotNotifyConfigModifies the configuration of snapshot callbacks.
SetSnapshotCallbackAuthSetSnapshotCallbackAuthConfigures authentication for snapshot callbacks.
QuerySnapshotCallbackAuthQuerySnapshotCallbackAuthQueries the configuration of authentication for snapshot callbacks.

Live stream encapsulation

APITitleDescription
AddLivePackageConfigAddLivePackageConfigAdds a live stream encapsulation configuration.
UpdateLivePackageConfigUpdateLivePackageConfigUpdates a live stream encapsulation configuration.
DescribeLivePackageConfigDescribeLivePackageConfig
DeleteLivePackageConfigDeleteLivePackageConfig

Live stream moderation

APITitleDescription
AddLiveSnapshotDetectPornConfigAddLiveSnapshotDetectPornConfigAdds a video moderation configuration for live streams in an application under a domain name.
AddLiveDetectNotifyConfigAddLiveDetectNotifyConfigConfigures callbacks for video moderation results. As a result, a callback URL that is used to receive the callback notifications is added.
DescribeLiveSnapshotDetectPornConfigDescribeLiveSnapshotDetectPornConfigQueries video moderation configurations.
DescribeLiveDetectNotifyConfigDescribeLiveDetectNotifyConfigQueries the configuration of callbacks for video moderation results.
UpdateLiveSnapshotDetectPornConfigUpdateLiveSnapshotDetectPornConfigModifies a video moderation configuration.
UpdateLiveDetectNotifyConfigUpdateLiveDetectNotifyConfigModifies the configuration of callbacks for video moderation results. As a result, the callback URL that is used to receive the callback notifications is changed.
DeleteLiveSnapshotDetectPornConfigDeleteLiveSnapshotDetectPornConfigDeletes a video moderation configuration.
DeleteLiveDetectNotifyConfigDeleteLiveDetectNotifyConfigDeletes the configuration of callbacks for video moderation results.
AddLiveAudioAuditConfigAddLiveAudioAuditConfigAdds an audio moderation configuration.
AddLiveAudioAuditNotifyConfigAddLiveAudioAuditNotifyConfigConfigures callbacks for audio moderation results.
DeleteLiveAudioAuditConfigDeleteLiveAudioAuditConfigDeletes an audio moderation configuration.
DeleteLiveAudioAuditNotifyConfigDeleteLiveAudioAuditNotifyConfigDeletes the configuration of callbacks for audio moderation results.
UpdateLiveAudioAuditNotifyConfigUpdateLiveAudioAuditNotifyConfigModifies the configuration of callbacks for audio moderation results.
UpdateLiveAudioAuditConfigUpdateLiveAudioAuditConfigModifies an audio moderation configuration.
DescribeLiveAudioAuditConfigDescribeLiveAudioAuditConfigQueries audio moderation configurations.
DescribeLiveAudioAuditNotifyConfigDescribeLiveAudioAuditNotifyConfigQueries the configuration of callbacks for audio moderation results.

Global Accelerator

APITitleDescription
CreateLivePrivateLineCreateLivePrivateLineCreates a Global Accelerator (GA) instance and binds it to an acceleration circuit.
DeleteLivePrivateLineDeleteLivePrivateLineUnbinds a Global Accelerator (GA) instance from an acceleration circuit.
DescribeLivePrivateLineAreasDescribeLivePrivateLineAreasQueries available access points where acceleration circuits start.
DescribeLivePrivateLineAvailGADescribeLivePrivateLineAvailGAQueries the binding information between Global Accelerator (GA) instances and acceleration circuits.

Live streaming latency

APITitleDescription
DescribeLiveStreamDelayConfigDescribeLiveStreamDelayConfigQueries the live streaming latency.
SetLiveStreamDelayConfigSetLiveStreamDelayConfigConfigures the live streaming latency.

Resource monitoring

APITitleDescription
DescribeLiveDomainBpsDataDescribeLiveDomainBpsDataQueries the bandwidth data for one or more streaming domains.
DescribeLiveDomainTrafficDataDescribeLiveDomainTrafficDataQueries the network traffic data for one or more domain names.
DescribeLiveStreamTranscodeMetricDataDescribeLiveStreamTranscodeMetricDataQueries the transcoding data of a specified domain name at the application level and the stream level.
DescribeLiveCenterStreamRateDataDescribeLiveCenterStreamRateDataQueries the audio and video frame rates and bitrates of a stream in a live center.
DescribeLiveDomainBpsDataByLayerDescribeLiveDomainBpsDataByLayerQueries the bandwidth and traffic data by protocol for one or more domain names.
DescribeLiveDomainPushBpsDataDescribeLiveDomainPushBpsDataQueries the bandwidth data for one or more ingest domains.
DescribeLiveDomainPushTrafficDataDescribeLiveDomainPushTrafficDataQueries the network traffic data for one or more ingest domains.
DescribeLiveStreamPushMetricDetailDataDescribeLiveStreamPushMetricDetailDataQueries the stream ingest data of a specified domain name at the application level and the stream level.
DescribeLiveDomainPublishErrorCodeDescribeLiveDomainPublishErrorCodeQueries the HTTP status codes that are returned within a specified period of time under an ingest domain.
DescribeLiveUpVideoAudioInfoDescribeLiveUpVideoAudioInfoQueries the audio and video data of an ingested stream within a specific period of time.
DescribeLiveDomainRealTimeBpsDataDescribeLiveDomainRealTimeBpsDataQueries the bandwidth data that is collected every minute for one or more domain names.
DescribeLiveDomainRealTimeTrafficDataDescribeLiveDomainRealTimeTrafficDataQueries the network traffic data that is collected in real time for one or more domain names.
DescribeLiveDomainRealTimeHttpCodeDataDescribeLiveDomainRealTimeHttpCodeDataQueries the proportions of HTTP status codes returned for one or more domain names. Data is collected every minute.
DescribeLiveStreamHistoryUserNumDescribeLiveStreamHistoryUserNumQueries the number of historical online users for a live stream.
DescribeLiveStreamCountDescribeLiveStreamCountQueries the numbers of online source streams and transcoded streams.
DescribeLiveStreamTranscodeStreamNumDescribeLiveStreamTranscodeStreamNumQueries the number of transcoded streams in real time.
DescribeLiveDomainPvUvDataDescribeLiveDomainPvUvDataQueries the data of page views (PVs) and unique visitors (UVs) of a streaming domain.
DescribeLiveTopDomainsByFlowDescribeLiveTopDomainsByFlowQueries the top domain names ranked by traffic.
DescribeLiveStreamsTotalCountDescribeLiveStreamsTotalCountQueries the total number of live streams within a specified time range. Data is collected on a daily basis.
DescribeLiveStreamMetricDetailDataDescribeLiveStreamMetricDetailDataQueries the monitoring data of streams for a specified domain name. Up to 5,000 rows of data can be returned per call.
DescribeLiveStreamDetailFrameRateAndBitRateDataDescribeLiveStreamDetailFrameRateAndBitRateDataQueries the audio and video frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) stream.

Statistics-Usage

APITitleDescription
DescribeLiveDomainRecordUsageDataDescribeLiveDomainRecordUsageDataQueries the numbers of live recording channels and container format conversions.
DescribeLiveDomainSnapshotDataDescribeLiveDomainSnapshotDataQueries the number of snapshots for one or more streaming domains.
DescribeLiveDetectPornDataDescribeLiveDetectPornDataQueries the usage data of content moderation.
DescribeDomainUsageDataDescribeDomainUsageDataQueries the resource usage data of specific domain names in a specified billable region.
DescribeLivePushProxyUsageDataDescribeLivePushProxyUsageDataQueries the usage data of live center stream relay.
DescribeLiveRealtimeDeliveryAccDescribeLiveRealtimeDeliveryAccQueries the number of real-time log deliveries.
DescribeLiveDomainTimeShiftDataDescribeLiveDomainTimeShiftDataQueries the resource usage data of time shifting for one or more domain names.
DescribeLiveDomainStreamTranscodeDataDescribeLiveDomainStreamTranscodeDataQueries the transcoding length for one or more domain names.
DescribeLiveProducerUsageDataDescribeLiveProducerUsageDataQueries the production studio usage data.
DescribeLiveDomainMonitoringUsageDataDescribeLiveDomainMonitoringUsageDataQueries the live monitoring usage data for one or more domain names.
DescribeLiveDelayedStreamingUsageDescribeLiveDelayedStreamingUsageQueries the stream delay usage data.
DescribeLiveGrtnDurationDescribeLiveGrtnDurationQueries the co-streaming usage data.
DescribeMeterLiveBypassDurationDescribeMeterLiveBypassDurationDescribeMeterLiveBypassDuration
DescribeLiveDrmUsageDataDescribeLiveDrmUsageData

Production studio

APITitleDescription
Manage production studiosManage production studios
CreateCasterCreateCasterCreates a production studio.
SetCasterConfigSetCasterConfigConfigures all parameters for a production studio. If a parameter is not specified, the production studio does not have the relevant configuration.
DescribeCasterConfigDescribeCasterConfigQueries the configurations of a production studio.
DescribeCastersDescribeCastersQueries the list of production studios.
DescribeCasterStreamUrlDescribeCasterStreamUrlQueries the streaming URLs of a production studio.
CopyCasterCopyCasterDuplicates a production studio.
StartCasterStartCasterStarts 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.
StopCasterStopCasterStops a production studio. This stops the PVW and PGM scenes of the production studio.
DeleteCasterDeleteCasterDeletes a production studio.
RestartCasterRestartCasterRestarts a production studio.
Manage input sourcesManage input sources
AddCasterVideoResourceAddCasterVideoResourceAdds an input source to a production studio. The number of input sources is limited by the number of input channels of the production studio.
DeleteCasterVideoResourceDeleteCasterVideoResourceRemoves an input source from a production studio.
ModifyCasterVideoResourceModifyCasterVideoResourceChanges the video source for a production studio.
DescribeCasterVideoResourcesDescribeCasterVideoResourcesQueries the input sources of a production studio.
Manage layoutsManage layouts
AddCasterLayoutAddCasterLayoutAdds a layout for a production studio.
DeleteCasterLayoutDeleteCasterLayoutDeletes a layout in a production studio.
ModifyCasterLayoutModifyCasterLayoutModifies the layout configurations pf a production studio. You need to pass only parameters that you want to modify.
DescribeCasterLayoutsDescribeCasterLayoutsQueries a specified layout or all layouts of a production studio.
Manage componentsManage components
AddCasterComponentAddCasterComponentAdds a component to a production studio.
DeleteCasterComponentDeleteCasterComponentDeletes a component in a production studio.
ModifyCasterComponentModifyCasterComponentModifies a component of a production studio.
DescribeCasterComponentsDescribeCasterComponentsQueries the components of a production studio.
Manage scenesManage scenes
CopyCasterSceneConfigCopyCasterSceneConfigApplies the configuration of a PVW scene to a PGM scene.
DeleteCasterSceneConfigDeleteCasterSceneConfigDeletes the settings of a scene.
UpdateCasterSceneConfigUpdateCasterSceneConfigModifies a scene, including the layout, without invalidating the previous configurations. This operation is more efficient than the SetCasterSceneConfig operation.
SetCasterSceneConfigSetCasterSceneConfigConfigures all settings of a scene. This is done by clearing all previous settings of the scene and applying new settings, including the layout setting, to the scene.
DescribeCasterScenesDescribeCasterScenesQueries the scenes of a production studio.
UpdateCasterSceneAudioUpdateCasterSceneAudioModifies the audio configurations of a scene. This operation also allows you to add an audio configuration or apply an existing audio configuration to a new scene.
DescribeCasterSceneAudioDescribeCasterSceneAudioQueries the audio configurations of a scene.
StartCasterSceneStartCasterSceneStarts a specified preview (PVW) scene.
StopCasterSceneStopCasterSceneStops a specified preview (PVW) scene.
Manage channelsManage channels
SetCasterChannelSetCasterChannelConfigures a channel of a production studio.
DescribeCasterChannelsDescribeCasterChannelsQueries the channels of a production studio.
Manage the standby videoManage the standby video
EffectCasterUrgentEffectCasterUrgentSwitches a scene to the standby resource in a production studio.
EffectCasterVideoResourceEffectCasterVideoResourceUpdates the standby resource in a specified scene.
Production studio in playlist mode (new)Production studio in playlist mode (new)
AddShowIntoShowListAddShowIntoShowListAdds an episode to an episode list.
RemoveShowFromShowListRemoveShowFromShowListRemoves an episode from an episode list.
ModifyShowListModifyShowListModifies the attributes of an episode list.
DescribeShowListDescribeShowListQueries the details of the episode list.
PlayChoosenShowPlayChoosenShowSwitches to a specified episode.
InitializeAutoShowListTaskInitializeAutoShowListTaskCreates a scheduled task to start and stop the playback of a playlist at specified points in time.
DescribeAutoShowListTasksDescribeAutoShowListTasksQueries scheduled tasks that are used to start and stop playing an episode list at specified points in time.
EditShowAndReplaceEditShowAndReplaceCreates an editing task.
GetEditingJobInfoGetEditingJobInfoQueries the information about editing tasks.
SetShowListBackgroundSetShowListBackgroundConfigures the background of the episode list.
Virtual studioVirtual studio
AddStudioLayoutAddStudioLayoutConfigures a layout for a virtual studio.
DeleteStudioLayoutDeleteStudioLayoutDeletes a layout in a virtual studio.
ModifyStudioLayoutModifyStudioLayoutModifies a layout of a virtual studio.
DescribeStudioLayoutsDescribeStudioLayoutsQueries one or more layouts of a virtual studio.
Production studio in playlist mode (old)Production studio in playlist mode (old)
AddCasterEpisodeAddCasterEpisodeAdds an episode to a production studio.
DeleteCasterEpisodeDeleteCasterEpisodeDeletes an episode in a production studio.
ModifyCasterEpisodeModifyCasterEpisodeModifies the configurations of an episode in a production studio. You cannot change the episode type.
AddCasterEpisodeGroupAddCasterEpisodeGroupAdds an episode list to a production studio.
DeleteCasterEpisodeGroupDeleteCasterEpisodeGroupDeletes an episode list in a production studio.
AddCasterEpisodeGroupContentAddCasterEpisodeGroupContentAdds information about an episode list in a production studio.
AddCasterProgramAddCasterProgramAdds the episode list for carousel playback in a production studio.
DescribeCasterProgramDescribeCasterProgramQueries the information about the episode list for carousel playback in a production studio.
ModifyCasterProgramModifyCasterProgramModifies the episode list for carousel playback in a production studio.
DeleteCasterProgramDeleteCasterProgramDeletes the episode list for carousel playback in a production studio.
AddPlaylistItemsAddPlaylistItemsAdds episodes to an episode list.
DeletePlaylistItemsDeletePlaylistItemsRemoves episodes from an episode list.
ListPlaylistItemsListPlaylistItemsQueries the information about episodes in an episode list.
EditPlaylistEditPlaylistEdits an episode list.
DeletePlaylistDeletePlaylistDeletes an episode list.
ListPlaylistListPlaylistQueries the information about one or more episode lists.
StartPlaylistStartPlaylistStarts playing an episode list.
StopPlaylistStopPlaylistStops playing an episode list.

Live stream watermarks

APITitleDescription
AddLiveStreamWatermarkAddLiveStreamWatermarkCreates a watermark template.
DeleteLiveStreamWatermarkDeleteLiveStreamWatermarkDeletes a specified watermark template.
UpdateLiveStreamWatermarkUpdateLiveStreamWatermarkUpdates a watermark template.
DynamicUpdateWaterMarkStreamRuleDynamicUpdateWaterMarkStreamRuleDynamically updates a watermark.
DescribeLiveStreamWatermarksDescribeLiveStreamWatermarksQueries watermark templates.
AddLiveStreamWatermarkRuleAddLiveStreamWatermarkRuleAdds a watermark rule.
DeleteLiveStreamWatermarkRuleDeleteLiveStreamWatermarkRuleDeletes a watermark rule.
UpdateLiveStreamWatermarkRuleUpdateLiveStreamWatermarkRuleUpdates a watermark rule.
DescribeLiveStreamWatermarkRulesDescribeLiveStreamWatermarkRulesQueries watermark rules.

Edge transcoding

APITitleDescription
ListEdgeTranscodeTemplateListEdgeTranscodeTemplateQueries the list of edge transcoding templates.
GetEdgeTranscodeTemplateGetEdgeTranscodeTemplateQueries the details of an edge transcoding template.
CreateEdgeTranscodeJobCreateEdgeTranscodeJobCreates an edge transcoding task.
DeleteEdgeTranscodeJobDeleteEdgeTranscodeJobDeletes an edge transcoding task.
ListEdgeTranscodeJobListEdgeTranscodeJobQueries edge transcoding tasks.
GetEdgeTranscodeJobGetEdgeTranscodeJobQueries the details of an edge transcoding task.
UpdateEdgeTranscodeJobUpdateEdgeTranscodeJobUpdates an edge transcoding task.
StartEdgeTranscodeJobStartEdgeTranscodeJobStarts an edge transcoding task.
StopEdgeTranscodeJobStopEdgeTranscodeJobStops an edge transcoding task.

Live monitoring

APITitleDescription
CreateLiveStreamMonitorCreateLiveStreamMonitorCreates a monitoring session.
UpdateLiveStreamMonitorUpdateLiveStreamMonitorUpdates the configurations of a monitoring session.
DescribeLiveStreamMonitorListDescribeLiveStreamMonitorListQueries the list of created monitoring sessions.
StartLiveStreamMonitorStartLiveStreamMonitorStarts live monitoring.
StopLiveStreamMonitorStopLiveStreamMonitorStops live monitoring.
DeleteLiveStreamMonitorDeleteLiveStreamMonitorDeletes a monitoring session.

Interactive messaging (new)

APITitleDescription
CreateLiveMessageAppCreateLiveMessageAppCreates an interactive messaging application.
CreateLiveMessageGroupCreateLiveMessageGroupCreates an interactive messaging group.
DescribeLiveMessageGroupDescribeLiveMessageGroupQueries the information about an interactive messaging group.
ModifyLiveMessageGroupModifyLiveMessageGroupModifies the information about an interactive messaging group.
DeleteLiveMessageGroupDeleteLiveMessageGroupDeletes an interactive messaging group.
ListLiveMessageGroupsListLiveMessageGroupsQueries the interactive messaging groups in an interactive messaging application.
ListLiveMessageGroupByPageListLiveMessageGroupByPageQueries interactive messaging groups by page.
ModifyLiveMessageGroupBandModifyLiveMessageGroupBandModifies the mute status of users.
DescribeLiveMessageGroupBandDescribeLiveMessageGroupBandQueries the mute status of users.
CheckLiveMessageUsersOnlineCheckLiveMessageUsersOnlineQueries whether one or more specified users are online.
CheckLiveMessageUsersInGroupCheckLiveMessageUsersInGroupQueries whether a user is in an interactive messaging group.
ListLiveMessageGroupUsersListLiveMessageGroupUsersQueries the users in an interactive messaging group.
ListLiveMessageGroupMessagesListLiveMessageGroupMessagesQueries the messages sent in a group.
UnbanLiveMessageGroupUnbanLiveMessageGroupUnmutes a group.
RecoverLiveMessageDeletedGroupRecoverLiveMessageDeletedGroupRestores a deleted interactive messaging group.
BanLiveMessageGroupBanLiveMessageGroupMutes a group.
AddLiveMessageGroupBandAddLiveMessageGroupBandMutes one or more users.
RemoveLiveMessageGroupBandRemoveLiveMessageGroupBandUnmutes one or more users.
DeleteLiveMessageGroupMessageDeleteLiveMessageGroupMessageDeletes a message that was sent to an interactive messaging group.
DeleteLiveMessageUserMessageDeleteLiveMessageUserMessageDeletes a message that is sent to a user.
SendLiveMessageGroupSendLiveMessageGroupSends a message to a group.
SendLiveMessageUserSendLiveMessageUserSends a message to a user.
ListLiveMessageAppsListLiveMessageAppsQueries interactive messaging applications.
DescribeLiveMessageAppDescribeLiveMessageAppQuery Interactive Message App
ModifyLiveMessageAppDisableModifyLiveMessageAppDisableDisables or enables an interactive messaging application.
ModifyLiveMessageAppAuditModifyLiveMessageAppAuditModifies the content moderation settings of an interactive messaging application.
ModifyLiveMessageAppCallbackModifyLiveMessageAppCallbackModifies the callback settings of an interactive messaging application.
KickLiveMessageGroupUserKickLiveMessageGroupUserRemoves a user from an interactive messaging group.
ModifyLiveMessageUserInfoModifyLiveMessageUserInfoModifies the information about one or more users.

ApsaraVideo Real-time Communication

APITitleDescription
Channel managementChannel management
DescribeChannelParticipantsDescribeChannelParticipantsQueries online users in a channel.
DescribeChannelUsersDescribeChannelUsersQueries the details of online users in a channel.
RemoveTerminalsRemoveTerminalsRemoves users from a channel.
CreateRoomRealTimeStreamAddressCreateRoomRealTimeStreamAddressGenerates a Real-Time Messaging Protocol (RTMP) ingest URL for a channel.
DeleteChannelDeleteChannelDeletes a channel.
Stream relayStream relay
StartLiveMPUTaskStartLiveMPUTaskCreates a mixed-stream relay task.
UpdateLiveMPUTaskUpdateLiveMPUTaskUpdates a mixed-stream relay task.
StopLiveMPUTaskStopLiveMPUTaskStops a mixed-stream relay task.
ListRtcMPUTaskDetailListRtcMPUTaskDetailQueries the parameters of mixed-stream relay tasks.
SetLiveMpuTaskSeiSetLiveMpuTaskSeiConfigures custom supplemental enhancement information (SEI) for co-streaming.
Event callbacksEvent callbacks
CreateEventSubCreateEventSubCreates a callback to subscribe to channel or user events.
ListEventSubListEventSubQueries the events generated in channels to which you subscribe.
ListEventSubEventListEventSubEventQueries callback records.
UpdateEventSubUpdateEventSubUpdates a callback that is used to subscribe to channel or user events.
DeleteEventSubDeleteEventSubDeletes a callback that is used to subscribe to channel or user events.
CreateRtcMPUEventSubCreateRtcMPUEventSubCreates a subscription to mixed-stream relay events.
UpdateRtcMPUEventSubUpdateRtcMPUEventSubUpdates a subscription to mixed-stream relay events.
DeleteRtcMPUEventSubDeleteRtcMPUEventSubDeletes a subscription to mixed-stream relay events.
DescribeRtcMPUEventSubDescribeRtcMPUEventSubQueries the information about a subscription to mixed-stream relay events.
ListRtcMPUEventSubRecordListRtcMPUEventSubRecordQueries the callback records of a subscription to mixed-stream relay events.
Quality monitoringQuality monitoring
DescribeLiveInteractionMetricDataDescribeLiveInteractionMetricDataQueries the metric data of ApsaraVideo Real-time Communication (ARTC).

Live subtitles (in public preview)

APITitleDescription
DeleteLiveAIProduceRulesDeleteLiveAIProduceRulesDeletes a subtitle rule.
DescribeLiveAIProduceRulesDescribeLiveAIProduceRulesQueries subtitle rules.
UpdateLiveAIProduceRulesUpdateLiveAIProduceRulesUpdates a subtitle rule.
AddLiveAIProduceRulesAddLiveAIProduceRulesAdds a subtitle rule.
CreateLiveAIStudioCreateLiveAIStudioCreates a lightweight virtual studio template.
DeleteLiveAIStudioDeleteLiveAIStudioDeletes a virtual studio template.
ModifyLiveAIStudioModifyLiveAIStudioModifies a virtual studio template.
DescribeLiveAIStudioDescribeLiveAIStudioQueries the virtual studio templates within your Alibaba Cloud account.
AddLiveAISubtitleAddLiveAISubtitleAdds a subtitle template.
DeleteLiveAISubtitleDeleteLiveAISubtitleDeletes a specified subtitle template.
UpdateLiveAISubtitleUpdateLiveAISubtitleUpdates a subtitle template.
DescribeLiveAISubtitleDescribeLiveAISubtitleQueries subtitle templates.

Tools

APITitleDescription
DescribeLiveIpInfoDescribeLiveIpInfoChecks whether a specified IP address belongs to an Alibaba Cloud point of presence (POP).
DescribeLiveStreamAuthCheckingDescribeLiveStreamAuthCheckingQueries the authentication status of an active stream.