# Alibaba Cloud ApsaraVideo VOD API > Alibaba Cloud ApsaraVideo VOD API on Apizie: 189 endpoints (Adds an AI template for automated review and smart thumbnail tasks, Creates a category to classify audio, video, image, and short video materials stored in ApsaraVideo VOD,…, Creates an online editing project (video editing task), Adds one or more materials to an online editing project, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-vod/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-vod` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/vod - Page: https://apizie.tech/api/cloud/aliyun-vod - OpenAPI: https://apizie.tech/api/cloud/aliyun-vod/openapi.json Alibaba Cloud OpenAPI for ApsaraVideo VOD (vod, version 2017-03-21). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds an AI template for automated review and smart thumbnail tasks `POST https://apizie.tech/v1/cloud:aliyun-vod/add-aitemplate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TemplateName | string | yes | The name of the AI template. Maximum length: 128 bytes | | TemplateType | string | yes | The templatetype of the AI template. Valid values: AIMediaAudit: automated review. AIImage: smart thumbnail | | TemplateConfig | string | yes | The detailed configuration of the AI template. The value is a JSON string. For more information, see… | ### Creates a category to classify audio, video, image, and short video materials stored in ApsaraVideo VOD,… `POST https://apizie.tech/v1/cloud:aliyun-vod/add-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | CateName | string | yes | The category name. Maximum length: 64 bytes. UTF-8 encoded | | ParentId | integer | no | The parent category ID. Log on to the ApsaraVideo VOD console (https://vod.console.aliyun.com) and choose Configuration Management > Media… | | Type | string | no | The category type. Valid values: default (default): audio/video/image category. material: short video material category | ### Creates an online editing project (video editing task) `POST https://apizie.tech/v1/cloud:aliyun-vod/add-editing-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Title | string | yes | The title of the online editing project | | Description | string | no | The description of the online editing project | | Timeline | string | no | The timeline of the online editing project. JSON format. For the specific structure definition, see… | | CoverURL | string | no | The thumbnail of the online editing project. If this parameter is left empty and the video track on the timeline already contains… | | Division | string | no | The service region | ### Adds one or more materials to an online editing project `POST https://apizie.tech/v1/cloud:aliyun-vod/add-editing-project-materials` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ProjectId | string | yes | The online editing project ID | | MaterialIds | string | yes | The material IDs. Separate multiple IDs with commas (,). A maximum of 10 material IDs are supported. When you associate multiple… | | MaterialType | string | yes | The material type. Valid values: video: video. audio: audio-only. image: image | ### Adds transcoding configurations. You can create a transcoding template group or add transcoding templates to… `POST https://apizie.tech/v1/cloud:aliyun-vod/add-transcode-template-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Name | string | no | The name of the transcoding template group. The name can be up to 128 bytes in length. The value is encoded in UTF-8. You must specify… | | TranscodeTemplateList | string | no | The transcoding template configurations in the JSON format. For more information about the parameter structure, see… | | TranscodeTemplateGroupId | string | no | The ID of the transcoding template group. If you specify the ID of a transcoding template group, new transcoding templates are added to… | | AppId | string | no | The application ID. Default value: app-1000000. For more information, see https://help.aliyun.com/document_detail/113600.html | ### Adds an accelerated domain name for ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/add-vod-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name that you want to add to ApsaraVideo VOD. Wildcard domain names are supported. A wildcard domain name must… | | Sources | string | yes | The list of origin addresses. For more information about the parameters, see the Sources table below | | CheckUrl | string | no | The URL for health checks | | Scope | string | no | The acceleration region. This parameter is valid for users outside the Chinese mainland and users in the Chinese mainland at level 3 or… | | TopLevelDomain | string | no | The top-level domain name | ### Binds a storage bucket to a sub-application of ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/add-vod-storage-for-app` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID. The application ID is the value of the `AppId` parameter returned by the [CreateAppInfo](~~CreateAppInfo~~) or… | | StorageLocation | string | no | The OSS bucket address. This parameter is required when StorageType is set to user_oss_bucket | | StorageType | string | no | The storage type. Valid values: vod_oss_bucket user_oss_bucket Default value: vod_oss_bucket | ### Adds a snapshot or animated image template `POST https://apizie.tech/v1/cloud:aliyun-vod/add-vod-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Name | string | yes | The template name. The name can be up to 128 bytes in length. UTF-8 encoded | | TemplateType | string | yes | The templatetype. Valid values: Snapshot: snapshot. DynamicImage: animated image | | TemplateConfig | string | yes | The template configuration data in JSON format. For more information about the data structure, see… | | AppId | string | no | The application ID. Default value: app-1000000. For more information, see https://help.aliyun.com/document_detail/113600.html | ### To simplify watermark task processing, ApsaraVideo VOD consolidates complex watermark parameters such as… `POST https://apizie.tech/v1/cloud:aliyun-vod/add-watermark` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Type | string | yes | The templatetype of the watermark. Valid values: Image (default): image watermark template. Text: text watermark template | | Name | string | yes | The name of the watermark template. Only Chinese characters, letters, and digits are supported. The name can be up to 128 bytes in length.… | | WatermarkConfig | string | yes | The configuration information of the watermark (JSON string), including the display position and effect of the watermark. The… | | FileUrl | string | no | The Object Storage Service (OSS) URL of the watermark image file (without authentication). Request parameter is required when you set an… | | AppId | string | no | The application ID. Default value: app-1000000. If you have activated the multi-application service, specify the application ID to add the… | ### Invokes this operation to attach access permissions of an ApsaraVideo VOD application to a specified… `POST https://apizie.tech/v1/cloud:aliyun-vod/attach-app-policy-to-identity` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | IdentityType | string | yes | The identity type. Valid values: RamUser: Resource Access Management (RAM) user. RamRole: RAM role | | IdentityName | string | yes | The identity name. If the type is RamUser, specify the Resource Access Management (RAM) user ID. If the type is RamRole, specify the role… | | AppId | string | no | The application ID. Default value: app-1000000. For more information, see https://help.aliyun.com/document_detail/113600.html. If the… | | PolicyNames | string | yes | The policy names. Separate multiple names with commas (,). Only system policies are supported. Valid values: VODAppFullAccess: permissions… | ### Retrieves the basic information and source file information of media assets in batches `POST https://apizie.tech/v1/cloud:aliyun-vod/batch-get-media-infos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaIds | string | yes | The media asset IDs, namely the audio or video IDs (VideoId). Separate multiple IDs with commas (,). A maximum of 20 IDs are supported.… | | ReferenceIds | string | no | The custom ID list. It consists of one or more custom IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported | ### Configures multiple accelerated domain names in a batch `POST https://apizie.tech/v1/cloud:aliyun-vod/batch-set-vod-domain-configs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainNames | string | yes | The accelerated domain names for ApsaraVideo VOD. Separate multiple domain names with commas (,). You can configure up to 50 domain names… | | Functions | string | yes | The list of features. functionName (feature name, required): For the features that can be configured and their feature name parameters,… | ### Enables an accelerated domain name that is in the Disabled state `POST https://apizie.tech/v1/cloud:aliyun-vod/batch-start-vod-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainNames | string | yes | The accelerated domain names for ApsaraVideo VOD. Separate multiple domain names with commas (,) | ### Pauses domain name acceleration `POST https://apizie.tech/v1/cloud:aliyun-vod/batch-stop-vod-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainNames | string | yes | The accelerated domain names for ApsaraVideo VOD. Separate multiple domain names with commas (,) | ### Cancels URL upload tasks that are in the queue `POST https://apizie.tech/v1/cloud:aliyun-vod/cancel-url-upload-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobIds | string | no | The list of task IDs. You can obtain the task ID (JobId) from the PlayInfo struct returned by the… | | UploadUrls | string | no | The list of source video upload URLs. Separate multiple URLs with commas (,). A maximum of 10 URLs are supported. URL-encode the URLs… | ### Transfers a resource to a different resource group `POST https://apizie.tech/v1/cloud:aliyun-vod/change-resource-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ResourceType | string | no | The resource type | | ResourceId | string | yes | The resource ID | | ResourceRegionId | string | yes | The region ID | | ResourceGroupId | string | yes | The ID of the target resource group | ### Creates an application `POST https://apizie.tech/v1/cloud:aliyun-vod/create-app-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppName | string | yes | The application name. The name must be unique. The name can be up to 128 characters in length and can contain Chinese characters, letters,… | | Description | string | no | The application description. The description can be up to 512 characters in length. UTF-8 encoding | | ResourceGroupId | string | no | The resource group ID | ### Submits a manual review request to review media information such as videos and audio files `POST https://apizie.tech/v1/cloud:aliyun-vod/create-audit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AuditContent | string | yes | The array of review content. A maximum of 100 audio or video entries can be reviewed at a time. Convert the array to a string before… | ### The upload URL and credential are provided by ApsaraVideo VOD to address authorization and security… `POST https://apizie.tech/v1/cloud:aliyun-vod/create-upload-attached-media` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Title | string | no | The title of the auxiliary media asset. Rules: The title can be up to 128 bytes in length. The title must be encoded in UTF-8 | | BusinessType | string | yes | The type of the auxiliary media asset. Valid values: watermark: watermark. subtitle: subtitle. material: material | | MediaExt | string | no | The file name extension of the auxiliary media asset source file to be uploaded. Valid values: Watermark: png, gif, apng, mov. Subtitle:… | | FileName | string | no | The source file address of the auxiliary media asset to be uploaded. The file name extension is optional. If a file name extension is… | | FileSize | string | no | The file size. Unit: bytes | | Tags | string | no | The tags. Rules: A maximum of 16 tags are supported. Separate multiple tags with commas (,). Each tag can be up to 32 characters or… | | StorageLocation | string | no | The storage address. You can obtain the storage address by using the following method: Log on to the ApsaraVideo VOD console… | | Description | string | no | The description of the media asset. Rules: The description can be up to 1024 bytes in length. The description must be encoded in UTF-8 | | UserData | string | no | The custom settings, which is a JSON string. The settings support message callbacks, upload acceleration, and other configurations. For… | | CateIds | string | no | The category IDs. Separate multiple IDs with commas (,). A maximum of 5 IDs are supported. You can obtain category IDs by using the… | | AppId | string | no | The application ID. Default value: app-1000000. If you have activated the multi-application service, specify the application ID to upload… | ### Retrieves the upload URL and upload credential for uploading an image to ApsaraVideo VOD, and creates image… `POST https://apizie.tech/v1/cloud:aliyun-vod/create-upload-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Title | string | no | The title of the image. Rules: The title can be up to 128 characters in length. The title must be encoded in UTF-8 | | ImageType | string | yes | The type of the image. Valid values: default (default): a common image. cover: a video thumbnail. The ApsaraVideo VOD console supports… | | ImageExt | string | no | The file name extension of the image source file to upload. Valid values: png (default) jpg jpeg gif heic webp | | OriginalFileName | string | no | The address of the image source file to upload. The file name extension is optional. If a file name extension is included here and is… | | Tags | string | no | The tags of the image. Rules: Each tag can be up to 32 characters in length. You can specify up to 16 tags. Separate multiple tags with… | | StorageLocation | string | no | The storage address. You can obtain the storage address by using the following method: Log on to the ApsaraVideo VOD console… | | CateId | integer | no | The category ID. You can obtain the category ID by using the following methods: Log on to the ApsaraVideo VOD console… | | UserData | string | no | The custom settings in a JSON string. The settings support message callbacks, upload acceleration, and other configurations. For more… | | Description | string | no | The description of the image. The description can be up to 1024 characters in length. The description must be encoded in UTF-8 | | AppId | string | no | The application ID. Default value: app-1000000. If you have activated the multi-application service, specify the application ID to upload… | ### Obtains the upload URL and credential for an audio or video file, and creates the media information.… `POST https://apizie.tech/v1/cloud:aliyun-vod/create-upload-video` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | CoverURL | string | no | The URL of the custom video thumbnail | | Description | string | no | The description of the audio or video file displayed in ApsaraVideo VOD after the upload is complete. The description can be up to 1,024… | | FileName | string | yes | The name of the audio or video source file to be uploaded. The file name must contain an extension. The extension is not case-sensitive.… | | FileSize | integer | no | The size of the audio or video source file to be uploaded. Unit: bytes | | Title | string | yes | The title of the audio or video file displayed in ApsaraVideo VOD after the upload is complete. The title can be up to 128 characters in… | | CateId | integer | no | The category ID. You can obtain the category ID by using one of the following methods: Log on to the ApsaraVideo VOD console… | | Tags | string | no | The tags of the audio or video file. You can specify up to 16 tags. Separate multiple tags with commas (,). Each tag can be up to 32… | | UserData | string | no | The custom settings. The value is a JSON string that supports settings such as message callback and upload acceleration. For more… | | TemplateGroupId | string | no | The ID of the transcoding template group. You can obtain the ID by using one of the following methods: Log on to the ApsaraVideo VOD… | | WorkflowId | string | no | The workflow ID. You can log on to the ApsaraVideo VOD console (https://vod.console.aliyun.com) and choose Configuration Management >… | | StorageLocation | string | no | The storage address. You can obtain the storage address by using the following method: Log on to the ApsaraVideo VOD console… | | AppId | string | no | The application ID. Default value: app-1000000. For more information, see https://help.aliyun.com/document_detail/113600.html | | ReferenceId | string | no | The custom ID. The ID can be 6 to 64 characters in length and can contain only lowercase letters, uppercase letters, digits, hyphens (-),… | | EnableFirstFrameCover | string | no | Specifies whether to use the first frame of the video as the thumbnail | | GenerateThumbnail | string | no | Specifies whether to generate a thumbnail for the video | ### Invokes this operation to perform decryption on the CiphertextBlob in a KMS data key (DK) `POST https://apizie.tech/v1/cloud:aliyun-vod/decrypt-kmsdata-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | CipherText | string | yes | The ciphertext to decrypt | ### Deletes AI image information `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-aiimage-infos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AIImageInfoIds | string | yes | The IDs of AI image information. This parameter consists of one or more AIImageInfoId values. The AIImageInfoId is the value of the… | ### Deletes an AI template `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-aitemplate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TemplateId | string | yes | The ID of the AI template. You can obtain the template ID by using one of the following methods: When you call the… | ### Deletes application information `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-app-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID. Set this parameter to the value of AppId returned by the https://help.aliyun.com/document_detail/113266.html or… | ### Deletes one or more auxiliary media assets that have been uploaded to ApsaraVideo VOD, such as watermark… `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-attached-media` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaIds | string | yes | The auxiliary media asset IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. The IDs are returned after you… | ### Deletes a category and its subcategories `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | CateId | integer | yes | The category ID. Only a single category ID is supported. You can obtain the category ID by using the following methods: Log on to the… | ### Deletes animated sticker information `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-dynamic-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoId | string | yes | The ID of the video associated with the animated stickers that you want to delete. You can obtain the video ID by using one of the… | | DynamicImageIds | string | no | The list of animated sticker IDs. The animated sticker ID is the value of the DynamicImageId response parameter returned by the… | ### Deletes an online editing project `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-editing-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ProjectIds | string | yes | The online editing project IDs. Separate multiple IDs with commas (,) | ### Deletes materials from an online editing project `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-editing-project-materials` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ProjectId | string | yes | The ID of the online editing project | | MaterialIds | string | yes | The material IDs. These are media asset IDs, such as VideoId for videos, ImageId for images, and MediaId for auxiliary media assets.… | | MaterialType | string | yes | The material type. Valid values: video: video. audio: audio-only. image: image | ### Deletes images uploaded by users or images generated from video snapshots `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-image` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DeleteImageType | string | yes | The type of image deletion operation. Valid values: ImageURL: deletes images based on image URLs. ImageId: deletes images based on image… | | ImageURLs | string | no | The image URLs. The value is the `ImageURL` parameter returned by the [CreateUploadImage](~~CreateUploadImage~~) operation. Separate… | | ImageIds | string | no | The image IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain image IDs by using the following… | | VideoId | string | no | The video ID. Only a single video ID is supported. You can obtain the video ID by using the following methods: Log on to the ApsaraVideo… | | ImageType | string | no | The type of images associated with the video that you want to delete. Valid values: CoverSnapshot: thumbnail snapshot. NormalSnapshot:… | ### Deletes the callback method, callback URL, and event types of an event notification `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-message-callback` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID. If this parameter is not specified, the ID of the system default application is used. Fixed value: app-1000000 | ### Deletes the source files of multiple audio and video files at a time `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-mezzanines` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoIds | string | no | The list of audio or video IDs whose source files you want to delete. You can specify a maximum of 20 IDs at a time. Separate multiple IDs… | | Force | string | no | Specifies whether to force delete the source file. Valid values: false (default): No. true: Yes. If the video transcoding pattern is set… | | ReferenceIds | string | no | The list of custom IDs. Specify one or more custom IDs separated by commas (,). A maximum of 20 IDs are supported | ### Deletes fragment files generated during upload `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-multipart-upload` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The media ID, which is the audio or video ID (VideoId). You can obtain the ID by using the following methods: For audio or video files… | | MediaType | string | yes | The media type. Set the value to video (audio/video) | ### Deletes media stream (video stream or audio stream) information and storage files `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-stream` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobIds | string | yes | The list of job IDs for media stream transcoding, which consists of one or more job IDs. Separate multiple IDs with commas (,). A maximum… | | VideoId | string | no | The video ID. You can obtain the video ID by using one of the following methods: For videos uploaded by using the console, log on to the… | | ReferenceId | string | no | The custom ID. Only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_) are supported. The value must be 6 to… | ### Deletes transcoding configurations. You can delete specific transcoding templates from a transcoding… `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-transcode-template-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TranscodeTemplateGroupId | string | yes | The ID of the transcoding template group | | TranscodeTemplateIds | string | no | The IDs of the transcoding templates that you want to delete. Separate multiple IDs with commas (,). A maximum of 10 template IDs are… | | ForceDelGroup | string | no | Indicates whether to force delete the entire transcoding template group. Valid values: true: Force deletes the entire template group and… | ### Deletes complete videos, including video source files, transcoded stream files, and thumbnails `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-video` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoIds | string | no | The list of video IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain video IDs by using the… | | ReferenceIds | string | no | The list of custom IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported | ### Deletes an accelerated domain name that has been added for ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-vod-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD that you want to delete | ### Deletes the configurations of a domain name for CDN acceleration in ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-vod-specific-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD | | ConfigId | string | yes | The configuration ID | | Env | string | no | The environment from which you want to delete the configuration. Valid values: online: production environment gray: canary release… | ### Deletes a snapshot template `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-vod-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VodTemplateId | string | yes | The ID of the snapshot template | ### Deletes an image watermark template or text watermark template by watermark template ID `POST https://apizie.tech/v1/cloud:aliyun-vod/delete-watermark` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | WatermarkId | string | yes | The ID of the watermark template to delete. Only a single watermark template ID can be specified. You can obtain the ID by using the… | ### Queries the time-based distribution of audio and video media assets. The maximum time span between the start… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-media-distribution` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | no | The start time of CreationTime. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). The maximum time span between the start time and end time is six months | | EndTime | string | no | The end time of CreationTime. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). The maximum time span… | | StorageClass | string | no | The storage class. Valid values: Standard: standard storage. IA: Infrequent Access. Archive: Archive storage. ColdArchive: Cold Archive… | | Interval | string | no | The statistical interval. Default value: day. Valid values: hour: by hour. Statistics are collected based on the calendar hours within the… | ### Retrieves daily playback statistics for top videos, including the number of views, unique viewers, and total… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-play-top-videos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | BizDate | string | yes | The date to query. Format: yyyy-MM-ddTHH:mm:ssZ (UTC) | | PageNo | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 100. Maximum value: 1000 | ### Retrieves daily average playback statistics for a specified time range, including average playback duration… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-play-user-avg` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC) | | EndTime | string | yes | The end time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC). The end time must be later than the start time.… | ### Retrieves the total daily playback statistics within a specified time range, including total play count,… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-play-user-total` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC) | | EndTime | string | yes | The end time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC). The end time must be later than the start time.… | ### Queries the daily playback statistics of a specified video within a specified time range. The statistics… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-play-video-statis` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | EndTime | string | yes | The end time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC). The end time must be later than the start time,… | | VideoId | string | yes | The ID of the video to query. Only one video ID can be specified. You can obtain the video ID by using the following methods: Log on to… | ### Queries usage data of AI processing services such as automated review and media fingerprint `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-aidata` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC) | | EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format… | | Region | string | no | The storage region. By default, data in all regions is returned. You can specify multiple regions separated by commas (,). Valid values:… | | AIType | string | no | The AI type. By default, all types are returned. You can specify multiple types separated by commas (,). Valid values: AIVideoCensor:… | ### Retrieves the certificate list `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-certificate-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name for ApsaraVideo VOD | ### Queries the bandwidth data of accelerated domain names. Compared with the DescribeVodDomainRealTimeBpsData… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-bps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | | IspNameEn | string | no | The English name of the Internet service provider (ISP). If you do not specify this parameter, all ISPs are queried by default | | LocationNameEn | string | no | The English name of the region. If you do not specify this parameter, all regions are queried by default. Currently, only the Shanghai… | ### Queries bandwidth data of accelerated domain names by protocol type `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-bps-data-by-layer` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | | Interval | string | no | The time granularity of the data. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or specify an… | | IspNameEn | string | no | The name of the Internet service provider (ISP) in English. If you do not specify this parameter, data of all ISPs is queried by default | | LocationNameEn | string | no | The name of the region in English. If you do not specify this parameter, data of all regions is queried by default | | Layer | string | no | The protocol type. You can specify the protocol type at the network layer or application layer. Default value: all: includes both network… | ### Retrieves the certificate information of a specified accelerated domain name `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-certificate-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD | | HeraApiAutoVersion | string | no | The HeraApiAutoVersion | ### Queries domain name configurations. You can query multiple feature configurations in a single request `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-configs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD. Only a single domain name can be queried at a time | | FunctionNames | string | yes | The feature names. You can query multiple feature configurations in a single request. Separate multiple feature names with commas (,). For… | ### Queries the basic configuration information of a specified ApsaraVideo VOD domain name `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The name of the ApsaraVideo VOD accelerated domain name | ### Queries the byte hit ratio (percentage of hit bytes) of accelerated domain names `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-hit-rate-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | EndTime | string | no | The end time of the data to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | ### Retrieves the download URLs of raw CDN access logs for a specified domain name `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-log` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD. Only a single domain name is supported | | PageSize | integer | no | The number of entries per page. Default value: 300 Maximum value: 1000 | | PageNumber | integer | no | The page number. Default value: 1 | | StartTime | string | no | The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC) | | EndTime | string | no | The end of the time range to query. The end time must be later than the start time. The interval between the start time and end time… | ### Queries the monitoring data of the 95th percentile bandwidth for accelerated domain names `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-max95-bps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If this parameter is left empty, the aggregated data of all accelerated domain names is returned by… | | StartTime | string | no | The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | EndTime | string | no | The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be… | | TimePoint | string | no | The start time of the data. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | Cycle | string | no | The cycle for the 95th percentile bandwidth. Default value: day. Valid values: day: Queries the 95th percentile bandwidth by day. month:… | ### Queries the queries per second (QPS) of accelerated domain names at a 5-minute granularity. Data from the… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-qps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain names. Separate multiple domain names with commas (,). You can specify up to 500 domain names in a single request.… | | StartTime | string | no | The start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | EndTime | string | no | The end time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | Interval | string | no | The time granularity of the queried data. Unit: seconds. Valid values: 300, 3600, and 86400 | | IspNameEn | string | no | The name of the Internet service provider (ISP). Default value: all ISPs | | LocationNameEn | string | no | The name of the region. If you do not specify this parameter, all regions are queried | ### Invokes this operation to query the bandwidth data of an accelerated domain name. Compared with the… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-bps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Separate multiple domain names with commas (,). You can specify up to 500 domain names at a time.… | | IspNameEn | string | no | The name of the Internet service provider (ISP) in English. If you do not specify this parameter, data of all ISPs is queried | | LocationNameEn | string | no | The name of the region in English. If you do not specify this parameter, data of all regions is queried | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | ### Queries the byte hit rate data of accelerated domain names. This operation supports a minimum time… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-byte-hit-rate-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Separate multiple domain names with commas (,). You can specify up to 100 domain names at a time.… | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | ### Queries real-time access data for accelerated domain names, including QPS, bandwidth, and HTTP status code… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-detail-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Batch queries are supported. Separate multiple domain names with commas (,). You can specify up to… | | StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | | Field | string | yes | The type of access data to query. You can specify multiple types. Separate multiple types with commas (,). Valid values: qps: queries per… | | LocationNameEn | string | no | The region name in English. If you do not specify this parameter, data for all regions is queried by default | | IspNameEn | string | no | The Internet service provider (ISP) name in English. If you do not specify this parameter, data for all ISPs is queried by default | | Merge | string | no | Specifies whether to return aggregated data by domain name. Valid values: true: Returns aggregated data across all domain names. false… | | MergeLocIsp | string | no | Specifies whether to return aggregated data by region and ISP. Valid values: true: Returns data grouped only by domain name, with region… | ### Queries the total count and proportion of HTTP status codes for accelerated domain names. This operation… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-http-code-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Separate multiple domain names with commas (,). You can query up to 100 domain names at a time. When… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | IspNameEn | string | no | The English name of the Internet service provider (ISP). If you do not specify this parameter, all ISPs are queried by default | | LocationNameEn | string | no | The English name of the region. If you do not specify this parameter, all regions are queried by default | ### Invoke this operation to query the queries per second (QPS) data for access to an accelerated domain name.… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-qps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Separate multiple domain names with commas (,). You can specify up to 500 domain names at a time.… | | IspNameEn | string | no | The name of the Internet service provider (ISP) in English. If you do not specify this parameter, data of all ISPs is queried by default | | LocationNameEn | string | no | The name of the region in English. If you do not specify this parameter, data of all regions is queried by default | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | ### Queries the request hit ratio data for an accelerated domain name. The minimum time granularity for data… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-req-hit-rate-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain names. Separate multiple domain names with commas (,). You can specify up to 100 domain names at a time. When you… | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | ### Queries the traffic data of accelerated domain names. Compared with the DescribeVodDomainTrafficData… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-real-time-traffic-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. Separate multiple domain names with commas (,). You can query up to 100 domain names at a time. When… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | IspNameEn | string | no | The English name of the ISP. If you do not specify this parameter, all ISPs are queried by default | | LocationNameEn | string | no | The English name of the region. If you do not specify this parameter, all regions are queried by default | ### Queries the request hit ratio (percentage of hit requests) of accelerated domain names `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-req-hit-rate-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | ### Queries the back-to-origin bandwidth data of accelerated domain names `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-src-bps-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | ### Queries the back-to-origin traffic data of accelerated domain names `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-src-traffic-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | EndTime | string | no | The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | ### Queries the traffic data of accelerated domain names. Compared with the DescribeVodDomainRealTimeTrafficData… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-traffic-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name to query. If you do not specify this parameter, the pooled data of all accelerated domain names is returned by… | | StartTime | string | no | The start time of the data to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC | | EndTime | string | no | The end time of the data to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | | Interval | string | no | The time granularity of the data to query. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or… | | IspNameEn | string | no | The English name of the Internet service provider (ISP). If you do not specify this parameter, all ISPs are queried by default | | LocationNameEn | string | no | The English name of the region. If you do not specify this parameter, all regions are queried by default. Currently, only the China… | ### Queries acceleration traffic or bandwidth usage data `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-domain-usage-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name. If this parameter is left empty, the merged data of all accelerated domain names is returned by default.… | | StartTime | string | yes | The beginning of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format… | | Field | string | yes | The data type. Valid values: bps: bandwidth. traf: traffic | | Type | string | no | The type of usage data to retrieve. Valid values: static: static content. dynamic: dynamic content. all: all content | | Area | string | no | The region code. Default value: CN (the Chinese mainland). Valid values: CN: the Chinese mainland. OverSeas: outside the Chinese mainland | | Interval | string | no | Forces the retrieval of data at the specified time granularity, in seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1… | ### Queries the usage data of online editing in ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-editing-usage-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in… | | EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC | | Region | string | no | The region. By default, data from all regions is returned. You can specify multiple regions separated by commas (,) | | Specification | string | no | The output specification | | AppId | string | no | The application ID. For more information, see https://help.aliyun.com/document_detail/113600.html | ### Retrieves playback data of an audio or video file on a specified date by media ID (audio or video ID),… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-media-play-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | PlayDate | string | no | The playback date. Unit: day. Format: yyyyMMdd. Only daily queries are supported. Only data within the last 30 days can be queried | | TerminalType | string | no | The terminal type of the Player SDK. Specify this parameter to perform a filtered query for playback data of all audio and video files by… | | Os | string | no | The operating system of the playback device. Specify this parameter to perform a filtered query for playback data of all audio and video… | | Region | string | no | The service region. Specify this parameter to perform a filtered query for playback data of all audio and video files by service region.… | | MediaId | string | no | The media ID, which is the audio or video ID (VideoId). Specify this parameter filtered query playback data for a specific media file.… | | PageNo | integer | yes | The page number of the data to return. Specify this parameter to set the page from which data starts to be returned | | PageSize | integer | yes | The number of entries per page. Specify this parameter to set the number of entries displayed on each page. Maximum value: 100 | | OrderType | string | no | The sort order. This parameter is used together with the `OrderName` parameter. Specify this parameter to sort the returned data in… | | OrderName | string | no | The metric name. This parameter is used together with the `OrderType` parameter. Specify this parameter to sort the returned data in… | ### Queries aggregated playback data of the player `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-player-collect-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | StartTime | string | yes | The start time of the query. Format: yyyy-mm-dd t hh:mm:ss z (UTC). Playback data from the last year can be queried. The time range for a… | | EndTime | string | yes | The end time of the query. Format: yyyy-mm-ddthh:mm:ssz (UTC) | | Interval | string | yes | The time granularity for the query data. Valid values: 5m, 1h, and 1d. The supported time granularity varies based on the time span… | | TerminalType | string | yes | The terminal type. Valid values: web: web. mobile: native | | Os | string | no | The operating system of the playback device. Specify this parameter to perform a filtered query for playback data of a specific operating… | | Metrics | string | yes | The metric type. You can specify up to 3 metrics. Percentage data is returned in decimal format. Playback quality (QoS) metrics: Vv: play… | | Period | string | no | The time range for period-over-period analysis, in days (d). For example, if you set this parameter to 1d (1 day), the period-over-period… | ### Queries the dimension metadata of the player `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-player-dimension-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | Dimension | string | yes | The dimension type. Valid values: Os: operating system. AppVersion: application version. SdkVersion: SDK version. Codec: codec. VideoType:… | | StartTime | string | no | The start time of the query. Specify the time in the yyyy-mm-dd t hh:mm:ss z format (UTC). Playback data from the last year is supported.… | | EndTime | string | no | The end time of the query. Specify the time in the yyyy-mm-ddthh:mm:ssz format (UTC) | | Region | string | no | The region filter used when querying the Province or Isp dimension metadata. Valid values: ALL (default): all regions. CN: China.… | ### Queries player metric data `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-player-metric-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | yes | The application ID | | StartTime | string | yes | The start time of the query. Format: yyyy-mm-dd t hh:mm:ss z (UTC). Supports querying playback data history for the past year. The time… | | EndTime | string | yes | The end time of the query. Format: yyyy-mm-ddthh:mm:ssz (UTC) | | Interval | string | yes | The time granularity for querying data. Valid values: 5m, 1h, and 1d. The supported time granularity depends on the time span between… | | TerminalType | string | yes | The terminal type. Valid values: web: web. mobile: native | | Filters | string | no | The metric dimension filters. A dimension consists of a dimension type (Field), an operator (Op), and a dimension value. A maximum of… | | Metrics | string | yes | The metric types. You can select multiple metrics (up to 3). Percentage data is returned in decimal form. Quality of Service (QoS)… | | Top | integer | no | Returns data for the top N items ranked by play count. If this parameter is not specified, data for all dimensions is returned | | PageNumber | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 5000. Maximum value: 5000 | | Language | string | no | The language of the response. Valid values: zh (default): Simplified Chinese. en: English | | Os | string | no | The operating system of the player. Specify this parameter to perform a filtered query for playback data of a specific operating system.… | ### Queries access data for an accelerated domain name by ISP or region, including bandwidth, average response… `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-range-data-by-locate-and-isp-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name to query. You can log on to the ApsaraVideo VOD console (https://vod.console.aliyun.com), and choose… | | StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be… | | EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.… | | LocationNameEn | string | no | The region name in English. If you do not specify this parameter, data of all regions is queried. Separate multiple region names with… | | IspNameEn | string | no | The ISP name in English. If you do not specify this parameter, data of all ISPs is queried. You can specify only one ISP for each request | ### Queries the maximum number and remaining daily quota of URLs and directories for purge and prefetch operations `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-refresh-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | ### Queries whether refresh and prefetch tasks have taken effect `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-refresh-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TaskId | string | no | The task ID used to query the refresh status | | ObjectPath | string | no | The object path. Exact match is supported | | PageNumber | integer | no | The page number | | ObjectType | string | no | The task type. Valid values: file: file refresh directory: directory refresh preload: file prefetch If you specify DomainName or Status,… | | DomainName | string | no | The domain name | | Status | string | no | The task status. Valid values: Complete: The task is complete. Refreshing: The task is in progress. Failed: The task failed | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 50 | | StartTime | string | no | The start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The time must be in UTC. You can query only the data generated… | | EndTime | string | no | The end time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The time must be in UTC | ### Queries certificate list information by domain name `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-sslcertificate-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | no | The accelerated domain name | | PageNumber | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The page size. Valid values: any integer from 1 to 1000 | | SearchKeyword | string | no | The certificate name for fuzzy match | ### Queries the usage of media asset management, including storage space and outbound storage traffic `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-storage-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format… | | Region | string | no | The storage region. By default, data of all regions is returned. You can specify multiple regions separated by commas (,). Valid values:… | | StorageType | string | no | The storage type. Set the value to OSS | | Storage | string | no | The storage name (Alibaba Cloud OSS bucket name). By default, data of all storage buckets is returned. You can specify multiple storage… | | AppId | string | no | The application ID. If you have activated the multi-application feature, you can specify this parameter to query the storage usage of a… | ### Queries the usage of tiered storage for media asset management `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-tiering-storage-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | no | The start time of the query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. If this… | | EndTime | string | no | The end time of the query. The end time must be later than the start time. The time range cannot exceed 31 days. Specify the time in the… | | Region | string | no | The storage region. By default, data of all regions is returned. You can specify multiple regions separated by commas (,) | | StorageClass | string | no | The storage class. By default, data of all storage classes is returned. Valid values: IA: Infrequent Access. Archive: Archive.… | | AppId | string | no | The application ID | ### Queries the retrieval data usage of tiered storage in media asset management `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-tiering-storage-retrieval-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in… | | EndTime | string | no | The end of the time range to query. The end time must be later than the start time. The maximum time range is 31 days. Format: yyyy-MM-dd… | | Region | string | no | The storage region. By default, data of all regions is returned. You can specify multiple regions separated by commas (,) | | StorageClass | string | no | The storage class. Valid values: IA: Infrequent Access. Archive: Archive. ColdArchive: Cold Archive | | AppId | string | no | The application ID | ### Queries transcoding usage data `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-transcode-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | StartTime | string | yes | The start of the time range to query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) | | EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format… | | Region | string | no | The storage region. By default, data for all regions is returned. You can specify multiple regions separated by commas (,). Valid values:… | | Interval | string | no | The time granularity. Valid values: day: day. hour: hour | | Storage | string | no | The storage name (Alibaba Cloud OSS bucket name). By default, data for all storage locations is returned. You can specify multiple storage… | | Specification | string | no | The transcoding specification. By default, data for all transcoding specifications is returned. You can specify multiple specifications… | | AppId | string | no | The application ID. If you specify this parameter, transcoding usage data for the specified application is returned. By default,… | ### Queries the list of all acceleration domain names under your account for ApsaraVideo VOD `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-user-domains` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | PageSize | integer | no | The number of entries per page. Default value: 20. Maximum value: 50. Valid values: any integer from 1 to 50 | | PageNumber | integer | no | The number of the page to return | | DomainName | string | no | The accelerated domain name for ApsaraVideo VOD. Fuzzy match filtering is supported | | DomainStatus | string | no | The domain name status filter. Valid values: online: Enabled. offline: Disabled. configuring: Being configured. configure_failed:… | | DomainSearchType | string | no | The domain name query type. Valid values: fuzzy_match (default): fuzzy match. pre_match: prefix match. suf_match: suffix match.… | | Tag | string | no | The tags (JSON-encoded) | ### Queries the IP address list of a domain name `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-user-vips-by-domain` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The accelerated domain name for ApsaraVideo VOD. You can specify only one domain name | | Available | string | no | Specifies whether to query healthy VIPs. Valid values: on: healthy VIPs off: all VIPs | ### Retrieves the domain ownership verification content `POST https://apizie.tech/v1/cloud:aliyun-vod/describe-vod-verify-content` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | DomainName | string | yes | The domain name to be verified. Only a single domain name is supported | ### Invokes this operation to revoke application authorization from a specified account identity (Resource… `POST https://apizie.tech/v1/cloud:aliyun-vod/detach-app-policy-from-identity` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | IdentityType | string | yes | The identity type. Valid values: RamUser: Resource Access Management (RAM) user. RamRole: RAM role | | IdentityName | string | yes | The identity name. If the type is RamUser, specify the Resource Access Management (RAM) user ID. If the type is RamRole, specify the role… | | AppId | string | no | The application ID. If the policy name is VODAppAdministratorAccess, this parameter is optional. For other policies, this parameter is… | | PolicyNames | string | yes | The policy names. Separate multiple names with commas (,). Only system policies are supported. Valid values: VODAppFullAccess: permissions… | ### Generates a key for secure download. The secure download feature of ApsaraVideo Player SDK encrypts videos… `POST https://apizie.tech/v1/cloud:aliyun-vod/generate-download-secret-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppIdentification | string | yes | The unique identity of the app. Android: the SHA-1 value of the keystore file. The obtained SHA-1 value is a character string with colons.… | | AppDecryptKey | string | yes | The custom encryption private key string. The string is 16 to 32 characters in length and consists of letters and digits. The string must… | ### Invokes the operation to generate a random KMS data key (DK) for ApsaraVideo VOD HLS encryption `POST https://apizie.tech/v1/cloud:aliyun-vod/generate-kmsdata-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | ### Queries the list of AI image processing tasks `POST https://apizie.tech/v1/cloud:aliyun-vod/get-aiimage-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobIds | string | yes | The IDs of AI image processing tasks. The value consists of one or more job IDs. A job ID is the value of the JobId parameter returned by… | ### Queries an automated review job. After you submit an AI job, the job is processed asynchronously. You can… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-aimedia-audit-job` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobId | string | yes | The ID of the automated review job | ### Queries an AI template `POST https://apizie.tech/v1/cloud:aliyun-vod/get-aitemplate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TemplateId | string | yes | The AI template ID. You can obtain the ID by using one of the following methods: When you call the… | ### Retrieves the results of smart tagging for a video `POST https://apizie.tech/v1/cloud:aliyun-vod/get-aivideo-tag-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The media asset ID, which is the video ID. You can obtain the video ID by using the following methods: For videos uploaded through the… | ### Queries application information by application ID `POST https://apizie.tech/v1/cloud:aliyun-vod/get-app-infos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppIds | string | yes | The list of application IDs. The list consists of one or more application IDs. An application ID is the value of the AppId parameter… | ### Retrieves the playback key of an application `POST https://apizie.tech/v1/cloud:aliyun-vod/get-app-play-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID. Default value: app-1000000. For more information, see https://help.aliyun.com/document_detail/113600.html | ### Retrieves the basic information and access URLs of multiple auxiliary media assets in a batch by specifying… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-attached-media-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaIds | string | yes | The auxiliary media asset IDs. Separate multiple IDs with commas (,). You can specify up to 20 IDs. The IDs are returned after you call… | | AuthTimeout | integer | no | The validity period of the auxiliary media asset URL. Unit: seconds. If OutputType is set to cdn: - The URL expires only if URL… | | OutputType | string | no | The type of the output URL. Valid values: oss: the back-to-origin URL. cdn (default): the CDN-accelerated URL | ### Retrieves the history of manual review records `POST https://apizie.tech/v1/cloud:aliyun-vod/get-audit-history` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoId | string | yes | The video ID | | PageNo | integer | no | The page number. Default value: 1 | | PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 100 | | SortBy | string | no | The sorting method for results. Valid values: CreationTime:Desc (default): sorts results by creation time in descending order.… | ### Invokes this operation to perform a filtered query for specified categorization information and the list of… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-categories` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | CateId | integer | no | The category ID. If you specify this parameter, you can query the category with the specified ID. You can specify only one category ID.… | | PageNo | integer | no | The page number of the subcategory list. Default value: 1 | | PageSize | integer | no | The number of entries per page in the subcategory list. Default value: 10. Maximum value: 100 | | SortBy | string | no | The sorting method of the query results. Valid values: CreationTime:Desc (default): Sort by creation time in descending order.… | | Type | string | no | The categorization type. If you specify this parameter, you can perform a filtered query for categorizations of the specified type. Valid… | ### Retrieves the full traffic data of media assets for a specified date and region. The data is generated based… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-daily-play-region-statis` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | Date | string | yes | The playback date, in days. Format: yyyy-MM-dd. Only daily queries are supported. Only data within the past year can be queried | | MediaRegion | string | yes | The media asset region ID. Specify this parameter to perform a filtered query for the playback data of all audio and video files in a… | ### Queries the default AI template `POST https://apizie.tech/v1/cloud:aliyun-vod/get-default-aitemplate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TemplateType | string | yes | The AI templatetype. Set the value to AIMediaAudit (automated review) | ### Queries the results of digital watermark (copyright watermark or tracing watermark) extraction jobs when you… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-digital-watermark-extract-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The ID of the video to query. You can specify only one video ID. You can obtain the video ID by using one of the following methods: Log on… | | ExtractType | string | yes | The type of the watermark to extract. Valid values: TraceMark: tracing watermark CopyrightMark: copyright watermark | | JobId | string | no | The ID of the watermark extraction job. The job ID is returned after you call the… | ### Queries the details of an online editing project (video editing task) `POST https://apizie.tech/v1/cloud:aliyun-vod/get-editing-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ProjectId | string | yes | The ID of the online editing project | ### Retrieves the list of materials to be edited in an online editing project `POST https://apizie.tech/v1/cloud:aliyun-vod/get-editing-project-materials` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ProjectId | string | yes | The online editing project ID. You can obtain the ID by using one of the following methods: Log on to the ApsaraVideo VOD console… | | Type | string | no | The material type. Valid values: video: video audio: audio-only | | MaterialType | string | no | The material type. Valid values: video: video audio: audio-only image: image | ### Retrieves the basic information and access URL of an image by image ID after the image is uploaded to… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-image-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ImageId | string | yes | The image ID. You can obtain the image ID by using one of the following methods: Log on to the ApsaraVideo VOD console… | | AuthTimeout | integer | no | The validity period of the image access URL. Unit: seconds. If OutputType is set to cdn: - The image URL expires only if URL signing is… | | OutputType | string | no | The type of the image access URL to return. Valid values: oss: the origin URL. cdn (default): the accelerated URL | ### Queries the basic information and access URLs of multiple images by image ID after the images are uploaded… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-image-infos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | ImageIds | string | yes | The list of image IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain image IDs by using the… | | AuthTimeout | integer | no | The validity period of the image access URL. Unit: seconds. If OutputType is set to cdn: - The image URL expires only if URL signing is… | | OutputType | string | no | The type of the image access URL to return. Valid values: oss: the storage address. cdn (default): the CDN-accelerated URL | ### Queries the details of an asynchronous task by job ID `POST https://apizie.tech/v1/cloud:aliyun-vod/get-job-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobId | string | yes | The job ID. Note: To query a transcoding task by TaskId, refer to GetTranscodeTask… | | JobType | string | yes | The task type. Valid values: transcode snapshot ai workflow | ### Retrieves the results of video AI analysis `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-ai-analysis` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | no | The audio ID. You can query the audio ID in the ApsaraVideo VOD console or obtain it from the response of the… | | ResultTypes | string | no | The type of analysis results. Separate multiple types with commas (,) | | OutputType | string | no | The type of the output URL. Valid values: oss: back-to-origin URL. cdn (default): accelerated URL | | AuthTimeout | string | no | The expiration time of the image access URL. Unit: seconds. If OutputType is set to cdn: - Only image URLs with URL authentication enabled… | ### Retrieves the details of audio automated review results `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-audit-audio-result-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The audio ID. You can query the audio ID in the ApsaraVideo VOD console or obtain it from the response of the… | | PageNo | integer | no | The page number. This parameter is optional. If you do not specify this parameter, all results are returned without pagination | ### Retrieves the summary of automated review results `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-audit-result` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The ID of the video or image to query | ### Retrieves the details of automated review results. You can call this operation to query the details of… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-audit-result-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The video ID | | PageNo | integer | yes | The page number of the video content review results. Default value: 1. A maximum of 20 records are returned per page | ### Retrieves the timestamps of all screenshots that contain violations `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-audit-result-timeline` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The video ID | ### Retrieves media fingerprint results. After a media fingerprint job is complete, you can call this operation… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-dnaresult` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaId | string | yes | The video ID | ### Queries task information such as task status and filtering policies for a video purge or prefetch task `POST https://apizie.tech/v1/cloud:aliyun-vod/get-media-refresh-jobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaRefreshJobId | string | yes | The ID of the audio or video purge or prefetch task. This is the value of MediaRefreshJobId returned by the… | | MediaId | string | no | The audio or video ID, which is the `MediaIds` value specified when calling the https://help.aliyun.com/document_detail/431095.html… | ### Queries the callback method, callback URL, and event types of event notifications `POST https://apizie.tech/v1/cloud:aliyun-vod/get-message-callback` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | AppId | string | no | The application ID. If this parameter is not specified, the ID of the system default application is used. The fixed value is app-1000000 | ### Retrieves the source file information of an audio or video file, including the file URL, resolution, and… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-mezzanine-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoId | string | no | The audio or video ID. You can obtain the ID by using one of the following methods: For an audio or video file uploaded in the console,… | | AuthTimeout | integer | no | The expiration time of the signature for the FileURL (source file URL). Unit: seconds. Default value: 3600. Minimum value: 1. If… | | OutputType | string | no | The output URL type. Valid values: oss: the back-to-origin URL. cdn (default): the accelerated URL. If the bucket where the source file is… | | AdditionType | string | no | The type of additional information. Separate multiple values with commas (,). By default, only basic information is returned. Valid… | | ReferenceId | string | no | The custom ID. The ID must be 6 to 64 characters in length and can contain only lowercase letters, uppercase letters, digits, hyphens (-),… | ### Retrieves the playback URL of an audio or video file by providing the audio or video ID, which can then be… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-play-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoId | string | no | The audio or video ID. Only a single audio or video ID is supported. You can obtain the ID by using the following methods: For audio or… | | Formats | string | no | The media stream format. Separate multiple formats with commas (,). Valid values: mp4 m3u8 mp3 flv mpd By default, streams in all formats… | | AuthTimeout | integer | no | The validity period of the playback URL. Unit: seconds. If OutputType is set to cdn: - The playback URL expires periodically only when URL… | | OutputType | string | no | The type of the output URL. Valid values: oss: back-to-origin URL. cdn (default): accelerated URL | | StreamType | string | no | The media stream type. Separate multiple types with commas (,). Valid values: video: video. audio: audio. By default, streams of all types… | | ReAuthInfo | string | no | The CDN reauthentication parameter. The value is a JSON string. When type A signing is enabled for URL authentication, you can use this… | | Definition | string | no | The definition of the video stream. Separate multiple definitions with commas (,). Valid values: FD: low definition. LD: standard… | | ResultType | string | no | The type of the returned data. Valid values: Single (default): returns only the latest transcoded stream for each definition and format.… | | PlayConfig | string | no | The custom playback settings. The value is a JSON string that supports specifying domain name playback settings. For details about… | | AdditionType | string | no | Obtains the URL of the China-accessible bullet screen mask data. Valid values: danmu. This parameter takes effect only when `outputType`… | | Trace | string | no | The custom digital watermarking settings. When `DigitalWatermarkType` is set to `TraceMark`, pass in this parameter to set the tracing… | | DigitalWatermarkType | string | no | The digital watermarking type. Valid values: TraceMark: tracing watermark. CopyrightMark: copyright watermark | | CodecName | string | no | 编码类型 | | ReferenceId | string | no | The custom ID. Only lowercase letters, uppercase letters, digits, hyphens, and underscores are supported. The length is 6 to 64… | ### Queries video transcoding summary of one or more audio or video files by their IDs, including video… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-transcode-summary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | VideoIds | string | yes | The audio or video IDs. You can specify a maximum of 10 IDs, separated by commas (,). You can obtain the audio or video ID by using the… | ### Queries the details of transcoding jobs based on a transcoding task ID `POST https://apizie.tech/v1/cloud:aliyun-vod/get-transcode-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TranscodeTaskId | string | no | The transcoding task ID. You can obtain the ID by using one of the following methods: Call the… | | JobIds | string | no | The transcoding job IDs. You can specify a maximum of 10 IDs. Separate multiple IDs with commas (,). You can obtain the IDs by using the… | ### Queries the details of a transcoding configuration by transcoding template group ID `POST https://apizie.tech/v1/cloud:aliyun-vod/get-transcode-template-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | TranscodeTemplateGroupId | string | yes | The transcoding template group ID | ### Retrieves URL upload information `POST https://apizie.tech/v1/cloud:aliyun-vod/get-urlupload-infos` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | JobIds | string | no | The list of upload task IDs (JobId). The list consists of one or more JobId values. A JobId is the value of the JobId parameter returned… | | UploadURLs | string | no | The list of source video file URLs. Separate multiple URLs with commas (,). A maximum of 10 URLs are supported. URL-encode the URLs before… | ### Retrieves media upload details by media ID, such as upload time, upload ratio, and upload source. Batch… `POST https://apizie.tech/v1/cloud:aliyun-vod/get-upload-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://vod.ap-southeast-1.aliyuncs.com | | MediaIds | string | yes | The media IDs, which are audio or video IDs (VideoId). Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can… | | MediaType | string | no | The media type. Set the value to video (audio/video) | …and 69 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-vod/add-aitemplate" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud ApsaraVideo VOD API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-vod/add-aitemplate with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud ApsaraVideo VOD API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraVideo VOD itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud ApsaraVideo VOD API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-vod. ### What is the status of the Alibaba Cloud ApsaraVideo VOD API? Needs your own provider key (bring your own key)