API standards and multilingual preset SDKs
The OpenAPI of this product (vod/2017-03-21) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Media upload
|
API |
Title |
Description |
| CreateUploadVideo | Obtain the upload URL and credential for an audio or video file | ApsaraVideo VOD issues the upload URL and upload credential to ensure authorization and security and prevent malicious uploads. During issuance, a media ID (MediaId), also called a video ID (VideoId), undergoes automatic creation for management. Invoke this operation to obtain the upload URL and upload credential, and create audio or video information. |
| RefreshUploadVideo | Refresh video upload credential | Refreshes the upload credential for a video file after the upload times out. |
| CreateUploadImage | Retrieve upload URL and credential for image upload | Retrieves the upload URL and upload credential for uploading an image to ApsaraVideo VOD, and creates image information. ApsaraVideo VOD issues upload URLs and credentials to ensure authorization and security, prevent malicious uploads, and supports automatic creation of an image ID (ImageId) for management. You can invoke this operation to obtain the upload URL and credential and create image information. |
| CreateUploadAttachedMedia | Obtain the upload URL and credential for an auxiliary media asset | The upload URL and credential are provided by ApsaraVideo VOD to address authorization and security concerns, prevent malicious uploads, and enable automatic creation of a media asset ID (MediaId) for management and processing. For auxiliary media assets such as watermarks and subtitles, invoke this operation to obtain the upload credential and create the corresponding media asset information. |
| UploadMediaByURL | Pull and upload media files by URL in batches | Pulls audio and video media files for upload based on source file URLs. Batch upload is supported. |
| GetURLUploadInfos | Retrieve URL upload information | Retrieves URL upload information. |
| CancelUrlUploadJobs | Cancel URL upload tasks | Cancels URL upload tasks that are in the queue. |
| UploadStreamByURL | Upload a transcoded stream by URL | Uploads a transcoded stream file from external storage and mounts it to the corresponding ApsaraVideo VOD media asset. |
| DeleteMultipartUpload | Delete fragment files during upload | Deletes fragment files generated during upload. |
| GetUploadDetails | Retrieve media upload details | Retrieves media upload details by media ID, such as upload time, upload ratio, and upload source. Batch retrieval is supported. |
| RegisterMedia | Register media asset information | Registers media assets. Existing media files stored in your own OSS bucket that is connected to ApsaraVideo VOD must be registered to generate the associated data required by VOD before you can use VOD features such as transcoding and snapshotting. |
Audio and video playback
|
API |
Title |
Description |
| GetPlayInfo | Retrieve audio or video playback URL | Retrieves the playback URL of an audio or video file by providing the audio or video ID, which can then be played using ApsaraVideo Player or a third-party player such as a system-native, open-source, or custom-built player. |
| GetVideoPlayAuth | Retrieve audio or video playback credential | Retrieves the playback credential (PlayAuth) for an audio or video file. ApsaraVideo Player SDK uses this credential to automatically obtain the playback URL. Because the playback credential has a validity period and is bound to a specific audio or video file, it cannot be shared or reused. An expired or invalid credential will cause playback failure. This playback method is suitable for audio and video playback scenarios that require high security. |
Media asset management
|
API |
Title |
Description |
| Media asset search | Media asset search | |
| SearchMedia | Search media information | Searches for media asset information such as videos, audio files, and images produced by ApsaraVideo VOD. You can use this operation with the media asset search protocol to perform multi-dimensional searches in ApsaraVideo VOD, including specifying return fields, exact matching, fuzzy matching, multi-value queries, range queries, and sort fields. |
| Tiered storage | Tiered storage | |
| UpdateMediaStorageClass | Modify media asset storage class | Modifies the storage class of a media asset. |
| RestoreMedia | Restore media assets | Restores media assets from frozen storage. |
| Category management | Category management | |
| AddCategory | Create a category | Creates a category to classify audio, video, image, and short video materials stored in ApsaraVideo VOD, making resource discovery and management more efficient. |
| UpdateCategory | Update a category | Updates the name of a category. |
| DeleteCategory | Delete a category | Deletes a category and its subcategories. |
| GetCategories | Query a category and its subcategories | Invokes this operation to perform a filtered query for specified categorization information by ID or type, and retrieves the list of its subcategories (next-level categories). |
| Audio and video management | Audio and video management | |
| GetVideoInfo | Retrieve information about a single audio or video file | Retrieves the information about a single audio or video file by audio or video ID, including the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags. |
| GetVideoInfos | Batch retrieve audio and video information | Retrieves the information about multiple audio and video files at a time by audio or video ID, including the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags. |
| GetVideoList | Retrieve audio and video information list | Retrieves a list of audio and video information. |
| GetMezzanineInfo | Retrieve source file information | Retrieves the source file information of an audio or video file, including the file URL, resolution, and bitrate. |
| UpdateVideoInfo | Modify single audio or video information | Modifies the information about a single audio or video file. |
| UpdateVideoInfos | Batch modify audio and video information | Modifies the information about multiple audio and video files at a time. |
| DeleteMezzanines | Batch delete audio and video source files | Deletes the source files of multiple audio and video files at a time. |
| DeleteStream | Delete media streams | Deletes media stream (video stream or audio stream) information and storage files. |
| DeleteVideo | Delete complete videos | Deletes complete videos, including video source files, transcoded stream files, and thumbnails. |
| BatchGetMediaInfos | Batch retrieve media asset information | Retrieves the basic information and source file information of multiple media assets in a batch. |
| DescribeMediaDistribution | Query media asset distribution | Queries the time-based distribution of audio and video media assets. The maximum time span between the start time and end time is six months. |
| Auxiliary media asset management | Auxiliary media asset management | |
| GetAttachedMediaInfo | Batch retrieve auxiliary media asset information | Retrieves the basic information and access URLs of multiple auxiliary media assets in a batch by specifying their IDs after the assets such as watermark images, subtitle files, and materials are uploaded to ApsaraVideo VOD. |
| UpdateAttachedMediaInfos | Batch update auxiliary media asset information | Batch updates the information of auxiliary media assets, such as title, description, tags, and category, by specifying the unique identifiers (IDs) of the auxiliary media assets that have been uploaded to ApsaraVideo VOD, including watermarked images, subtitle files, and other materials. |
| DeleteAttachedMedia | Delete auxiliary media assets in batches | Deletes one or more auxiliary media assets that have been uploaded to ApsaraVideo VOD, such as watermark images, subtitle files, and materials. |
| Image management | Image management | |
| GetImageInfo | Retrieve information about a single image | Retrieves the basic information and access URL of an image by image ID after the image is uploaded to ApsaraVideo VOD. |
| GetImageInfos | Batch retrieve image information | Queries the basic information and access URLs of multiple images by image ID after the images are uploaded to ApsaraVideo VOD. |
| UpdateImageInfos | Batch update image information | Batch modifies the title, description, tags, and category information of images by image ID after the images are uploaded to ApsaraVideo VOD. |
| ListSnapshots | Query video snapshot data | Queries snapshots generated by video snapshot jobs and thumbnail snapshots automatically generated by the system during video upload. |
| DeleteImage | Delete images or video snapshots | Deletes images uploaded by users or images generated from video snapshots. |
| Animated sticker management | Animated sticker management | |
| ListDynamicImage | Query animated image list | Queries the list of animated images for a video by video ID. |
| DeleteDynamicImage | Delete animated sticker information | Deletes animated sticker information. |
Media processing
|
API |
Title |
Description |
| Initiate processing | Initiate processing | |
| SubmitTranscodeJobs | Submit a media transcoding job | Submits a media transcoding job to start asynchronous transcoding. |
| SubmitSnapshotJob | Submit a media snapshot job | Submits a video snapshot job to start asynchronous snapshot processing. |
| SubmitPreprocessJobs | Preprocess a video for the China production studio | Transcodes a video by using a China Production Studio (China Production Studio) for preprocessing. |
| SubmitDynamicImageJob | Submit a media animated image job | Submits a media animated image job for asynchronous processing. |
| SubmitWorkflowJob | Submit a VOD workflow job | Initiates a VOD workflow for a video. |
| Transcoding templates | Transcoding templates | |
| AddTranscodeTemplateGroup | Create a transcoding template group | Adds transcoding configurations. You can create a transcoding template group or add transcoding templates to a specified template group. |
| UpdateTranscodeTemplateGroup | Modify transcoding configurations | Modifies transcoding configurations. You can modify the configuration of a specified transcoding template in a transcoding template group. |
| SetDefaultTranscodeTemplateGroup | Set default transcoding configuration | Sets the default transcoding template group configuration. |
| ListTranscodeTemplateGroup | Query transcoding configuration list | Queries the list of transcoding template configurations. |
| GetTranscodeTemplateGroup | Query transcoding configuration details | Queries the details of a transcoding configuration by transcoding template group ID. |
| DeleteTranscodeTemplateGroup | Delete transcoding configurations | Deletes transcoding configurations. You can delete specific transcoding templates from a transcoding template group or force delete an entire transcoding template group. |
| Snapshot templates | Snapshot templates | |
| AddVodTemplate | Add a snapshot or animated image template | Adds a snapshot or animated image template. |
| UpdateVodTemplate | Modify a snapshot template | Modifies a snapshot template. |
| GetVodTemplate | Query a single snapshot template | Queries a single snapshot template. |
| ListVodTemplate | Query snapshot template list | Queries the list of snapshot templates. |
| DeleteVodTemplate | Delete a snapshot template | Deletes a snapshot template. |
| Image and text watermark templates | Image and text watermark templates | |
| AddWatermark | Add an image or text watermark template | To simplify watermark task processing, ApsaraVideo VOD consolidates complex watermark parameters such as position, size, font, and color into templates, each identified by a unique watermark template ID. Calls this operation to add an image or text watermark template. |
| UpdateWatermark | Modify an image and text watermark template | Modifies the name and watermark configuration (WatermarkConfig) of an image and text watermark template that was added by calling the AddWatermark operation. |
| DeleteWatermark | Delete a watermark template | Deletes an image watermark template or text watermark template by watermark template ID. |
| SetDefaultWatermark | Set default watermark template | Sets a specified watermark template as the default watermark template. |
| GetWatermark | Query a single watermark template | Invokes this operation to query the parameter settings of a single image watermark template or text watermark template by watermark template ID, including the position, size, and display time of image watermarks, and the content, font, color, and position of text watermarks. |
| ListWatermark | Query watermark template list | Invokes this operation to query the parameter settings of all image watermark templates and text watermark templates that have been added in the current service region, including the position, size, and display time of image watermarks, and the content, font, color, position, and other parameter settings of text watermarks. |
| Transcoding tasks | Transcoding tasks | |
| GetTranscodeSummary | Query audio and video transcoding summaries | Queries video transcoding summary of one or more audio or video files by their IDs, including video transcoding status and transcoding progress. |
| ListTranscodeTask | Query transcoding task list | Queries the historical transcoding task information of an audio or video file by its ID. This operation does not return specific job details. |
| GetTranscodeTask | Query transcoding task details | Queries the details of transcoding jobs based on a transcoding task ID. |
| Task management | Task management | |
| ListJobInfo | Query task list | Queries the historical task list based on a media asset ID. |
| GetJobDetail | Get task details | Queries the details of an asynchronous task by job ID. |
| GetWorkflowTask | Query workflow task execution information | Queries the execution information of a workflow task. |
Video editing (online editing)
|
API |
Title |
Description |
| ProduceEditingProjectVideo | Produce videos | Produces one or more videos into a finished video. You can submit source videos directly through the timeline parameter, or create an online editing project first and then submit it for production. |
| Online editing project management | Online editing project management | |
| AddEditingProject | Create an online editing project | Creates an online editing project (video editing task). |
| UpdateEditingProject | Modify an online editing project | Modifies an online editing project (video editing task). |
| DeleteEditingProject | Delete an online editing project | Deletes an online editing project. |
| SetEditingProjectMaterials | Set online editing project materials | Sets the materials to be edited for an online editing project. |
| GetEditingProject | Get a single online editing project | Retrieves the details of an online editing project (video editing task). |
| GetEditingProjectMaterials | Get online editing project materials | Retrieves the list of materials to be edited in an online editing project. |
| SearchEditingProject | Search online editing projects | Searches for online editing projects (video editing lists). |
| AddEditingProjectMaterials | Add materials to an online editing project | Adds one or more materials to an online editing project. |
| DeleteEditingProjectMaterials | Delete online editing project materials | Deletes materials from an online editing project. |
Media review
|
API |
Title |
Description |
| Review settings | Review settings | |
| SetAuditSecurityIp | Set review security IP addresses | Sets the review security IP addresses. |
| ListAuditSecurityIp | Retrieve review security IP list | Retrieves the list of China Chinese review security IPs. |
| Automated review | Automated review | |
| SubmitAIMediaAuditJob | Submit an automated review job for audio and video files | Submits an automated review job for audio and video files. The job is executed asynchronously after submission, and the job may not be complete when the response is returned. |
| SubmitAIImageAuditJob | Submit an image automated review job | Submits an automated review task for an image. The task is asynchronously executed after it is submitted. The task may not be complete when the response is returned. |
| GetAIMediaAuditJob | Query an automated review job | Queries an automated review job. After you submit an AI job, the job is processed asynchronously. You can call this operation to query job information in real time. |
| GetMediaAuditResult | Retrieve automated review result summary | Retrieves the summary of automated review results. |
| GetMediaAuditResultDetail | Get automated review result details | Retrieves the details of automated review results. You can call this operation to query the details of review results in real time. |
| GetMediaAuditResultTimeline | Get automated review result timeline | Retrieves the timestamps of all screenshots that contain violations. |
| GetMediaAuditAudioResultDetail | Get audio automated review result details | Retrieves the details of audio automated review results. |
| Manual review | Manual review | |
| CreateAudit | Manual review | Submits a manual review request to review media information such as videos and audio files. |
| GetAuditHistory | Retrieve manual review history | Retrieves the history of manual review records. |
Video AI
|
API |
Title |
Description |
| AI templates | AI templates | |
| AddAITemplate | Add AI template | Adds an AI template for automated review and smart thumbnail tasks. |
| DeleteAITemplate | Delete an AI template | Deletes an AI template. |
| UpdateAITemplate | Modify an AI template | Modifies an AI template. |
| SetDefaultAITemplate | Set default AI template | Sets a default AI template. |
| GetAITemplate | Query an AI template | Queries an AI template. |
| ListAITemplate | Query AI templates | Queries the list of AI templates. |
| GetDefaultAITemplate | Query default AI template | Queries the default AI template. |
| AI jobs | AI jobs | |
| ListAIJob | Query intelligent tagging or media fingerprint jobs | Queries intelligent tagging or media fingerprint jobs. After you submit an intelligent tagging or media fingerprint job, the job is processed asynchronously. You can call this operation to query job information in real time. |
| SubmitAIJob | Submit an intelligent tagging or media fingerprint job | Submits an intelligent tagging or media fingerprint job. |
| GetMediaAiAnalysis | Retrieve video AI analysis results | Retrieves the results of video AI analysis. |
| Media fingerprint | Media fingerprint | |
| GetMediaDNAResult | Get media fingerprint results | Retrieves media fingerprint results. After a media fingerprint job is complete, you can call this operation to query the results in real time. |
| SubmitMediaDNADeleteJob | Delete a media fingerprint job | Deletes a media fingerprint job. |
| Smart tagging | Smart tagging | |
| GetAIVideoTagResult | Retrieve smart tagging results | Retrieves the results of smart tagging for a video. |
| Smart thumbnail | Smart thumbnail | |
| SubmitAIImageJob | Submit AI image task | Submits an AI image processing task. |
| GetAIImageJobs | Query AI image tasks | Queries the list of AI image processing tasks. |
| ListAIImageInfo | Query smart thumbnail information | Queries the AI image information of a specified video. |
| DeleteAIImageInfos | Delete AI image information | Deletes AI image information. |
Live to VOD
|
API |
Title |
Description |
| ListLiveRecordVideo | Retrieve live to VOD video list | Retrieves the list of Live to VOD videos. |
VOD CDN
|
API |
Title |
Description |
| Monitoring and query | Monitoring and query | |
| Resource access data | Resource access data | |
| DescribeVodDomainTrafficData | Query traffic | Invokes this operation to query the traffic data of an accelerated domain name. Compared with the DescribeVodDomainRealTimeTrafficData operation, this operation supports a longer historical data query range (up to 366 days) but provides a larger data time granularity (minimum of 5 minutes) and higher data latency. |
| DescribeVodDomainBpsData | Query bandwidth | Invokes this operation to query the bandwidth data of an accelerated domain name. Compared with the DescribeVodDomainRealTimeBpsData operation, this operation supports a longer time range for historical data queries (up to 366 days) but provides a larger data time granularity (minimum of 5 minutes) and higher data latency. |
| DescribeVodDomainBpsDataByLayer | Query bandwidth by protocol | Queries bandwidth data of accelerated domain names by protocol type. |
| DescribeVodDomainQpsData | Query QPS | Queries the queries per second (QPS) of accelerated domain names at a 5-minute granularity. Data from the last 90 days is supported. |
| DescribeVodDomainHitRateData | Query byte hit ratio | Queries the byte hit ratio (percentage of hit bytes) of an accelerated domain name. |
| DescribeVodDomainReqHitRateData | Query request hit ratio | Queries the request hit ratio (percentage of hit requests) of an accelerated domain name. |
| DescribeVodRangeDataByLocateAndIspService | Query access data by ISP and region | Queries access data for an accelerated domain name by ISP or region, including bandwidth, average response rate, page views, cache hit ratio, and request hit ratio. |
| Resource back-to-origin data | Resource back-to-origin data | |
| DescribeVodDomainSrcTrafficData | Query back-to-origin traffic | Queries the back-to-origin traffic data of accelerated domain names. |
| DescribeVodDomainSrcBpsData | Query back-to-origin bandwidth | Queries the back-to-origin bandwidth data of accelerated domain names. |
| Real-time access data | Real-time access data | |
| DescribeVodDomainRealTimeTrafficData | Query real-time traffic | Invokes this operation to query the traffic data of an accelerated domain name. Compared with the DescribeVodDomainTrafficData operation, this operation supports a smaller time granularity (minimum of 1 minute), lower data latency (minimum of 5 minutes), but a shorter historical data range (up to 186 days). |
| DescribeVodDomainRealTimeBpsData | Query real-time bandwidth | Invokes this operation to query the bandwidth data of an accelerated domain name. Compared with the DescribeVodDomainBpsData operation, this operation supports a smaller time granularity (minimum of 1 minute), lower data latency (minimum of 5 minutes), but a shorter historical data time range (up to 186 days). |
| DescribeVodDomainRealTimeHttpCodeData | Query real-time HTTP status codes | Queries the total number and proportion of HTTP status codes for an accelerated domain name. This operation supports a minimum data time granularity of 1 minute, with a data delay of at least 5 minutes, and allows you to query data from the last 186 days. |
| DescribeVodDomainRealTimeQpsData | Query real-time QPS | Invoke this operation to query the queries per second (QPS) data for access to an accelerated domain name. This operation supports a minimum data time granularity of 1 minute, with a data delay of at least 5 minutes, and allows you to query data from the last 186 days. |
| DescribeVodDomainRealTimeReqHitRateData | Query real-time request hit ratio | Queries the request hit ratio data for an accelerated domain name. The minimum time granularity for data queried by this operation is 1 minute. The data latency is at least 5 minutes. You can query data for up to the last 186 days. |
| DescribeVodDomainRealTimeByteHitRateData | Query real-time byte hit ratio | Queries the byte hit rate data of accelerated domain names. This operation supports a minimum time granularity of 1 minute, with a data delay of at least 5 minutes, and allows you to query data from the last 186 days. |
| DescribeVodDomainRealTimeDetailData | Query real-time access details | Queries real-time access data for accelerated domain names, including QPS, bandwidth, and HTTP status code data within the last 7 days. |
| Domain name management | Domain name management | |
| AddVodDomain | Add an accelerated domain name | Adds a domain name for CDN acceleration in ApsaraVideo VOD. |
| DeleteVodDomain | Delete an accelerated domain name | Deletes an accelerated domain name that has been added for ApsaraVideo VOD. |
| UpdateVodDomain | Modify an accelerated domain name | Modifies an accelerated domain name. |
| DescribeVodUserDomains | Query acceleration domain name list | Queries the list of all acceleration domain names under your account for ApsaraVideo VOD. |
| DescribeVodDomainDetail | Query domain name basic information | Retrieves the basic configuration information of a specified China domain name for video-on-demand (VOD) acceleration. |
| BatchStartVodDomain | Enable an accelerated domain name | Enables an accelerated domain name that is in the Disabled state. |
| BatchStopVodDomain | Pause an accelerated domain name | Pauses domain name acceleration. |
| Domain name verification | Domain name verification | |
| VerifyVodDomainOwner | Verify domain name ownership | Calls this operation to verify domain name ownership. |
| DescribeVodVerifyContent | Retrieve domain ownership verification content | Retrieves the domain ownership verification content. |
| Domain name configuration | Domain name configuration | |
| DeleteVodSpecificConfig | Delete domain name configurations | Deletes the configurations of a domain name for CDN acceleration in ApsaraVideo VOD. |
| SetVodDomainCertificate | Set domain certificate status and modify certificate information | Configures whether the certificate feature is enabled for a specified domain name and modifies certificate information. |
| DescribeVodDomainConfigs | Query domain name configurations | Queries domain name configurations. You can query multiple feature configurations in a single request. |
| DescribeVodCertificateList | Query certificate list | Queries the certificate list information. |
| DescribeVodDomainCertificateInfo | Query domain name certificate | Retrieves the certificate information of a specified accelerated domain name. |
| BatchSetVodDomainConfigs | Batch configure domain names | Configures multiple accelerated domain names in a batch. |
| Purge and prefetch | Purge and prefetch | |
| DescribeVodRefreshTasks | Query purge and prefetch status | Queries whether purge and prefetch tasks have taken effect. |
| DescribeVodRefreshQuota | Query purge and prefetch quota and remaining count | Queries the maximum number and remaining daily quota of URLs and directories for purge and prefetch operations. |
| PreloadVodObjectCaches | Prefetch cache | Prefetches content from the origin server to L2 Cache nodes so that the first access directly hits the cache, reducing the load on the origin server. |
| RefreshVodObjectCaches | Purge cache | Purges file content on nodes. Specifies URL content to purge on cache nodes, and supports batch URL purging. |
| RefreshMediaPlayUrls | Submit an audio or video refresh or prefetch task | Submits a refresh or prefetch task for audio or video files by audio or video ID. |
| GetMediaRefreshJobs | Query video purge or prefetch task information | Queries task information such as task status and filtering policies for a video purge or prefetch task. |
| Log management | Log management | |
| DescribeVodDomainLog | Query domain name logs | Retrieves the download URLs of raw CDN access logs for a specified domain name. |
Video security
|
API |
Title |
Description |
| HLS encryption | HLS encryption | |
| GenerateKMSDataKey | Create a KMS data key | Invokes the operation to generate a random KMS data key (DK) for ApsaraVideo VOD HLS encryption. |
| DecryptKMSDataKey | Decrypt KMS data key ciphertext | Invokes this operation to perform decryption on the CiphertextBlob in a KMS data key (DK). |
| Digital watermarking | Digital watermarking | |
| SubmitDigitalWatermarkExtractJob | Submit a digital watermark extraction job | Submits a digital watermarking (copyright watermark or tracing watermark) extraction job to asynchronously extract a copyright watermark or tracing watermark. |
| GetDigitalWatermarkExtractResult | Query digital watermark extraction job | Queries the results of a digital watermarking (copyright watermark or tracing watermark) extraction job, including the job status and the successfully extracted watermark text. |
| Secure download (cache) | Secure download (cache) | |
| GenerateDownloadSecretKey | Generate a secure download key | Generates a key for secure download. The secure download feature of ApsaraVideo Player SDK encrypts videos downloaded to local devices by using a key file. The encrypted videos can only be decrypted and played by using the key file generated by the unique app that is bindable in advance. This effectively protects video content and prevents downloaded videos from being maliciously played or distributed. |
Data statistics
|
API |
Title |
Description |
| Usage data | Usage data | |
| DescribeVodDomainUsageData | Query traffic and bandwidth usage | Queries acceleration traffic or bandwidth usage data. |
| DescribeVodStorageData | Query storage usage | Queries the usage of media asset management, including storage space and outbound storage traffic. |
| DescribeVodTranscodeData | Query transcoding usage data | Queries transcoding usage data. |
| DescribeVodAIData | Query AI processing usage data | Queries usage data of AI processing services such as automated review and media fingerprint. |
| DescribeVodTieringStorageData | Query tiered storage usage | Queries the usage of tiered storage for media asset management. |
| DescribeVodTieringStorageRetrievalData | Query tiered storage retrieval data | Queries the retrieval data usage of tiered storage in media asset management. |
| Playback quality (QOS/QOE) | Playback quality (QOS/QOE) | |
| DescribeVodPlayerMetricData | Query player playback data | Queries player metric data. |
| DescribeVodPlayerCollectData | Query player playback aggregated data | Queries aggregated playback data of the player. |
| DescribeVodPlayerDimensionData | Query player dimension metadata | Queries the dimension metadata of the player. |
| Playback data (new) | Playback data (new) | |
| GetDailyPlayRegionStatis | Query traffic data statistics by audio and video ID | Retrieves the full traffic data of media assets for a specified date and region. The data is generated based on CDN traffic logs and primarily reflects the traffic consumption of videos. The generated CSV file contains the following information: date, video ID, domain name, traffic, application ID, and category ID. You can download the file to your local machine for scenarios such as operational data analytics. |
| DescribeVodMediaPlayData | Query audio and video playback statistics | Retrieves playback data of an audio or video file on a specified date by media ID (audio or video ID), including the number of unique visitors, average plays per user, total plays, average play duration per user, and total play duration. |
| Playback data (legacy) | Playback data (legacy) | |
| DescribePlayTopVideos | Query top video playback statistics | Retrieves daily playback statistics for top videos, including the number of views, unique viewers, and total playback duration. |
| DescribePlayUserAvg | Query average playback statistics | Retrieves daily average playback statistics for a specified time range, including average playback duration and average playback count. |
| DescribePlayUserTotal | Query total playback statistics | Retrieves the total daily playback statistics within a specified time range, including total play count, total unique viewers, total playback duration, and playback duration distribution. |
| DescribePlayVideoStatis | Query playback statistics for a single video | Queries the daily playback statistics of a specified video within a specified time range. The statistics include total playback duration, number of playbacks, number of unique viewers, and playback duration distribution. |
Multi-application system
|
API |
Title |
Description |
| Application management | Application management | |
| CreateAppInfo | Create an application | Creates an application. |
| DeleteAppInfo | Delete an application | Deletes application information. |
| UpdateAppInfo | Update application information | Updates application information. |
| GetAppInfos | Query application information | Queries application information by application ID. |
| ListAppInfo | Query application information list | Queries a list of applications that you are authorized to access based on specified filter conditions. |
| AddVodStorageForApp | Bind storage to a sub-application | Binds a storage bucket to a sub-application of ApsaraVideo VOD. |
| Authorization management | Authorization management | |
| AttachAppPolicyToIdentity | Attach application authorization to an identity entity | Invokes this operation to attach access permissions of an ApsaraVideo VOD application to a specified identity (Resource Access Management (RAM) user or RAM role). |
| DetachAppPolicyFromIdentity | Revoke application permissions from an identity entity | Invokes this operation to revoke application authorization from a specified account identity (Resource Access Management (RAM) user or RAM role). |
| ListAppPoliciesForIdentity | List application permissions granted to an identity entity | Invokes this operation to list the application permissions granted to a specified account identity (Resource Access Management (RAM) user or RAM role). |
| Resource migration | Resource migration | |
| MoveAppResource | Migrate resources to a new application | Invokes this operation to migrate resources such as media assets from one application to another. Application administrators can directly transfer resources. Resource Access Management (RAM) users or RAM roles must have write permissions on both the source and destination applications. Batch migration is supported. |
| Playback key | Playback key | |
| GetAppPlayKey | Retrieve application playback key | Retrieves the playback key of an application. |
| SetAppPlayKey | Set application playback key | Sets the playback key for an application. |
Global configuration
|
API |
Title |
Description |
| Storage management | Storage management | |
| SetCrossdomainContent | Update cross-domain file | Updates the content of the cross-domain file crossdomain.xml for ApsaraVideo VOD. |
| Event notification | Event notification | |
| DeleteMessageCallback | Delete event notification configuration | Deletes the callback method, callback URL, and event types of an event notification. |
| SetMessageCallback | Set event notification configurations | Sets the callback method, callback URL, and event types for event notifications. |
| GetMessageCallback | Query event notification configurations | Queries the callback method, callback URL, and event types of event notifications. |
Others
|
API |
Title |
Description |
| ChangeResourceGroup | Transfer a resource to another resource group | Transfers a resource to a different resource group. |
| DescribeVodDomainMax95BpsData | Query 95th percentile bandwidth | Queries the 95th percentile bandwidth monitoring data for accelerated domain names. |
| DescribeVodSSLCertificateList | Query certificate list by domain name | Queries certificate list information by domain name. |
| SetVodDomainSSLCertificate | Set VOD domain certificate | Sets whether the certificate feature is enabled for a specified domain name and updates the certificate information. |
| DescribeVodEditingUsageData | Query online editing usage data | Queries the usage data of online editing in ApsaraVideo VOD. |
| DescribeVodUserVipsByDomain | Query node IP list - L1 | Queries the IP list of a domain name. |