KmsClient (tencentcloud-sdk-java-intl-en 3.0.1243 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.kms.v20190118.KmsClient

public class KmsClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`KmsClient(Credential credential, String region)`
`KmsClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArchiveKeyResponse`	`ArchiveKey(ArchiveKeyRequest req)` This API is used to archive keys.The archived keys can only be used for decryption but not encryption.
`AsymmetricRsaDecryptResponse`	`AsymmetricRsaDecrypt(AsymmetricRsaDecryptRequest req)` This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm.
`AsymmetricSm2DecryptResponse`	`AsymmetricSm2Decrypt(AsymmetricSm2DecryptRequest req)` This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm.
`BindCloudResourceResponse`	`BindCloudResource(BindCloudResourceRequest req)` This API is used to bind a key with a Tencent Cloud resource.
`CancelDataKeyDeletionResponse`	`CancelDataKeyDeletion(CancelDataKeyDeletionRequest req)` This API is used to cancel scheduled deletion for a data key.
`CancelKeyArchiveResponse`	`CancelKeyArchive(CancelKeyArchiveRequest req)` This API is used to unarchive keys.
`CancelKeyDeletionResponse`	`CancelKeyDeletion(CancelKeyDeletionRequest req)` Cancel the scheduled deletion of CMK
`CreateKeyResponse`	`CreateKey(CreateKeyRequest req)` Create a master key CMK (Custom Master Key) for user management data keys
`CreateWhiteBoxKeyResponse`	`CreateWhiteBoxKey(CreateWhiteBoxKeyRequest req)` This API is used to create a white-box key.
`DecryptResponse`	`Decrypt(DecryptRequest req)` This API is used to decrypt the ciphertext and obtain the plaintext data.
`DeleteImportedKeyMaterialResponse`	`DeleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest req)` This API is used to delete the imported key material.
`DeleteWhiteBoxKeyResponse`	`DeleteWhiteBoxKey(DeleteWhiteBoxKeyRequest req)` This API is used to delete a white-box key.
`DescribeDataKeyResponse`	`DescribeDataKey(DescribeDataKeyRequest req)` This API is used to retrieve data key details.
`DescribeDataKeysResponse`	`DescribeDataKeys(DescribeDataKeysRequest req)` This API is used to return the key attribute information list.
`DescribeKeyResponse`	`DescribeKey(DescribeKeyRequest req)` This API is used to get the attribute details of the CMK with a specified `KeyId`.
`DescribeKeysResponse`	`DescribeKeys(DescribeKeysRequest req)` This API is used to get the attribute information of CMKs in batches.
`DescribeWhiteBoxDecryptKeyResponse`	`DescribeWhiteBoxDecryptKey(DescribeWhiteBoxDecryptKeyRequest req)` This API is used to get a white-box decryption key.
`DescribeWhiteBoxDeviceFingerprintsResponse`	`DescribeWhiteBoxDeviceFingerprints(DescribeWhiteBoxDeviceFingerprintsRequest req)` This API is used to get the device fingerprint list of a specified key.
`DescribeWhiteBoxKeyResponse`	`DescribeWhiteBoxKey(DescribeWhiteBoxKeyRequest req)` This API is used to display white-box key information.
`DescribeWhiteBoxKeyDetailsResponse`	`DescribeWhiteBoxKeyDetails(DescribeWhiteBoxKeyDetailsRequest req)` This API is used to get the white-box key list.
`DescribeWhiteBoxServiceStatusResponse`	`DescribeWhiteBoxServiceStatus(DescribeWhiteBoxServiceStatusRequest req)` This API is used to get the white-box key service status.
`DisableDataKeyResponse`	`DisableDataKey(DisableDataKeyRequest req)` This API is used to disable the data key.
`DisableDataKeysResponse`	`DisableDataKeys(DisableDataKeysRequest req)` This API is used to batch disable data keys.
`DisableKeyResponse`	`DisableKey(DisableKeyRequest req)` This API is used to disable a master key.
`DisableKeyRotationResponse`	`DisableKeyRotation(DisableKeyRotationRequest req)` Disabled key rotation for the specified CMK.
`DisableKeysResponse`	`DisableKeys(DisableKeysRequest req)` This API is used to batch prohibit the use of CMK.
`DisableWhiteBoxKeyResponse`	`DisableWhiteBoxKey(DisableWhiteBoxKeyRequest req)` This API is used to disable a white-box key.
`DisableWhiteBoxKeysResponse`	`DisableWhiteBoxKeys(DisableWhiteBoxKeysRequest req)` This API is used to disable white-box keys in batches.
`EnableDataKeyResponse`	`EnableDataKey(EnableDataKeyRequest req)` This API is used to enable the data key.
`EnableDataKeysResponse`	`EnableDataKeys(EnableDataKeysRequest req)` This API is used to batch enable data keys.
`EnableKeyResponse`	`EnableKey(EnableKeyRequest req)` Enable a specified CMK.
`EnableKeyRotationResponse`	`EnableKeyRotation(EnableKeyRotationRequest req)` Turn on the key rotation function for the specified CMK.
`EnableKeysResponse`	`EnableKeys(EnableKeysRequest req)` This API is used to enable CMK in batches.
`EnableWhiteBoxKeyResponse`	`EnableWhiteBoxKey(EnableWhiteBoxKeyRequest req)` This API is used to enable a white-box key.
`EnableWhiteBoxKeysResponse`	`EnableWhiteBoxKeys(EnableWhiteBoxKeysRequest req)` This API is used to enable white-box keys in batches.
`EncryptResponse`	`Encrypt(EncryptRequest req)` This API is used to encrypt any data up to 4KB.
`EncryptByWhiteBoxResponse`	`EncryptByWhiteBox(EncryptByWhiteBoxRequest req)` This API is used to encrypt data with a white-box key.
`GenerateDataKeyResponse`	`GenerateDataKey(GenerateDataKeyRequest req)` This API generates a data key, which you can use to encrypt local data.
`GenerateRandomResponse`	`GenerateRandom(GenerateRandomRequest req)` This API is used to generate a random number.
`GetDataKeyCiphertextBlobResponse`	`GetDataKeyCiphertextBlob(GetDataKeyCiphertextBlobRequest req)` This API is used to download the encrypted data key.
`GetDataKeyPlaintextResponse`	`GetDataKeyPlaintext(GetDataKeyPlaintextRequest req)` This API is used to retrieve the key plaintext.
`GetKeyRotationStatusResponse`	`GetKeyRotationStatus(GetKeyRotationStatusRequest req)` Query whether the specified CMK has the key rotation function.
`GetParametersForImportResponse`	`GetParametersForImport(GetParametersForImportRequest req)` This API is used to obtain the parameters of the material to be imported into a CMK.
`GetPublicKeyResponse`	`GetPublicKey(GetPublicKeyRequest req)` This API is used to get the public key of an asymmetric KMS key (which must be enabled).
`GetRegionsResponse`	`GetRegions(GetRegionsRequest req)` This API is used to return all regions support KMS service.
`GetServiceStatusResponse`	`GetServiceStatus(GetServiceStatusRequest req)` Used to query whether the user has activated the KMS service.
`ImportDataKeyResponse`	`ImportDataKey(ImportDataKeyRequest req)` Data key import API, managed by KMS.
`ImportKeyMaterialResponse`	`ImportKeyMaterial(ImportKeyMaterialRequest req)` This API is used to import key material into an EXTERNAL CMK.
`ListAlgorithmsResponse`	`ListAlgorithms(ListAlgorithmsRequest req)` This API is used to list the encryption methods supported in the current region.
`ListDataKeyDetailResponse`	`ListDataKeyDetail(ListDataKeyDetailRequest req)` This API is used to retrieve data key list details based on specified Offset and Limit.
`ListDataKeysResponse`	`ListDataKeys(ListDataKeysRequest req)` This API is used to query the list of data keys.
`ListKeyDetailResponse`	`ListKeyDetail(ListKeyDetailRequest req)` Get the master key list details according to the specified Offset and Limit.
`ListKeysResponse`	`ListKeys(ListKeysRequest req)` This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.
`OverwriteWhiteBoxDeviceFingerprintsResponse`	`OverwriteWhiteBoxDeviceFingerprints(OverwriteWhiteBoxDeviceFingerprintsRequest req)` This API is used to overwrite the device fingerprint information of a specified key.
`PostQuantumCryptoDecryptResponse`	`PostQuantumCryptoDecrypt(PostQuantumCryptoDecryptRequest req)` This API is used to decrypt ciphertext using post-quantum cryptography (PQC) algorithm, and return the plaintext.
`PostQuantumCryptoEncryptResponse`	`PostQuantumCryptoEncrypt(PostQuantumCryptoEncryptRequest req)` This API is used to encrypt using PQC.
`PostQuantumCryptoSignResponse`	`PostQuantumCryptoSign(PostQuantumCryptoSignRequest req)` This API is used to sign using PQC.
`PostQuantumCryptoVerifyResponse`	`PostQuantumCryptoVerify(PostQuantumCryptoVerifyRequest req)` This API is used to verify a signature using PQC.
`ReEncryptResponse`	`ReEncrypt(ReEncryptRequest req)` Re-encrypt the ciphertext using the specified CMK.
`ScheduleDataKeyDeletionResponse`	`ScheduleDataKeyDeletion(ScheduleDataKeyDeletionRequest req)` Schedule deletion for a data key.
`ScheduleKeyDeletionResponse`	`ScheduleKeyDeletion(ScheduleKeyDeletionRequest req)` CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days
`SignByAsymmetricKeyResponse`	`SignByAsymmetricKey(SignByAsymmetricKeyRequest req)` This API is used to generate a signature with an asymmetric key.
`UnbindCloudResourceResponse`	`UnbindCloudResource(UnbindCloudResourceRequest req)` This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.
`UpdateAliasResponse`	`UpdateAlias(UpdateAliasRequest req)` This API is used to modify the alias of a CMK.
`UpdateDataKeyDescriptionResponse`	`UpdateDataKeyDescription(UpdateDataKeyDescriptionRequest req)` This API is used to modify the description of a data key.
`UpdateDataKeyNameResponse`	`UpdateDataKeyName(UpdateDataKeyNameRequest req)` This API is used to modify the data key name.
`UpdateKeyDescriptionResponse`	`UpdateKeyDescription(UpdateKeyDescriptionRequest req)` This API is used to modify the description of the specified CMK.
`VerifyByAsymmetricKeyResponse`	`VerifyByAsymmetricKey(VerifyByAsymmetricKeyRequest req)` This API is used to verify a signature with an asymmetric key.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KmsClient
```
public KmsClient(Credential credential,
                 String region)
```
  - KmsClient
```
public KmsClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - ArchiveKey
```
public ArchiveKeyResponse ArchiveKey(ArchiveKeyRequest req)
                              throws TencentCloudSDKException
```
    This API is used to archive keys.The archived keys can only be used for decryption but not encryption.
    
    Parameters:
    
    req - ArchiveKeyRequest
    
    Returns:
    
    ArchiveKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - AsymmetricRsaDecrypt
```
public AsymmetricRsaDecryptResponse AsymmetricRsaDecrypt(AsymmetricRsaDecryptRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption.
    
    Parameters:
    
    req - AsymmetricRsaDecryptRequest
    
    Returns:
    
    AsymmetricRsaDecryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - AsymmetricSm2Decrypt
```
public AsymmetricSm2DecryptResponse AsymmetricSm2Decrypt(AsymmetricSm2DecryptRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption. The length of the ciphertext passed in cannot exceed 256 bytes.
    
    Parameters:
    
    req - AsymmetricSm2DecryptRequest
    
    Returns:
    
    AsymmetricSm2DecryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindCloudResource
```
public BindCloudResourceResponse BindCloudResource(BindCloudResourceRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to bind a key with a Tencent Cloud resource. If the key has been set to be expired automatically, the setting will be canceled to ensure that the key will not be invalid automatically. If the key and the resource has already been bound, the call will still be successful.
    
    Parameters:
    
    req - BindCloudResourceRequest
    
    Returns:
    
    BindCloudResourceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelDataKeyDeletion
```
public CancelDataKeyDeletionResponse CancelDataKeyDeletion(CancelDataKeyDeletionRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to cancel scheduled deletion for a data key.
    
    Parameters:
    
    req - CancelDataKeyDeletionRequest
    
    Returns:
    
    CancelDataKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelKeyArchive
```
public CancelKeyArchiveResponse CancelKeyArchive(CancelKeyArchiveRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.
    
    Parameters:
    
    req - CancelKeyArchiveRequest
    
    Returns:
    
    CancelKeyArchiveResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelKeyDeletion
```
public CancelKeyDeletionResponse CancelKeyDeletion(CancelKeyDeletionRequest req)
                                            throws TencentCloudSDKException
```
    Cancel the scheduled deletion of CMK
    
    Parameters:
    
    req - CancelKeyDeletionRequest
    
    Returns:
    
    CancelKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateKey
```
public CreateKeyResponse CreateKey(CreateKeyRequest req)
                            throws TencentCloudSDKException
```
    Create a master key CMK (Custom Master Key) for user management data keys
    
    Parameters:
    
    req - CreateKeyRequest
    
    Returns:
    
    CreateKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateWhiteBoxKey
```
public CreateWhiteBoxKeyResponse CreateWhiteBoxKey(CreateWhiteBoxKeyRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to create a white-box key. Up to 50 ones can be created.
    
    Parameters:
    
    req - CreateWhiteBoxKeyRequest
    
    Returns:
    
    CreateWhiteBoxKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - Decrypt
```
public DecryptResponse Decrypt(DecryptRequest req)
                        throws TencentCloudSDKException
```
    This API is used to decrypt the ciphertext and obtain the plaintext data.
    
    Parameters:
    
    req - DecryptRequest
    
    Returns:
    
    DecryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteImportedKeyMaterial
```
public DeleteImportedKeyMaterialResponse DeleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into `PendingImport` status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the `ScheduleKeyDeletion` API.
    
    Parameters:
    
    req - DeleteImportedKeyMaterialRequest
    
    Returns:
    
    DeleteImportedKeyMaterialResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteWhiteBoxKey
```
public DeleteWhiteBoxKeyResponse DeleteWhiteBoxKey(DeleteWhiteBoxKeyRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to delete a white-box key. Note: only disabled white-box keys can be deleted.
    
    Parameters:
    
    req - DeleteWhiteBoxKeyRequest
    
    Returns:
    
    DeleteWhiteBoxKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDataKey
```
public DescribeDataKeyResponse DescribeDataKey(DescribeDataKeyRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to retrieve data key details.
    
    Parameters:
    
    req - DescribeDataKeyRequest
    
    Returns:
    
    DescribeDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDataKeys
```
public DescribeDataKeysResponse DescribeDataKeys(DescribeDataKeysRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to return the key attribute information list.
    
    Parameters:
    
    req - DescribeDataKeysRequest
    
    Returns:
    
    DescribeDataKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKey
```
public DescribeKeyResponse DescribeKey(DescribeKeyRequest req)
                                throws TencentCloudSDKException
```
    This API is used to get the attribute details of the CMK with a specified `KeyId`.
    
    Parameters:
    
    req - DescribeKeyRequest
    
    Returns:
    
    DescribeKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKeys
```
public DescribeKeysResponse DescribeKeys(DescribeKeysRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to get the attribute information of CMKs in batches.
    
    Parameters:
    
    req - DescribeKeysRequest
    
    Returns:
    
    DescribeKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteBoxDecryptKey
```
public DescribeWhiteBoxDecryptKeyResponse DescribeWhiteBoxDecryptKey(DescribeWhiteBoxDecryptKeyRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to get a white-box decryption key.
    
    Parameters:
    
    req - DescribeWhiteBoxDecryptKeyRequest
    
    Returns:
    
    DescribeWhiteBoxDecryptKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteBoxDeviceFingerprints
```
public DescribeWhiteBoxDeviceFingerprintsResponse DescribeWhiteBoxDeviceFingerprints(DescribeWhiteBoxDeviceFingerprintsRequest req)
                                                                              throws TencentCloudSDKException
```
    This API is used to get the device fingerprint list of a specified key.
    
    Parameters:
    
    req - DescribeWhiteBoxDeviceFingerprintsRequest
    
    Returns:
    
    DescribeWhiteBoxDeviceFingerprintsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteBoxKey
```
public DescribeWhiteBoxKeyResponse DescribeWhiteBoxKey(DescribeWhiteBoxKeyRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to display white-box key information.
    
    Parameters:
    
    req - DescribeWhiteBoxKeyRequest
    
    Returns:
    
    DescribeWhiteBoxKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteBoxKeyDetails
```
public DescribeWhiteBoxKeyDetailsResponse DescribeWhiteBoxKeyDetails(DescribeWhiteBoxKeyDetailsRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to get the white-box key list.
    
    Parameters:
    
    req - DescribeWhiteBoxKeyDetailsRequest
    
    Returns:
    
    DescribeWhiteBoxKeyDetailsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteBoxServiceStatus
```
public DescribeWhiteBoxServiceStatusResponse DescribeWhiteBoxServiceStatus(DescribeWhiteBoxServiceStatusRequest req)
                                                                    throws TencentCloudSDKException
```
    This API is used to get the white-box key service status.
    
    Parameters:
    
    req - DescribeWhiteBoxServiceStatusRequest
    
    Returns:
    
    DescribeWhiteBoxServiceStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableDataKey
```
public DisableDataKeyResponse DisableDataKey(DisableDataKeyRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to disable the data key.
    
    Parameters:
    
    req - DisableDataKeyRequest
    
    Returns:
    
    DisableDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableDataKeys
```
public DisableDataKeysResponse DisableDataKeys(DisableDataKeysRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to batch disable data keys.
    
    Parameters:
    
    req - DisableDataKeysRequest
    
    Returns:
    
    DisableDataKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKey
```
public DisableKeyResponse DisableKey(DisableKeyRequest req)
                              throws TencentCloudSDKException
```
    This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.
    
    Parameters:
    
    req - DisableKeyRequest
    
    Returns:
    
    DisableKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKeyRotation
```
public DisableKeyRotationResponse DisableKeyRotation(DisableKeyRotationRequest req)
                                              throws TencentCloudSDKException
```
    Disabled key rotation for the specified CMK.
    
    Parameters:
    
    req - DisableKeyRotationRequest
    
    Returns:
    
    DisableKeyRotationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKeys
```
public DisableKeysResponse DisableKeys(DisableKeysRequest req)
                                throws TencentCloudSDKException
```
    This API is used to batch prohibit the use of CMK.
    
    Parameters:
    
    req - DisableKeysRequest
    
    Returns:
    
    DisableKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableWhiteBoxKey
```
public DisableWhiteBoxKeyResponse DisableWhiteBoxKey(DisableWhiteBoxKeyRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to disable a white-box key.
    
    Parameters:
    
    req - DisableWhiteBoxKeyRequest
    
    Returns:
    
    DisableWhiteBoxKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableWhiteBoxKeys
```
public DisableWhiteBoxKeysResponse DisableWhiteBoxKeys(DisableWhiteBoxKeysRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to disable white-box keys in batches.
    
    Parameters:
    
    req - DisableWhiteBoxKeysRequest
    
    Returns:
    
    DisableWhiteBoxKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableDataKey
```
public EnableDataKeyResponse EnableDataKey(EnableDataKeyRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to enable the data key.
    
    Parameters:
    
    req - EnableDataKeyRequest
    
    Returns:
    
    EnableDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableDataKeys
```
public EnableDataKeysResponse EnableDataKeys(EnableDataKeysRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to batch enable data keys.
    
    Parameters:
    
    req - EnableDataKeysRequest
    
    Returns:
    
    EnableDataKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKey
```
public EnableKeyResponse EnableKey(EnableKeyRequest req)
                            throws TencentCloudSDKException
```
    Enable a specified CMK.
    
    Parameters:
    
    req - EnableKeyRequest
    
    Returns:
    
    EnableKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKeyRotation
```
public EnableKeyRotationResponse EnableKeyRotation(EnableKeyRotationRequest req)
                                            throws TencentCloudSDKException
```
    Turn on the key rotation function for the specified CMK.
    
    Parameters:
    
    req - EnableKeyRotationRequest
    
    Returns:
    
    EnableKeyRotationResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKeys
```
public EnableKeysResponse EnableKeys(EnableKeysRequest req)
                              throws TencentCloudSDKException
```
    This API is used to enable CMK in batches.
    
    Parameters:
    
    req - EnableKeysRequest
    
    Returns:
    
    EnableKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableWhiteBoxKey
```
public EnableWhiteBoxKeyResponse EnableWhiteBoxKey(EnableWhiteBoxKeyRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to enable a white-box key.
    
    Parameters:
    
    req - EnableWhiteBoxKeyRequest
    
    Returns:
    
    EnableWhiteBoxKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableWhiteBoxKeys
```
public EnableWhiteBoxKeysResponse EnableWhiteBoxKeys(EnableWhiteBoxKeysRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to enable white-box keys in batches.
    
    Parameters:
    
    req - EnableWhiteBoxKeysRequest
    
    Returns:
    
    EnableWhiteBoxKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - Encrypt
```
public EncryptResponse Encrypt(EncryptRequest req)
                        throws TencentCloudSDKException
```
    This API is used to encrypt any data up to 4KB. It can be used to encrypt database passwords, RSA Key, or other small sensitive information. For application data encryption, use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations
    
    Parameters:
    
    req - EncryptRequest
    
    Returns:
    
    EncryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - EncryptByWhiteBox
```
public EncryptByWhiteBoxResponse EncryptByWhiteBox(EncryptByWhiteBoxRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to encrypt data with a white-box key.
    
    Parameters:
    
    req - EncryptByWhiteBoxRequest
    
    Returns:
    
    EncryptByWhiteBoxResponse
    
    Throws:
    
    TencentCloudSDKException
  - GenerateDataKey
```
public GenerateDataKeyResponse GenerateDataKey(GenerateDataKeyRequest req)
                                        throws TencentCloudSDKException
```
    This API generates a data key, which you can use to encrypt local data.
    
    Parameters:
    
    req - GenerateDataKeyRequest
    
    Returns:
    
    GenerateDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - GenerateRandom
```
public GenerateRandomResponse GenerateRandom(GenerateRandomRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to generate a random number.
    
    Parameters:
    
    req - GenerateRandomRequest
    
    Returns:
    
    GenerateRandomResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDataKeyCiphertextBlob
```
public GetDataKeyCiphertextBlobResponse GetDataKeyCiphertextBlob(GetDataKeyCiphertextBlobRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to download the encrypted data key.
    
    Parameters:
    
    req - GetDataKeyCiphertextBlobRequest
    
    Returns:
    
    GetDataKeyCiphertextBlobResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetDataKeyPlaintext
```
public GetDataKeyPlaintextResponse GetDataKeyPlaintext(GetDataKeyPlaintextRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to retrieve the key plaintext.
    
    Parameters:
    
    req - GetDataKeyPlaintextRequest
    
    Returns:
    
    GetDataKeyPlaintextResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetKeyRotationStatus
```
public GetKeyRotationStatusResponse GetKeyRotationStatus(GetKeyRotationStatusRequest req)
                                                  throws TencentCloudSDKException
```
    Query whether the specified CMK has the key rotation function.
    
    Parameters:
    
    req - GetKeyRotationStatusRequest
    
    Returns:
    
    GetKeyRotationStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetParametersForImport
```
public GetParametersForImportResponse GetParametersForImport(GetParametersForImportRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to obtain the parameters of the material to be imported into a CMK. The returned `Token` is used as one of the parameters to execute `ImportKeyMaterial`, and the returned `PublicKey` is used to encrypt the key material. The `Token` and `PublicKey` are valid for 24 hours. If they are expired, you will need to call the API again to get a new `Token` and `PublicKey`.
    
    Parameters:
    
    req - GetParametersForImportRequest
    
    Returns:
    
    GetParametersForImportResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPublicKey
```
public GetPublicKeyResponse GetPublicKey(GetPublicKeyRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to get the public key of an asymmetric KMS key (which must be enabled). With the public key, you can encrypt messages and verify signatures.
    
    Parameters:
    
    req - GetPublicKeyRequest
    
    Returns:
    
    GetPublicKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetRegions
```
public GetRegionsResponse GetRegions(GetRegionsRequest req)
                              throws TencentCloudSDKException
```
    This API is used to return all regions support KMS service.
    
    Parameters:
    
    req - GetRegionsRequest
    
    Returns:
    
    GetRegionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetServiceStatus
```
public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws TencentCloudSDKException
```
    Used to query whether the user has activated the KMS service.
    
    Parameters:
    
    req - GetServiceStatusRequest
    
    Returns:
    
    GetServiceStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ImportDataKey
```
public ImportDataKeyResponse ImportDataKey(ImportDataKeyRequest req)
                                    throws TencentCloudSDKException
```
    Data key import API, managed by KMS.
    
    Parameters:
    
    req - ImportDataKeyRequest
    
    Returns:
    
    ImportDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ImportKeyMaterial
```
public ImportKeyMaterialResponse ImportKeyMaterial(ImportKeyMaterialRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one. Key material can only be imported into CMKs in `Enabled` and `PendingImport` status.
    
    Parameters:
    
    req - ImportKeyMaterialRequest
    
    Returns:
    
    ImportKeyMaterialResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListAlgorithms
```
public ListAlgorithmsResponse ListAlgorithms(ListAlgorithmsRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to list the encryption methods supported in the current region.
    
    Parameters:
    
    req - ListAlgorithmsRequest
    
    Returns:
    
    ListAlgorithmsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListDataKeyDetail
```
public ListDataKeyDetailResponse ListDataKeyDetail(ListDataKeyDetailRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to retrieve data key list details based on specified Offset and Limit.
    
    Parameters:
    
    req - ListDataKeyDetailRequest
    
    Returns:
    
    ListDataKeyDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListDataKeys
```
public ListDataKeysResponse ListDataKeys(ListDataKeysRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to query the list of data keys.
    
    Parameters:
    
    req - ListDataKeysRequest
    
    Returns:
    
    ListDataKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListKeyDetail
```
public ListKeyDetailResponse ListKeyDetail(ListKeyDetailRequest req)
                                    throws TencentCloudSDKException
```
    Get the master key list details according to the specified Offset and Limit.
    
    Parameters:
    
    req - ListKeyDetailRequest
    
    Returns:
    
    ListKeyDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListKeys
```
public ListKeysResponse ListKeys(ListKeysRequest req)
                          throws TencentCloudSDKException
```
    This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.
    
    Parameters:
    
    req - ListKeysRequest
    
    Returns:
    
    ListKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - OverwriteWhiteBoxDeviceFingerprints
```
public OverwriteWhiteBoxDeviceFingerprintsResponse OverwriteWhiteBoxDeviceFingerprints(OverwriteWhiteBoxDeviceFingerprintsRequest req)
                                                                                throws TencentCloudSDKException
```
    This API is used to overwrite the device fingerprint information of a specified key.
    
    Parameters:
    
    req - OverwriteWhiteBoxDeviceFingerprintsRequest
    
    Returns:
    
    OverwriteWhiteBoxDeviceFingerprintsResponse
    
    Throws:
    
    TencentCloudSDKException
  - PostQuantumCryptoDecrypt
```
public PostQuantumCryptoDecryptResponse PostQuantumCryptoDecrypt(PostQuantumCryptoDecryptRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to decrypt ciphertext using post-quantum cryptography (PQC) algorithm, and return the plaintext.
    
    Parameters:
    
    req - PostQuantumCryptoDecryptRequest
    
    Returns:
    
    PostQuantumCryptoDecryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - PostQuantumCryptoEncrypt
```
public PostQuantumCryptoEncryptResponse PostQuantumCryptoEncrypt(PostQuantumCryptoEncryptRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to encrypt using PQC. It supports up to 4 KB of data. It is applicable for encryption of database passwords, RSA keys, or other sensitive information. You can also apply `DataKey` generated by API `GenerateDataKey` to encrypt or decrypt your local data.
    
    Parameters:
    
    req - PostQuantumCryptoEncryptRequest
    
    Returns:
    
    PostQuantumCryptoEncryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - PostQuantumCryptoSign
```
public PostQuantumCryptoSignResponse PostQuantumCryptoSign(PostQuantumCryptoSignRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to sign using PQC.
    
    Parameters:
    
    req - PostQuantumCryptoSignRequest
    
    Returns:
    
    PostQuantumCryptoSignResponse
    
    Throws:
    
    TencentCloudSDKException
  - PostQuantumCryptoVerify
```
public PostQuantumCryptoVerifyResponse PostQuantumCryptoVerify(PostQuantumCryptoVerifyRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to verify a signature using PQC.
    
    Parameters:
    
    req - PostQuantumCryptoVerifyRequest
    
    Returns:
    
    PostQuantumCryptoVerifyResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReEncrypt
```
public ReEncryptResponse ReEncrypt(ReEncryptRequest req)
                            throws TencentCloudSDKException
```
    Re-encrypt the ciphertext using the specified CMK.
    
    Parameters:
    
    req - ReEncryptRequest
    
    Returns:
    
    ReEncryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - ScheduleDataKeyDeletion
```
public ScheduleDataKeyDeletionResponse ScheduleDataKeyDeletion(ScheduleDataKeyDeletionRequest req)
                                                        throws TencentCloudSDKException
```
    Schedule deletion for a data key.
    
    Parameters:
    
    req - ScheduleDataKeyDeletionRequest
    
    Returns:
    
    ScheduleDataKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - ScheduleKeyDeletion
```
public ScheduleKeyDeletionResponse ScheduleKeyDeletion(ScheduleKeyDeletionRequest req)
                                                throws TencentCloudSDKException
```
    CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days
    
    Parameters:
    
    req - ScheduleKeyDeletionRequest
    
    Returns:
    
    ScheduleKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - SignByAsymmetricKey
```
public SignByAsymmetricKeyResponse SignByAsymmetricKey(SignByAsymmetricKeyRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to generate a signature with an asymmetric key. Note that only when KeyUsage is `ASYMMETRIC_SIGN_VERIFY_${ALGORITHM}` (e.g., `ASYMMETRIC_SIGN_VERIFY_SM2` and `ASYMMETRIC_SIGN_VERIFY_ECC`), the key can be used for signing.
    
    Parameters:
    
    req - SignByAsymmetricKeyRequest
    
    Returns:
    
    SignByAsymmetricKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindCloudResource
```
public UnbindCloudResourceResponse UnbindCloudResource(UnbindCloudResourceRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.
    
    Parameters:
    
    req - UnbindCloudResourceRequest
    
    Returns:
    
    UnbindCloudResourceResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateAlias
```
public UpdateAliasResponse UpdateAlias(UpdateAliasRequest req)
                                throws TencentCloudSDKException
```
    This API is used to modify the alias of a CMK. CMKs in `PendingDelete` status cannot be modified.
    
    Parameters:
    
    req - UpdateAliasRequest
    
    Returns:
    
    UpdateAliasResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDataKeyDescription
```
public UpdateDataKeyDescriptionResponse UpdateDataKeyDescription(UpdateDataKeyDescriptionRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to modify the description of a data key.
    
    Parameters:
    
    req - UpdateDataKeyDescriptionRequest
    
    Returns:
    
    UpdateDataKeyDescriptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDataKeyName
```
public UpdateDataKeyNameResponse UpdateDataKeyName(UpdateDataKeyNameRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to modify the data key name.
    
    Parameters:
    
    req - UpdateDataKeyNameRequest
    
    Returns:
    
    UpdateDataKeyNameResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateKeyDescription
```
public UpdateKeyDescriptionResponse UpdateKeyDescription(UpdateKeyDescriptionRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.
    
    Parameters:
    
    req - UpdateKeyDescriptionRequest
    
    Returns:
    
    UpdateKeyDescriptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - VerifyByAsymmetricKey
```
public VerifyByAsymmetricKeyResponse VerifyByAsymmetricKey(VerifyByAsymmetricKeyRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to verify a signature with an asymmetric key.
    
    Parameters:
    
    req - VerifyByAsymmetricKeyRequest
    
    Returns:
    
    VerifyByAsymmetricKeyResponse
    
    Throws:
    
    TencentCloudSDKException

Class KmsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

KmsClient

KmsClient

Method Detail

ArchiveKey

AsymmetricRsaDecrypt

AsymmetricSm2Decrypt

BindCloudResource

CancelDataKeyDeletion

CancelKeyArchive

CancelKeyDeletion

CreateKey

CreateWhiteBoxKey

Decrypt

DeleteImportedKeyMaterial

DeleteWhiteBoxKey

DescribeDataKey

DescribeDataKeys

DescribeKey

DescribeKeys

DescribeWhiteBoxDecryptKey

DescribeWhiteBoxDeviceFingerprints

DescribeWhiteBoxKey

DescribeWhiteBoxKeyDetails

DescribeWhiteBoxServiceStatus

DisableDataKey

DisableDataKeys

DisableKey

DisableKeyRotation

DisableKeys

DisableWhiteBoxKey

DisableWhiteBoxKeys

EnableDataKey

EnableDataKeys

EnableKey

EnableKeyRotation

EnableKeys

EnableWhiteBoxKey

EnableWhiteBoxKeys

Encrypt

EncryptByWhiteBox

GenerateDataKey

GenerateRandom

GetDataKeyCiphertextBlob

GetDataKeyPlaintext

GetKeyRotationStatus

GetParametersForImport

GetPublicKey

GetRegions

GetServiceStatus

ImportDataKey

ImportKeyMaterial

ListAlgorithms

ListDataKeyDetail

ListDataKeys

ListKeyDetail

ListKeys

OverwriteWhiteBoxDeviceFingerprints

PostQuantumCryptoDecrypt

PostQuantumCryptoEncrypt

PostQuantumCryptoSign

PostQuantumCryptoVerify

ReEncrypt

ScheduleDataKeyDeletion

ScheduleKeyDeletion

SignByAsymmetricKey

UnbindCloudResource

UpdateAlias

UpdateDataKeyDescription

UpdateDataKeyName

UpdateKeyDescription

VerifyByAsymmetricKey