All Products
Document Center

ApsaraVideo VOD:GenerateKMSDataKey

Last Updated:Feb 08, 2023

Generates a random Key Management Service (KMS) data key used for HLS encryption in ApsaraVideo VOD.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
    All resources

Request parameters

The current API does not require request parameters

Response parameters


The returned data.


The ID of the request.


The ID of the customer master key (CMK). The ID must be globally unique.


The ciphertext of the encrypted data key. This is used as CipherText when you create a transcoding job.


The Base64-encoded plaintext of the data key.



Normal return example


  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "KeyId": "7906979c-8e06-46a2-be2d-68e3ccbc****",
  "CiphertextBlob": "ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****",
  "Plaintext": "QmFzZTY0IGVuY29kZWQgcGxhaW50****"

Error codes

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-07-27The input parameters of the API operation has changed
Change itemChange content
Input ParametersThe input parameters of the API operation has changed
    delete Input Parameters: ResourceRealOwnerId
    delete Input Parameters: KmsRegionId
2022-07-21Add Operation