All Products
Search
Document Center

ApsaraVideo VOD:GenerateDownloadSecretKey

Last Updated:Dec 19, 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GenerateDownloadSecretKeycreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdentificationstringYes

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.

BB:0D:AC:74:D3:21:09:EF:9C:71:1A:5E:77:2C:8E:BF:03:FD:FA:5A
AppDecryptKeystringYes

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

AppDecryptKeyAndroid20230101

Response parameters

ParameterTypeDescriptionExample
object
AppEncryptKeystring

The key file for secure download.

***
RequestIdstring

The ID of the request.

E99B9BAD-7F9D-552B-A689-B72E92EA040E

Examples

Sample success responses

JSONformat

{
  "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