tencent cloud

Video on Demand

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Product Features
Features
Strengths
Scenarios
Solutions
Professional Edition
Introduction to Video On Demand Professional Edition
Quick Start
Console Guide
Development Guide
Purchase Guide
Billing Overview
Billing Modes
Purchase Guide
Viewing Bills
Renewal
Overdue Policy
Refund Policy
Getting Started
Console Guide
Console Overview
Service Overview
Application Management
Media Management
Package Management
License Management
Real-Time Log Analysis
Practical Tutorial
Media Upload
Smart Cold Storage of VOD Media Asset Files
Video Processing
Distribution and Playback
How to Receive Event Notification
How to Migrate Files from Origin Server to VOD
Live Recording
How to Pull from Custom Origin Servers
How to Use EdgeOne to Distribute Content in VOD
Development Guide
Media Upload
Media Processing
Video AI
Event Notification
Video Playback
Media Encryption and Copyright Protection
Broadcast Channel
CAM
Media File Download
Subapplication System
Error Codes
Player SDK
Overview
Basic Concepts
Features
Free Demo
Free Trial License
Purchase Guide
SDK Download
Licenses
Player Guide
Integration (UI Included)
Integration (No UI)
Advanced Features
API Documentation
Player Adapter
Player SDK Policy
Server APIs
History
Introduction
API Category
Other APIs
Media Processing APIs
Parameter Template APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
FAQs
Mobile Playback
Fees
Video Upload
Video Publishing
Video Playback
Web Playback
Full Screen Playback
Statistics
Access Management
Cold Storage
Agreements
Service Level Agreement
VOD Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationVideo on DemandServer APIsVideo on Demand API 2024-07-18Data Types

Data Types

PDF
Focus Mode
Font Size
Last updated: 2025-10-30 22:08:12

Credentials

Credentials.

Used by actions: CreateStorageCredentials.

Name Type Description
AccessKeyId String Access Key ID.
SecretAccessKey String Secret Access Key.
SessionToken String The session token length depends on the binding policy and is no longer than 4096 bytes.
Expiration Timestamp ISO8601 The expiration time of the credentials.

Filter

Key-value pair filters for conditional filtering queries, such as filtering ID, name, and status.
If more than one filter exists, the logical relationship between these filters is AND.
If multiple values exist in one filter, the logical relationship between these values under the same filter is OR.

Used by actions: DescribeIncrementalMigrationStrategyInfos, DescribeStorage.

Name Type Required Description
Name String Yes Fields to be filtered.
Values Array of String Yes Value of the filtered field.

IncrementalMigrationHttpEndpointInfo

Incremental migration source address information.

Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

Name Type Required Description
Endpoint String Yes Address information, supporting domain names or IP addresses.
StandbyEndpointSet Array of String No Backup address information.

IncrementalMigrationHttpHeader

Incremental migration back-to-origin HTTP Header.

Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

Name Type Required Description
Key String Yes Header Key.
Value String Yes Header Value.

IncrementalMigrationHttpHeaderInfo

Incremental migration back-to-origin HTTP Header information.

Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

Name Type Required Description
HeaderFollowMode String Yes HTTP Header Passthrough Mode. Values valid:
  • FOLLOW_ALL: Pass through all header information;<\li>
  • FOLLOW_PART: Pass through partial header information;<\li>
  • IGNORE_PART: Ignore partial header information.<\li>
    		•
    FollowHttpHeaderKeySet Array of String No Header Key Set for Passthrough. This field is required only when the HeaderFollowMode is set to FOLLOW_PART.
    NewHttpHeaderSet Array of IncrementalMigrationHttpHeader No Add Header Key-Value Pair Collection.

    IncrementalMigrationHttpOriginCondition

    Incremental migration back-to-source conditions.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    HttpStatusCode Integer No HTTP code to trigger back-to-source conditions. If not filled, the default value is 404.
    Prefix String No Object key prefix to trigger back-to-source conditions

    IncrementalMigrationHttpOriginConfig

    Configuration of the origin for incremental migration back-to-source.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    OriginInfo IncrementalMigrationHttpOriginInfo Yes Origin information for back-to-source.
    OriginParameter IncrementalMigrationHttpOriginParameter Yes Back-to-source parameters.
    Mode String No Back-to-source mode. Valid values:
  • SYNC: Synchronous back-to-source;
  • ASYNC: Asynchronous back-to-source.
    		•
    OriginCondition IncrementalMigrationHttpOriginCondition No Back-to-source conditions.

    IncrementalMigrationHttpOriginInfo

    Incremental migration source information.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    EndpointInfo IncrementalMigrationHttpEndpointInfo Yes Incremental migration source address information.
    FileInfo IncrementalMigrationOriginFileInfo No Incremental migration source file information.

    IncrementalMigrationHttpOriginParameter

    Incremental migration back-to-source parameters.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    HttpHeaderInfo IncrementalMigrationHttpHeaderInfo Yes HTTP header passthrough information.
    Protocol String No Back-to-source protocol. Valid values:
  • HTTP: Force HTTP;
  • HTTPS: Force HTTPS;
  • FOLLOW: Follow the request protocol.
    		•
    QueryStringFollowMode String No Query string passthrough mode. Valid values
  • FOLLOW: Fully passthrough;
  • IGNORE: No passthrough at all.
    		•
    HttpRedirectCode Integer No HTTP Code for redirection. Currently, only 301, 302, and 307 are supported. The default value is 302.
    OriginRedirectionFollowMode String No Origin server redirection follow mode. Valid values:
  • FOLLOW: Follow origin server redirection;
  • IGNORE: Ignore origin server redirection.
    		•

    IncrementalMigrationOriginFileInfo

    Incremental migration of origin file information.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    PrefixConfig IncrementalMigrationOriginPrefixConfig No File prefix configuration.
    SuffixConfig IncrementalMigrationOriginSuffixConfig No File suffix configuration.
    FixedFileConfig IncrementalMigrationOriginFixedFileConfig No Fixed file configuration.

    IncrementalMigrationOriginFixedFileConfig

    Incremental migration of origin fixed file path configuration.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    FixedFilePath String No Fixed file path: If you fill in example/test.png, the origin-pull address will be: http(s)://<origin domain>/example/test.png.

    IncrementalMigrationOriginPrefixConfig

    Incremental migration of origin address prefix configuration.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    Prefix String No Origin address prefix: If you fill in test/, the origin-pull address will be http(s)://<origin domain>/test/<file name>.

    IncrementalMigrationOriginSuffixConfig

    Incremental migration of origin file suffix configuration.

    Used by actions: CreateIncrementalMigrationStrategy, DescribeIncrementalMigrationStrategyInfos, ModifyIncrementalMigrationStrategy.

    Name Type Required Description
    Suffix String No File suffix.
    if filled with .ts, the origin-pull address will be: http(s)://<origin domain>/<file name>.ts.

    IncrementalMigrationStrategyInfo

    Incremental migration strategy information.

    Used by actions: DescribeIncrementalMigrationStrategyInfos.

    Name Type Description
    StrategyId String The ID of the incremental migration strategy.
    StrategyName String The name of the incremental migration strategy.
    SubAppId Integer The ID of VOD Professional Application.
    BucketId String The bucket ID where the strategy takes effect.
    OriginType String Source type.
    HttpOriginConfig IncrementalMigrationHttpOriginConfig Incremental migration HTTP origin source configuration.

    SortBy

    Sort by criterion

    Used by actions: DescribeIncrementalMigrationStrategyInfos, DescribeStorage.

    Name Type Required Description
    Field String Yes Sort by field
    Order String Yes Sorting order. Valid values: Asc (ascending), Desc (descending)

    StorageInfo

    Storage information for the professional application.

    Used by actions: DescribeStorage.

    Name Type Description
    BucketId String The ID of bucket.
    StorageName String The name of bucket.
    StorageRegion String The region of storage.
    InternetAccessDomainStatus String The status of the internet access domain name is stored. Valid values:
  • ONLINE: Active;
  • DEPLOYING: In deployment.
    		•
    InternetAccessDomain String The internet access domain name of storage.
    CreateTime Timestamp ISO8601 The creation time of the storage.
    Previous Topic: DescribeIncrementalMigrationStrategyInfosNext Topic: Error Codes

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback