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

DescribeIncrementalMigrationStrategyInfos

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

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

Describe the information of the incremental migration strategy.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeIncrementalMigrationStrategyInfos.
Version Yes String Common Params. The value used for this API: 2024-07-18.
Region No String Common Params. This parameter is not required.
SubAppId Yes Integer The ID of VOD Professional Application.
Filters.N No Array of Filter Filter criteria. The maximum number of Filters.Values is 20. If this parameter is not input, all stategy information under the current SubAppId will be returned. The detailed filter criteria are as follows:
  • BucketId: Filter by the ID of bucket;
  • StrategyId: Filter by the ID of strategy.
  • SortBy No SortBy Sort the returned results according to this field.
    SortBy.Field Values include:
  • UpdateTime: (Default) Update time of the strategy.
  • SortBy.Order Values include:
  • Desc: (Default) The order is descend.

  • Offset No Integer Offset for paginated queries. Default value: 0.
    Limit No Integer Limit on paginated queries. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total count of matched strategies.
    StrategyInfoSet Array of IncrementalMigrationStrategyInfo Information of all matched strategies.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Describe the information of the incremental migration strategy for the application.

    Describe the information of the incremental migration strategy for the application.

    Input Example

    {
      "SubAppId": 1020304056,
      "SortBy": {
        "Field": "UpdateTime",
        "Order": "Asc"
      },
      "Offset": 0,
      "Limit": 10
    }

    Output Example

    {
        "Response": {
            "RequestId": "b6376a73-reqid-demo-b097-de6bb60b3976",
            "StrategyInfoSet": [
                {
                    "BucketId": "bucketid1",
                    "HttpOriginConfig": {
                        "Mode": "ASYNC",
                        "OriginCondition": {
                            "HttpStatusCode": 404,
                            "Prefix": "prefix/"
                        },
                        "OriginInfo": {
                            "EndpointInfo": {
                                "Endpoint": "example.com",
                                "StandbyEndpointSet": [
                                    "standby.com",
                                    "standby2.com"
                                ]
                            },
                            "FileInfo": {
                                "PrefixConfig": {
                                    "Prefix": "prefix"
                                },
                                "SuffixConfig": {
                                    "Suffix": "suffix"
                                }
                            }
                        },
                        "OriginParameter": {
                            "HttpHeaderInfo": {
                                "FollowHttpHeaderKeySet": [
                                    "Host"
                                ],
                                "HeaderFollowMode": "FOLLOW_ALL",
                                "NewHttpHeaderSet": [
                                    {
                                        "Key": "Host",
                                        "Value": "demo.com"
                                    }
                                ]
                            },
                            "HttpRedirectCode": 302,
                            "OriginRedirectionFollowMode": "FOLLOW",
                            "Protocol": "HTTP",
                            "QueryStringFollowMode": "FOLLOW"
                        }
                    },
                    "OriginType": "HTTP",
                    "StrategyId": "im-123-demoid",
                    "StrategyName": "my-strategy-1",
                    "SubAppId": 123456789
                },
                {
                    "BucketId": "bucketid2",
                    "HttpOriginConfig": {
                        "Mode": "SYNC",
                        "OriginCondition": {
                            "HttpStatusCode": 404
                        },
                        "OriginInfo": {
                            "EndpointInfo": {
                                "Endpoint": "example.com"
                            }
                        },
                        "OriginParameter": {
                            "HttpHeaderInfo": {
                                "HeaderFollowMode": "IGNORE_ALL",
                                "NewHttpHeaderSet": [
                                    {
                                        "Key": "host",
                                        "Value": "demo.com"
                                    }
                                ]
                            },
                            "HttpRedirectCode": 301,
                            "OriginRedirectionFollowMode": "FOLLOW",
                            "Protocol": "HTTPS",
                            "QueryStringFollowMode": "FOLLOW"
                        }
                    },
                    "OriginType": "HTTP",
                    "StrategyId": "im-123-demoid2",
                    "StrategyName": "my-strategy-2",
                    "SubAppId": 123456789
                }
            ],
            "TotalCount": 2
        }
    }

    Example2 Describe the information of the incremental migration strategy for the specified bucket of the application.

    Describe the information of the incremental migration strategy for the specified bucket of the application.

    Input Example

    {
      "SubAppId": 1020304056,
      "Filters": [
        {
          "Name": "BucketId",
          "Values": [
            "bucketid2"
          ]
        }
      ],
      "SortBy": {
        "Field": "UpdateTime",
        "Order": "Asc"
      },
      "Offset": 0,
      "Limit": 10
    }

    Output Example

    {
        "Response": {
            "RequestId": "a70a4fb9-reqid-demo-aa39-3282aa745a26",
            "StrategyInfoSet": [
                {
                    "BucketId": "bucketid2",
                    "HttpOriginConfig": {
                        "Mode": "SYNC",
                        "OriginCondition": {
                            "HttpStatusCode": 404
                        },
                        "OriginInfo": {
                            "EndpointInfo": {
                                "Endpoint": "example2.com"
                            }
                        },
                        "OriginParameter": {
                            "HttpHeaderInfo": {
                                "HeaderFollowMode": "IGNORE_ALL",
                                "NewHttpHeaderSet": [
                                    {
                                        "Key": "host",
                                        "Value": "demo.com"
                                    }
                                ]
                            },
                            "HttpRedirectCode": 301,
                            "OriginRedirectionFollowMode": "FOLLOW",
                            "Protocol": "HTTPS",
                            "QueryStringFollowMode": "FOLLOW"
                        }
                    },
                    "OriginType": "HTTP",
                    "StrategyId": "im-123-demoid2",
                    "StrategyName": "my-strategy-2",
                    "SubAppId": 123456789
                }
            ],
            "TotalCount": 1
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.

    Help and Support

    Was this page helpful?

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

    Feedback