API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (vod/2017-03-21) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Audio and video playback
|
API |
Title |
Description |
| GetPlayInfo | GetPlayInfo | Obtains the playback URL by the audio or video ID. Then, you can use ApsaraVideo Player or a third-party player, such as a system player, open source player, orself-developed player, to play the audio or video. |
| GetVideoPlayAuth | GetVideoPlayAuth | Queries the credential required for media playback. ApsaraVideo Player SDK automatically obtains the playback URL based on the playback credential. Each playback credential can be used to obtain the playback URL only for a specific video in a specific period of time. You cannot obtain the playback URL if the credential expires or is incorrect. You can use PlayAuth-based playback when you require high security for audio and video playback. |
Media processing
|
API |
Title |
Description |
| Process initiation | Process initiation | |
| SubmitTranscodeJobs | SubmitTranscodeJobs | Submits a transcoding job to start transcoding in an asynchronous manner. |
| SubmitSnapshotJob | SubmitSnapshotJob | Submits a snapshot job for a video and starts asynchronous snapshot processing. |
| SubmitPreprocessJobs | SubmitPreprocessJobs | Transcodes a video by using the production studio. |
| SubmitDynamicImageJob | SubmitDynamicImageJob | Submits a frame animation job and starts asynchronous processing. |
| SubmitWorkflowJob | SubmitWorkflowJob | Initiates a workflow to process media files. |
| Transcoding template | Transcoding template | |
| AddTranscodeTemplateGroup | AddTranscodeTemplateGroup | Creates a transcoding template group or adds transcoding templates to a transcoding template group. |
| UpdateTranscodeTemplateGroup | UpdateTranscodeTemplateGroup | Modifies the configurations of a transcoding template group or configurations of transcoding templates within the transcoding template group. |
| SetDefaultTranscodeTemplateGroup | SetDefaultTranscodeTemplateGroup | Specifies a transcoding template group as the default one. |
| ListTranscodeTemplateGroup | ListTranscodeTemplateGroup | Queries transcoding template groups. |
| GetTranscodeTemplateGroup | GetTranscodeTemplateGroup | Queries the details of a transcoding template group based on the template group ID. |
| DeleteTranscodeTemplateGroup | DeleteTranscodeTemplateGroup | Deletes one or more transcoding templates from a transcoding template group or forcibly deletes a transcoding template group. |
| Snapshot template | Snapshot template | |
| AddVodTemplate | AddVodTemplate | Adds a snapshot template or frame animation template. |
| UpdateVodTemplate | UpdateVodTemplate | Modifies a snapshot template. |
| GetVodTemplate | GetVodTemplate | Queries details of a snapshot template. |
| ListVodTemplate | ListVodTemplate | Lists the available snapshot templates. |
| DeleteVodTemplate | DeleteVodTemplate | Deletes a snapshot template. |
| Video watermark | Video watermark | |
| AddWatermark | AddWatermark | Creates an image or text watermark template. ApsaraVideo VOD allows you to create watermark templates to reuse your parameter configurations such as watermark position, size, font, and color. Each watermark template is assigned a unique ID. This simplifies the processing of watermark tasks. |
| UpdateWatermark | UpdateWatermark | Modifies the name and configurations of a watermark template after you create a watermark template. |
| DeleteWatermark | DeleteWatermark | Deletes an image watermark or text watermark template. |
| SetDefaultWatermark | SetDefaultWatermark | Sets a watermark template as the default one. |
| GetWatermark | GetWatermark | Queries the configurations of an image or text watermark template based on tits ID. You can call this operation to obtain information such as the position, size, and display time of an image watermark or the content, position, font, and font color of a text watermark. |
| ListWatermark | ListWatermark | Queries the configuration information about all image and text watermark templates in a region. You can call this operation to obtain information such as the position, size, and display time of image watermarks or the content, position, font, and font color of text watermarks. |
| Transcoding task | Transcoding task | |
| GetTranscodeSummary | GetTranscodeSummary | Queries transcoding summaries of audio and video files based on the file ID. A transcoding summary includes the status and progress of transcoding. |
| ListTranscodeTask | ListTranscodeTask | Queries transcoding tasks based on the media ID. This operation does not return specific job information. |
| GetTranscodeTask | GetTranscodeTask | Queries details about transcoding jobs based on the transcoding task ID. |
Online editing
|
API |
Title |
Description |
| ProduceEditingProjectVideo | ProduceEditingProjectVideo | Produces a video from one or more source files. You can directly specify source files by configuring the Timeline parameter. Alternatively, you can specify source files after you create an online editing project. |
Media review
|
API |
Title |
Description |
| Review settings | Review settings | |
| SetAuditSecurityIp | SetAuditSecurityIp | Sets IP addresses in review security groups. |
| ListAuditSecurityIp | ListAuditSecurityIp | Queries the IP addresses in a security group. |
| Automated review | Automated review | |
| SubmitAIMediaAuditJob | SubmitAIMediaAuditJob | Submits an automated review job for a media file. After the job is submitted, ApsaraVideo VOD asynchronously processes the job. Therefore, the operation may return a response before the job is complete. |
| SubmitAIImageAuditJob | SubmitAIImageAuditJob | Submits an automated review job for an image. After the job is submitted, the job is processed in an asynchronous manner. The operation may return a response before the job is complete. |
| GetAIMediaAuditJob | GetAIMediaAuditJob | Queries the information about an intelligent review job. After the job is submitted, it is processed asynchronously. You can call this operation to query the job information in real time. |
| GetMediaAuditResult | GetMediaAuditResult | Queries the summary of automated review results. |
| GetMediaAuditResultDetail | GetMediaAuditResultDetail | Queries the details of automated review results. You can call this operation to query the details of review results in real time. |
| GetMediaAuditResultTimeline | GetMediaAuditResultTimeline | Queries the timelines of all snapshots that violate content regulations. |
| GetMediaAuditAudioResultDetail | GetMediaAuditAudioResultDetail | You can call this operation to retrieve the details of an audio audit. |
| Manual review | Manual review | |
| CreateAudit | CreateAudit | Performs manual review on media files, such as audio and video files. |
| GetAuditHistory | GetAuditHistory | Queries the manual review history. |
Video AI
|
API |
Title |
Description |
| AI templates | AI templates | |
| AddAITemplate | AddAITemplate | Call this operation to add an AI template for automated review and intelligent thumbnail tasks. |
| DeleteAITemplate | DeleteAITemplate | Deletes an AI template. |
| UpdateAITemplate | UpdateAITemplate | Modifies an AI template. |
| SetDefaultAITemplate | SetDefaultAITemplate | Specifies an AI template as the default template. |
| GetAITemplate | GetAITemplate | Queries AI templates. |
| ListAITemplate | ListAITemplate | Queries AI templates. |
| GetDefaultAITemplate | GetDefaultAITemplate | Queries the default AI template. |
| AI jobs | AI jobs | |
| ListAIJob | ListAIJob | Queries a smart tagging or video fingerprinting job. After you submit a smart tagging or video fingerprinting job, ApsaraVideo VOD asynchronously processes the job. You can call this operation to query the job information in real time. |
| SubmitAIJob | SubmitAIJob | Submits a smart tagging or video fingerprinting job. |
| Video DNA | Video DNA | |
| GetMediaDNAResult | GetMediaDNAResult | Queries the results of video fingerprinting jobs. After a media fingerprinting job is complete, you can call this operation to query the media fingerprinting result. |
| SubmitMediaDNADeleteJob | SubmitMediaDNADeleteJob | Deletes a video fingerprinting job. |
| Smart tagging | Smart tagging | |
| GetAIVideoTagResult | GetAIVideoTagResult | Queries the results of smart tagging jobs. |
| Smart thumbnail | Smart thumbnail | |
| SubmitAIImageJob | SubmitAIImageJob | Submits jobs of image AI processing. |
| GetAIImageJobs | GetAIImageJobs | Queries jobs of image AI processing. |
| ListAIImageInfo | ListAIImageInfo | Queries the AI processing results about the images of a specified video. |
| DeleteAIImageInfos | DeleteAIImageInfos | Deletes the information about one or more images that are submitted for AI processing. |
Live to VOD
|
API |
Title |
Description |
| ListLiveRecordVideo | ListLiveRecordVideo | Queries live-to-VOD videos. |
CDN for ApsaraVideo VOD
|
API |
Title |
Description |
| Data monitoring | Data monitoring | |
| Request statistics | Request statistics | |
| DescribeVodDomainTrafficData | DescribeVodDomainTrafficData | You can call this operation to query traffic data for accelerated domain names. Compared to the DescribeVodDomainRealTimeTrafficData operation, this operation supports queries for historical data over a longer time range. You can query data from the last 366 days. However, this operation has a larger time granularity, with a minimum of 5 minutes, and higher data latency. |
| DescribeVodDomainBpsData | DescribeVodDomainBpsData | Queries the bandwidth for one or more specified domain names for CDN. |
| DescribeVodDomainBpsDataByLayer | DescribeVodDomainBpsDataByLayer | Queries the bandwidth data for one or more accelerated domain names by the protocol type. |
| DescribeVodDomainQpsData | DescribeVodDomainQpsData | Queries the number of queries per second (QPS) for one or more accelerated domain names. Data is collected every 5 minutes. You can query data collected in the last 90 days. |
| DescribeVodDomainHitRateData | DescribeVodDomainHitRateData | Queries the byte hit ratios of accelerated domain names. Byte hit ratios are measured in percentage. |
| DescribeVodDomainReqHitRateData | DescribeVodDomainReqHitRateData | Queries the byte hit ratio for one or more accelerated domains. Request hit ratios are measured in percentage. |
| DescribeVodRangeDataByLocateAndIspService | DescribeVodRangeDataByLocateAndIspService | Queries the bandwidth data by Internet service provider (ISP) and region. |
| Back-to-origin statistics | Back-to-origin statistics | |
| DescribeVodDomainSrcTrafficData | DescribeVodDomainSrcTrafficData | Queries origin traffic data for accelerated domain names in ApsaraVideo VOD. The traffic is measured in bytes. |
| DescribeVodDomainSrcBpsData | DescribeVodDomainSrcBpsData | Queries the bandwidth data during back-to-origin routing for one or more accelerated domain names. |
| Real-time statistics | Real-time statistics | |
| DescribeVodDomainRealTimeTrafficData | DescribeVodDomainRealTimeTrafficData | Queries the traffic data for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. Compared with the DescribeVodDomainTrafficData operation, this operation provides a smaller time granularity, lower data latency, and allows you to query historical data within a shorter time period. |
| DescribeVodDomainRealTimeBpsData | DescribeVodDomainRealTimeBpsData | Queries the bandwidth data for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. Compared with the DescribeVodDomainBpsData operation, this operation provides a smaller time granularity, lower data latency, and allows you to query historical data within a shorter time period. |
| DescribeVodDomainRealTimeHttpCodeData | DescribeVodDomainRealTimeHttpCodeData | Queries the total number of HTTP status codes and proportion of each HTTP status code for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. |
| DescribeVodDomainRealTimeQpsData | DescribeVodDomainRealTimeQpsData | Queries the number of queries per second (QPS) for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. |
| DescribeVodDomainRealTimeReqHitRateData | DescribeVodDomainRealTimeReqHitRateData | Queries the request hit ratio data for one or more accelerated domain names. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. |
| DescribeVodDomainRealTimeByteHitRateData | DescribeVodDomainRealTimeByteHitRateData | You can call this operation to query the byte hit ratio of accelerated domain names. The minimum time granularity for a query is 1 minute, and the data has a latency of at least 5 minutes. You can query data from the last 186 days. |
| DescribeVodDomainRealTimeDetailData | DescribeVodDomainRealTimeDetailData | Queries real-time monitoring data of one or more accelerated domain names. |
| Domain name management | Domain name management | |
| AddVodDomain | AddVodDomain | Adds a domain name to accelerate in ApsaraVideo VOD. |
| DeleteVodDomain | DeleteVodDomain | Removes a domain name for CDN from ApsaraVideo VOD. |
| UpdateVodDomain | UpdateVodDomain | Modifies a specific accelerated domain name. |
| DescribeVodUserDomains | DescribeVodUserDomains | Queries the domain names for CDN within your Alibaba Cloud account. |
| DescribeVodDomainDetail | DescribeVodDomainDetail | Queries the basic information about a specified domain name for CDN. |
| BatchStartVodDomain | BatchStartVodDomain | Enables accelerated domain names that are in the disabled state. |
| BatchStopVodDomain | BatchStopVodDomain | Disables accelerated domain names. |
| Domain name verification | Domain name verification | |
| VerifyVodDomainOwner | VerifyVodDomainOwner | Verifies the ownership of a specified domain name. |
| DescribeVodVerifyContent | DescribeVodVerifyContent | Queries the ownership verification content. |
| Domain name configurations | Domain name configurations | |
| DeleteVodSpecificConfig | DeleteVodSpecificConfig | Deletes the configurations of a domain name for CDN. |
| SetVodDomainCertificate | SetVodDomainCertificate | Enables or disables the certificate of a domain name and modifies the certificate information. |
| DescribeVodDomainConfigs | DescribeVodDomainConfigs | You can call this operation to query the configurations of a domain name. You can query the configurations of multiple features at the same time. |
| DescribeVodCertificateList | DescribeVodCertificateList | Queries the certificates of a specified domain name for CDN or all the domain names for CDN within your Alibaba Cloud account. |
| DescribeVodDomainCertificateInfo | DescribeVodDomainCertificateInfo | Queries the certificate information about an accelerated domain name. |
| BatchSetVodDomainConfigs | BatchSetVodDomainConfigs | Configures one or more domain names for CDN. |
| Refresh and prefetch | Refresh and prefetch | |
| DescribeVodRefreshTasks | DescribeVodRefreshTasks | Queries the information about one or more refresh or prefetch tasks. |
| DescribeVodRefreshQuota | DescribeVodRefreshQuota | Queries the maximum number and remaining number of requests to refresh or prefetch files on the current day. You can prefetch files based on URLs and refresh files based on URLs or directories. |
| PreloadVodObjectCaches | PreloadVodObjectCaches | Prefetches resources from an origin server to L2 nodes. Users can directly hit the cache upon their first visits. This way, workloads on the origin server can be reduced. |
| RefreshVodObjectCaches | RefreshVodObjectCaches | Refreshes files on Alibaba Cloud CDN nodes. You can refresh multiple files at a time based on URLs. |
| RefreshMediaPlayUrls | RefreshMediaPlayUrls | Submits media refresh or prefetch tasks based on the media IDs. |
| GetMediaRefreshJobs | GetMediaRefreshJobs | Queries the information about media refresh or prefetch jobs, such as the job status and filtering conditions. |
| Log management | Log management | |
| DescribeVodDomainLog | DescribeVodDomainLog | Queries the information about the CDN access logs for a domain name, including the log path. |
Video security
|
API |
Title |
Description |
| HLS encryption | HLS encryption | |
| GenerateKMSDataKey | GenerateKMSDataKey | Generates a random Key Management Service (KMS) data key used for HLS encryption in ApsaraVideo VOD. |
| DecryptKMSDataKey | DecryptKMSDataKey | Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key. |
| Secure download and caching | Secure download and caching | |
| GenerateDownloadSecretKey | GenerateDownloadSecretKey | Generates a key for secure download. ApsaraVideo Player SDK provides the secure download feature. Videos that are downloaded to your local device in this mode are encrypted. You can play the encrypted videos only by using the key file generated from the app that you specified. Secure download protects your videos from malicious playback or distribution. |
Data statistics
|
API |
Title |
Description |
| Resource usage | Resource usage | |
| DescribeVodDomainUsageData | DescribeVodDomainUsageData | Queries the traffic or bandwidth data of one or more accelerated domain names. |
| DescribeVodStorageData | DescribeVodStorageData | Queries the usage of storage-related resources, including the storage volume and outbound traffic. |
| DescribeVodTranscodeData | DescribeVodTranscodeData | Queries the transcoding statistics. |
| DescribeVodAIData | DescribeVodAIData | Queries the statistics on video AI of different types, such as automated review and media fingerprinting. |
| DescribeVodTieringStorageData | DescribeVodTieringStorageData | Queries the usage of tiered storage for media assets. |
| DescribeVodTieringStorageRetrievalData | DescribeVodTieringStorageRetrievalData | Queries the retrieval data usage for tiered storage in media asset management. |
| Playback quality (QoS/QoE) | Playback quality (QoS/QoE) | |
| DescribeVodPlayerMetricData | DescribeVodPlayerMetricData | Queries player metric data. |
| DescribeVodPlayerCollectData | DescribeVodPlayerCollectData | Queries the summary of player playback data. |
| DescribeVodPlayerDimensionData | DescribeVodPlayerDimensionData | Queries the metadata of player dimensions. |
| Playback statistics (new) | Playback statistics (new) | |
| GetDailyPlayRegionStatis | GetDailyPlayRegionStatis | This operation retrieves the traffic data for all media assets in a specified region on a specific date. The data is generated from CDN Traffic Logs and represents the traffic consumed by videos. The resulting CSV file contains information such as the date, video ID, domain name, traffic, application ID, and category ID. You can download this file for use in scenarios such as data analytics. |
| DescribeVodMediaPlayData | DescribeVodMediaPlayData | Retrieves playback data for an audio or video file on a specified date using its media ID. The data includes the number of unique visitors, average playback count per user, total playback count, average playback duration per user, and total playback duration. |
| Playback statistics (old) | Playback statistics (old) | |
| DescribePlayTopVideos | DescribePlayTopVideos | Call this operation to obtain daily playback statistics for top videos. The statistics include view counts, unique visitors (UVs), and total playback duration. |
| DescribePlayUserAvg | DescribePlayUserAvg | Queries the statistics on average playback each day in a specified time range. |
| DescribePlayUserTotal | DescribePlayUserTotal | Queries the daily playback statistics in a specified time range. The playback statistics include the total number of views, total number of viewers, total playback duration, and playback duration distribution. |
| DescribePlayVideoStatis | DescribePlayVideoStatis | Queries daily playback statistics on a video in the specified time range. |
Multi-application service
|
API |
Title |
Description |
| Application management | Application management | |
| CreateAppInfo | CreateAppInfo | Creates an application. |
| DeleteAppInfo | DeleteAppInfo | Deletes the information about applications. |
| UpdateAppInfo | UpdateAppInfo | Updates the information about an application. |
| GetAppInfos | GetAppInfos | Queries the information about one or more applications based on application IDs. |
| ListAppInfo | ListAppInfo | Queries the applications that you are authorized to manage based on query conditions. |
| AddVodStorageForApp | AddVodStorageForApp | Binds a storage bucket to one or more applications in ApsaraVideo VOD. |
| Authorization management | Authorization management | |
| AttachAppPolicyToIdentity | AttachAppPolicyToIdentity | Grants a RAM user or RAM role permissions to access ApsaraVideo VOD applications. |
| DetachAppPolicyFromIdentity | DetachAppPolicyFromIdentity | Revokes application permissions from the specified identity. The identity may a RAM user or RAM role. |
| ListAppPoliciesForIdentity | ListAppPoliciesForIdentity | Queries the application policies that are attached to the specified identity. The identity may be a RAM user or RAM role. |
| Resource migration | Resource migration | |
| MoveAppResource | MoveAppResource | Migrates resources between applications. The application administrator can directly migrate resources between applications. Resource Access Management (RAM) users or RAM roles must obtain the write permissions on the source and destination applications before they migrate resources between applications. Multiple resources can be migrated at a time. |
Other
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Transfers a resource to a specified resource group. |
| DescribeVodDomainMax95BpsData | DescribeVodDomainMax95BpsData | Queries the 95th percentile bandwidth data of an accelerated domain name. |
| DescribeVodSSLCertificateList | DescribeVodSSLCertificateList | You can call this operation to query a list of certificates for a domain name. |
| SetVodDomainSSLCertificate | SetVodDomainSSLCertificate | This operation enables or disables the SSL certificate feature for a domain name and updates certificate information. |
| DescribeVodEditingUsageData | DescribeVodEditingUsageData | Calls DescribeVodEditingUsageData to query the usage of video-on-demand online editing. |
| DescribeVodUserVipsByDomain | DescribeVodUserVipsByDomain | Queries the IP addresses for a domain name. |
Others
|
API |
Title |
Description |
| AddCategory | AddCategory | Creates a category to classify media assets that are stored in ApsaraVideo VOD. This helps you query and manage resources in a more efficient and convenient way. |
| AddEditingProject | AddEditingProject | Call this operation to create an online editing project (video editing task). |
| AddEditingProjectMaterials | AddEditingProjectMaterials | Adds one or more materials to an editing project. |
| BatchGetMediaInfos | BatchGetMediaInfos | Obtains the basic information and source file information of multiple media assets. |
| CancelUrlUploadJobs | CancelUrlUploadJobs | Cancels URL-based upload jobs in the queue. |
| CreateUploadAttachedMedia | CreateUploadAttachedMedia | Obtain an upload credential and create auxiliary media assets, such as watermarks and subtitles. The upload URL and credential are provided by ApsaraVideo VOD to resolve authorization and security issues, prevent malicious uploads, and automatically create media IDs (Mediaid) for management and processing. |
| CreateUploadImage | CreateUploadImage | ApsaraVideo VOD returns the upload URL and credential to ensure authorization and security, prevent malicious uploads, and automatically create an image ID for management. Obtains an upload URL and an upload credential for uploading an audio or video file and generates the audio or video ID. |
| CreateUploadVideo | CreateUploadVideo | Obtains an upload URL and an upload credential for uploading an audio or video file and generates the audio or video ID. ApsaraVideo VOD issues upload URLs and credentials to perform authorization and ensure security. This prevents unauthorized users from uploading media files. ApsaraVideo VOD generates media IDs, video IDs, and image IDs together with upload URLs and credentials. Media IDs are used in lifecycle management and media processing. |
| DeleteAttachedMedia | DeleteAttachedMedia | Deletes auxiliary media assets from ApsaraVideo VOD. You can delete one or more auxiliary media assets such as watermark images, subtitle files, and materials in a batch. |
| DeleteCategory | DeleteCategory | Deletes a category and its subcategories. |
| DeleteDynamicImage | DeleteDynamicImage | Deletes the information about animated stickers. |
| DeleteEditingProject | DeleteEditingProject | Deletes online editing projects. |
| DeleteEditingProjectMaterials | DeleteEditingProjectMaterials | Deletes the materials to be edited for an online editing project. |
| DeleteImage | DeleteImage | Deletes uploaded images and video snapshots that are automatically captured. |
| DeleteMessageCallback | DeleteMessageCallback | Deletes the callback method, callback URL, and event type of an event notification. |
| DeleteMezzanines | DeleteMezzanines | Deletes one or more source files at a time. |
| DeleteMultipartUpload | DeleteMultipartUpload | Deletes the parts generated during an upload. |
| DeleteStream | DeleteStream | Deletes media streams such as video or audio streams and their storage files. |
| DeleteVideo | DeleteVideo | Deletes one or more videos at a time, including their mezzanine files, transcoded stream files, and thumbnail snapshots. |
| DescribeMediaDistribution | DescribeMediaDistribution | Queries the distribution of media asset data by time. The maximum time range to query is 6 months. |
| GetAttachedMediaInfo | GetAttachedMediaInfo | Queries the URL and basic information about one or more auxiliary media assets such as watermark images, subtitle files, and materials based on IDs. |
| GetCategories | GetCategories | Queries the information about a specific category and its subcategories based on the ID or type of the category. |
| GetDigitalWatermarkExtractResult | GetDigitalWatermarkExtractResult | Queries the results of a digital watermark extraction job. You can call this operation to obtain information such as the job status and the content of the copyright or user-tracing watermark. |
| GetEditingProject | GetEditingProject | Queries the details of an online editing project. |
| GetEditingProjectMaterials | GetEditingProjectMaterials | Queries materials that are waiting to be edited in an online editing project. |
| GetImageInfo | GetImageInfo | Queries the basic information and URL of an image based on the image ID after you upload the image to ApsaraVideo VOD. |
| GetImageInfos | GetImageInfos | Queries the basic information about multiple images at a time. |
| GetJobDetail | GetJobDetail | You can call this operation to query the details of an asynchronous task by its job ID. |
| GetMessageCallback | GetMessageCallback | Queries the callback method, callback URL, and event type of an event notification. |
| GetMezzanineInfo | GetMezzanineInfo | Queries the information about the mezzanine file of an audio or video. The information includes the mezzanine file URL, resolution, and bitrate of the audio or video. |
| GetURLUploadInfos | GetURLUploadInfos | Queries the information about URL-based upload jobs. |
| GetUploadDetails | GetUploadDetails | Queries the upload details, such as the upload time, upload ratio, and upload source, about one or more media files based on the media IDs. |
| GetVideoInfo | GetVideoInfo | Obtains the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags of a media file based on the file ID. |
| GetVideoInfos | GetVideoInfos | Queries information such as the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags about multiple audio or video files based on IDs. |
| GetVideoList | GetVideoList | Retrieves a list of video information. |
| ListDynamicImage | ListDynamicImage | Queries the information about animated images of a video based on the video ID. |
| ListJobInfo | ListJobInfo | Queries historical tasks based on the media asset ID. |
| ListSnapshots | ListSnapshots | Queries snapshots that were captured by submitting snapshot jobs or the thumbnail that was generated by the system when you uploaded a video. |
| RefreshUploadVideo | RefreshUploadVideo | Refreshes the upload credential for a video file after the upload times out. |
| RegisterMedia | RegisterMedia | Register existing media files from your Object Storage Service (OSS) buckets with ApsaraVideo VOD. This registration is required to generate the data that VOD uses to manage the files. After registration, you can use VOD features such as transcoding and thumbnail capture on the media files. |
| RestoreMedia | RestoreMedia | Restores media assets. |
| SearchEditingProject | SearchEditingProject | Queries online editing projects. |
| SearchMedia | SearchMedia | This operation searches for media assets, such as videos, audio files, and images, in ApsaraVideo VOD. You can call this operation and use the media search protocol to perform multi-dimensional searches. You can also specify which fields to return, use exact or fuzzy matching, perform multi-value or range queries, and sort the results. |
| SetCrossdomainContent | SetCrossdomainContent | Updates the cross-domain policy file crossdomain.xml. |
| SetEditingProjectMaterials | SetEditingProjectMaterials | Specifies the media assets that you want to edit in an online editing project. |
| SetMessageCallback | SetMessageCallback | You can call this operation to set the callback method, webhook address, and event type for event notifications. |
| SubmitDigitalWatermarkExtractJob | SubmitDigitalWatermarkExtractJob | Call this operation to submit a job to asynchronously extract a digital watermark. The watermark can be a copyright watermark or a tracing watermark. |
| UpdateAttachedMediaInfos | UpdateAttachedMediaInfos | Modifies the information about multiple auxiliary media assets at a time. After you upload auxiliary media assets, such as images that contain watermarks, subtitle files, or other materials, to ApsaraVideo VOD, you can call this operation to update their titles, descriptions, tags, and categories at a time based on the unique identifiers (IDs) of the auxiliary media assets. |
| UpdateCategory | UpdateCategory | Updates the category name. |
| UpdateEditingProject | UpdateEditingProject | Modifies an online editing project. |
| UpdateImageInfos | UpdateImageInfos | Modifies the information about multiple images at a time. After you upload images to ApsaraVideo VOD, you can call this operation to update their titles, descriptions, tags, and categories at a time based on the IDs of the images. |
| UpdateMediaStorageClass | UpdateMediaStorageClass | Modifies the storage classes of media assets. |
| UpdateVideoInfo | UpdateVideoInfo | Modifies the information about an audio or video file. |
| UpdateVideoInfos | UpdateVideoInfos | Modifies information about multiple audio or video files at a time. |
| UploadMediaByURL | UploadMediaByURL | Uploads media files based on URLs. |
| UploadStreamByURL | UploadStreamByURL | Uploads transcoded streams to ApsaraVideo VOD from external storage. |