All Products
Document Center

ApsaraVideo VOD:GenerateDownloadSecretKey

Last Updated:May 11, 2024

Generates a key for secure download. ApsaraVideo Player SDK provides the secure download feature. Videos that are downloaded to your local device in this mode are encrypted. You can play the encrypted videos only by using the key file generated from the app that you specified. Secure download protects your videos from malicious playback or distribution.

Operation description

  • To use the secure download feature, you must enable the download feature in the ApsaraVideo VOD console and set the download method to secure download. For more information, see Configure download settings.
  • After you generate a key for secure download, you must configure the key in ApsaraVideo Player SDK. For more information, see Secure download.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters


The unique identifier of the app.

  • Android: the SHA-1 fingerprint of the keystore. The value is a string that contains a colon (:).
  • iOS: the bundle ID of the app.
  • Windows: the serial number in the digital signature certificate.

For more information about how to obtain the unique identifier of an app, see Obtain the unique app identifier.


A custom string of 16 to 32 characters in length. The string must contain uppercase letters, lowercase letters, and digits.


Response parameters


The key file for secure download.


The ID of the request.



Sample success responses


  "AppEncryptKey": "***",
  "RequestId": "E99B9BAD-7F9D-552B-A689-B72E92EA040E"

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history