All Products
Search
Document Center

ApsaraVideo VOD:DecryptKMSDataKey

Last Updated:Feb 08, 2023

Decrypts the ciphertext specified by CiphertextBlob in the Key Management Service (KMS) data key.

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
vod:DecryptKMSDataKeyRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
CipherTextstringYes

The ciphertext that you want to decrypt.

DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

25818875-5F78-4A*****F6-D7393642CA58
KeyIdstring

The ID of the customer master key (CMK) that was used to decrypt the ciphertext.

202b9877-5a25-46e3-a763-e20791b5****
Plaintextstring

The plaintext that is generated after decryption.

tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****

Example

Normal return example

JSONFormat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "KeyId": "202b9877-5a25-46e3-a763-e20791b5****",
  "Plaintext": "tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****"
}

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