GenerateDataKeyWithoutPlaintext - Key Management Service

Generates a random data key, which can be used to encrypt on-premises data.

Usage notes

This API can be called through either a shared gateway or a dedicated gateway. For more information, see Alibaba Cloud SDK.

Shared gateway: Accesses KMS through public network or VPC domain names, using one of the following formats:
- Public network domain names: kms.<REGION_ID>.aliyuncs.com.
- VPC domain names: kms-vpc.<REGION_ID>.aliyuncs.com.
This method requires enabling public network access. For instructions, see Access KMS instance keys over the Internet.
Dedicated gateway: Access KMS through the KMS private network domain names, following the format: <YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com.

QPS Limits

When calling this API through a shared gateway: The API is rate-limited to 1000 queries per second (QPS) per Alibaba Cloud account. Exceeding this limit will result in throttling, which may impact your service. We recommend that you take note of the limit when you call this operation.
When calling this API through a dedicated gateway: The API's QPS limit per Alibaba Cloud account is determined by the compute performance specifications of your KMS instances. For more information on the compute performance specifications, see Performance quota.

Description

This operation creates a random data key, encrypts the data key by using a key, and then returns the data key ciphertext. The GenerateDataKeyWithoutPlaintext operation provides exactly the same functionality as the GenerateDataKey operation. The only difference is that the GenerateDataKeyWithoutPlaintext operation does not return the data key plaintext.

The key that you specify in the request of this operation is used to only encrypt the data key and is not involved in the generation of the data key. KMS does not record or store the generated data key.

Note

This operation applies to the scenario when you do not need to use the data key to encrypt data immediately. Before you can use the data key to encrypt data, you must call the Decrypt operation to decrypt the data key ciphertext.
This operation is also suitable for a distributed system with different trust levels. For example, a system stores data in different partitions based on a preset trust policy. A module of the system creates different partitions and generates different data keys for each partition. This module is not involved in data production and consumption after it completes the initialization of the control plane. This module is the key provider. When a module on the control plane produces and consumes data, the module obtains the data key ciphertext for each partition. After the module decrypts the data key ciphertext, the module uses the data key plaintext to encrypt or decrypt data and then deletes the data key plaintext from memory. In such a system, the key provider does not need to obtain the data key plaintext. It needs only to have the permissions to call the GenerateDataKeyWithoutPlaintext operation. The data producers or consumers do not need to generate new data keys. They need only to have the permissions to call the Decrypt operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	GenerateDataKeyWithoutPlaintext	The operation that you want to perform. Set the value to GenerateDataKeyWithoutPlaintext.
KeyId	String	Yes	599fa825-17de-417e-9554-bb032cc6****	The ID of the key. The ID must be globally unique. You can also set this parameter to an alias that is bound to the key. For more information, see Alias overview.
KeySpec	String	No	AES_256	The type of the data key that you want to generate. Valid values: AES_256: 256-bit symmetric key. AES_128: 128-bit symmetric key. Note We recommend that you use KeySpec or NumberOfBytes to specify the length of a data key. If none of the parameters are specified, KMS generates a 256-bit data key. If both parameters are specified, KMS ignores the KeySpec parameter.
NumberOfBytes	Integer	No	256	The length of the data key that you want to generate. Valid values: 1 to 1024. Unit: bytes.
EncryptionContext	Map	No	{"Example":"Example"}	The JSON string that consists of key-value pairs. If you configure this parameter, an equivalent value is required when you call the Decrypt operation. For more information, see EncryptionContext.
DryRun	String	No	false	Specifies whether to perform a dry run. Valid values: true false (default) A dry run is used for testing in API calls. You can perform a dry run to check whether you have the permissions to access the resources that you want to manage and whether the request parameters are correctly configured. If you set DryRun to true in the request, KMS always returns an error code that indicates the cause of the error. KMS may return the following error codes: DryRunOperationError: The request passes the dry run. If you do not configure the DryRun parameter and retain the other parameter configurations to call the same operation, the operation will be performed. ValidationError: A parameter value in the request is invalid. AccessDeniedError: You do not have the permissions to access the resources that you want to manage.

Response parameters

Parameter	Type	Example	Description
KeyVersionId	String	2ab1a983-7072-4bbc-a582-584b5bd8****	The version ID of the key that is used to encrypt the plaintext. The primary version of the key is used.
KeyId	String	599fa825-17de-417e-9554-bb032cc6****	The ID of the key. The ID must be globally unique. Note If you set KeyId to an alias of the key, the ID of the key to which the alias is bound is returned.
CiphertextBlob	String	ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****	The ciphertext of the data key that is encrypted by using the primary version of the key.
RequestId	String	7021b6ec-4be7-4d3c-8a68-1e85d4d515a0	The request ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GenerateDataKeyWithoutPlaintext
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&KeySpec=AES_256
&NumberOfBytes=256
&DryRun=false
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GenerateDataKeyWithoutPlaintextResponse>
    <KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
    <KeyId>599fa825-17de-417e-9554-bb032cc6****</KeyId>
    <CiphertextBlob>ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****</CiphertextBlob>
    <RequestId>7021b6ec-4be7-4d3c-8a68-1e85d4d515a0</RequestId>
</GenerateDataKeyWithoutPlaintextResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId" : "599fa825-17de-417e-9554-bb032cc6****",
  "CiphertextBlob" : "ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****",
  "RequestId" : "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0"
}

Error codes

HttpCode	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid.	The specified parameter is invalid.
404	Forbidden.KeyNotFound	The specified Key is not found.	The specified key does not exist.

For a list of error codes, see Service error codes.