Call GenerateDownloadSecretKey to generate a secret key for secure download - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Generates a key for secure download. The secure download feature of ApsaraVideo Player SDK encrypts videos downloaded to local devices by using a key file. The encrypted videos can only be decrypted and played by using the key file generated by the unique app that is bindable in advance. This effectively protects video content and prevents downloaded videos from being maliciously played or distributed.

Operation description

To use the secure download feature, first enable the download feature in the ApsaraVideo VOD console and set the download method to secure download. For more information, see Download settings.
After generating a key for secure download, configure the key in ApsaraVideo Player SDK. For more information, see Secure download.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GenerateDownloadSecretKey

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppIdentification	string	Yes	The unique identity of the app. Android: the SHA-1 value of the keystore file. The obtained SHA-1 value is a character string with colons. iOS: the App Bundle ID value. Windows: the serial number of the digital signing certificate. For information about how to obtain the unique identity of the app, see Obtain the unique identity of the app.	BB:0D:AC:74:D3:21:09:EF:9C:71:1A:5E:77:2C:8E:BF:03:FD:FA:5A
AppDecryptKey	string	Yes	The custom encryption private key string. The string is 16 to 32 characters in length and consists of letters and digits. The string must contain uppercase letters, lowercase letters, and digits.	AppDecryptKeyAndroid20230101

Response elements

Element	Type	Description	Example
	object
AppEncryptKey	string	The generated secure download key.	***
RequestId	string	The request ID.	E99B9BAD-7F9D-552B-A689-B72E92EA040E

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.