tencent cloud



Last updated: 2024-03-27 16:09:48

    1. API Description

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

    This API is used to restore files from ARCHIVE or DEEP ARCHIVE. Files stored in ARCHIVE or DEEP ARCHIVE must be restored before they can be accessed. Restored files are available for a limited period of time.

    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: RestoreMedia.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    FileIds.N Yes Array of String Media file unique identifier list, maximum length: 100.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    RestoreDay No Integer The accessible duration of the unfrozen temporary media files must be greater than 0, and the unit is "days".
    RestoreTier No String The retrieval mode. If the current storage class is ARCHIVE, the valid values for this parameter are as follows:
  • Expedited: The files are made available in five minutes.
  • Standard: The files are made available in five hours.
  • Bulk: The files are made available in 12 hours.

  • If the current storage class is DEEP ARCHIVE, the valid values for this parameter are as follows:
  • Standard: The files are made available in 24 hours.
  • Bulk: The files are made available in 48 hours.
  • 3. Output Parameters

    Parameter Name Type Description
    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 Unfreeze media files using speed mode

    Unfreeze media files using speed mode

    Input Example

    &<Public Request Parameter>

    Output Example

        "Response": {
            "RequestId": "requestId"

    5. Developer Resources


    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.FileIds Incorrect FileIds parameter.
    InvalidParameterValue.NotRestorable Parameter error: The file cannot be restored.
    InvalidParameterValue.OriginalStorageClass Parameter error: Current storage class error.
    InvalidParameterValue.RestoreDay Parameter error: Invalid RestoreDay.
    InvalidParameterValue.RestoreTier Parameter error: Unsupported retrieval mode.
    InvalidParameterValue.UnsupportedRestoreTier Parameter error: This retrieval mode is not supported for the file.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.FileNotExist The resource does not exist: the file does not exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support