Domain name for API request: kms.tencentcloudapi.com.
Re-encrypt the ciphertext using the specified CMK.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ReEncrypt. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
Region | No | String | Common Params. This parameter is not required for this API. |
CiphertextBlob | Yes | String | Ciphertext to be re-encrypted |
DestinationKeyId | No | String | CMK used for re-encryption. If this parameter is empty, the ciphertext will be re-encrypted by using the original CMK (as long as the key is not rotated, the ciphertext will not be refreshed) |
SourceEncryptionContext | No | String | JSON string of the key-value pair used during ciphertext encryption by CiphertextBlob . If not used during encryption, this parameter will be empty |
DestinationEncryptionContext | No | String | JSON string of the key-value pair used during re-encryption. If this field is used, the same string should be entered when the returned new ciphertext is decrypted |
Parameter Name | Type | Description |
---|---|---|
CiphertextBlob | String | Re-encrypted ciphertext |
KeyId | String | CMK used for re-encryption |
SourceKeyId | String | CMK used by ciphertext before re-encryption |
ReEncrypted | Boolean | true indicates that the ciphertext has been re-encrypted. When re-encryption is initiated by using the same CMK, as long as the CMK is not rotated, no actual re-encryption will be performed, and the original ciphertext will be returned |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Re-encrypt the ciphertext
https://kms.tencentcloudapi.com/?Action=ReEncrypt
&DestinationKeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&CiphertextBlob=Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL
&<Common request parameters>
{
"Response": {
"CiphertextBlob": "g2F8eQk44QrTbfj09TL17AZyFPgs8BTtZe2j27Wuw1YzTBCxnd0T/gwFQSasmtzxZi6mmvD7DCjCE+LxJmdhXQ==-k-zJshb0kBH7C2J5I3XXbbEg==-k-o1O+7H9HFAzWbCkftO2ZtPKewS3diSB4zGKOJhMn7LcKRhYr",
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
"SourceKeyId": "23e80852-1e38-11e9-b129-5cb9019b0000",
"ReEncrypted": true,
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue.InvalidCiphertext | Incorrect ciphertext format |
InvalidParameterValue.InvalidKeyId | Invalid KeyId . |
ResourceUnavailable.CmkDisabled | The CMK has been disabled. |
ResourceUnavailable.CmkNotFound | The CMK does not exist. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?