KmsClient (tencentcloud-sdk-java 3.0.93 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)` 构造client
`KmsClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelKeyDeletionResponse`	`CancelKeyDeletion(CancelKeyDeletionRequest req)` 取消CMK的计划删除操作
`CreateKeyResponse`	`CreateKey(CreateKeyRequest req)` 创建用户管理数据密钥的主密钥CMK（Custom Master Key）。
`DecryptResponse`	`Decrypt(DecryptRequest req)` 本接口用于解密密文，得到明文数据。
`DescribeKeyResponse`	`DescribeKey(DescribeKeyRequest req)` 用于获取指定KeyId的主密钥属性详情信息。
`DescribeKeysResponse`	`DescribeKeys(DescribeKeysRequest req)` 该接口用于批量获取主密钥属性信息。
`DisableKeyResponse`	`DisableKey(DisableKeyRequest req)` 本接口用于禁用一个主密钥，处于禁用状态的Key无法用于加密、解密操作。
`DisableKeyRotationResponse`	`DisableKeyRotation(DisableKeyRotationRequest req)` 对指定的CMK禁止密钥轮换功能。
`DisableKeysResponse`	`DisableKeys(DisableKeysRequest req)` 该接口用于批量禁止CMK的使用。
`EnableKeyResponse`	`EnableKey(EnableKeyRequest req)` 用于启用一个指定的CMK。
`EnableKeyRotationResponse`	`EnableKeyRotation(EnableKeyRotationRequest req)` 对指定的CMK开启密钥轮换功能。
`EnableKeysResponse`	`EnableKeys(EnableKeysRequest req)` 该接口用于批量启用CMK。
`EncryptResponse`	`Encrypt(EncryptRequest req)` 本接口用于加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
`GenerateDataKeyResponse`	`GenerateDataKey(GenerateDataKeyRequest req)` 本接口生成一个数据密钥，您可以用这个密钥进行本地数据的加密。
`GetKeyRotationStatusResponse`	`GetKeyRotationStatus(GetKeyRotationStatusRequest req)` 查询指定的CMK是否开启了密钥轮换功能。
`GetServiceStatusResponse`	`GetServiceStatus(GetServiceStatusRequest req)` 用于查询该用户是否已开通KMS服务
`ListKeyDetailResponse`	`ListKeyDetail(ListKeyDetailRequest req)` 根据指定Offset和Limit获取主密钥列表详情。
`ListKeysResponse`	`ListKeys(ListKeysRequest req)` 列出账号下面的密钥列表（KeyId信息）。
`ReEncryptResponse`	`ReEncrypt(ReEncryptRequest req)` 使用指定CMK对密文重新加密。
`ScheduleKeyDeletionResponse`	`ScheduleKeyDeletion(ScheduleKeyDeletionRequest req)` CMK计划删除接口，用于指定CMK删除的时间，可选时间区间为[7,30]天
`UpdateAliasResponse`	`UpdateAlias(UpdateAliasRequest req)` 用于修改CMK的别名。
`UpdateKeyDescriptionResponse`	`UpdateKeyDescription(UpdateKeyDescriptionRequest req)` 该接口用于对指定的cmk修改描述信息。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - KmsClient
```
public KmsClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - CancelKeyDeletion
```
public CancelKeyDeletionResponse CancelKeyDeletion(CancelKeyDeletionRequest req)
                                            throws TencentCloudSDKException
```
    取消CMK的计划删除操作
    
    Parameters:
    
    req - CancelKeyDeletionRequest
    
    Returns:
    
    CancelKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateKey
```
public CreateKeyResponse CreateKey(CreateKeyRequest req)
                            throws TencentCloudSDKException
```
    创建用户管理数据密钥的主密钥CMK（Custom Master Key）。
    
    Parameters:
    
    req - CreateKeyRequest
    
    Returns:
    
    CreateKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - Decrypt
```
public DecryptResponse Decrypt(DecryptRequest req)
                        throws TencentCloudSDKException
```
    本接口用于解密密文，得到明文数据。
    
    Parameters:
    
    req - DecryptRequest
    
    Returns:
    
    DecryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKey
```
public DescribeKeyResponse DescribeKey(DescribeKeyRequest req)
                                throws TencentCloudSDKException
```
    用于获取指定KeyId的主密钥属性详情信息。
    
    Parameters:
    
    req - DescribeKeyRequest
    
    Returns:
    
    DescribeKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeKeys
```
public DescribeKeysResponse DescribeKeys(DescribeKeysRequest req)
                                  throws TencentCloudSDKException
```
    该接口用于批量获取主密钥属性信息。
    
    Parameters:
    
    req - DescribeKeysRequest
    
    Returns:
    
    DescribeKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKey
```
public DisableKeyResponse DisableKey(DisableKeyRequest req)
                              throws TencentCloudSDKException
```
    本接口用于禁用一个主密钥，处于禁用状态的Key无法用于加密、解密操作。
    
    Parameters:
    
    req - DisableKeyRequest
    
    Returns:
    
    DisableKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKeyRotation
```
public DisableKeyRotationResponse DisableKeyRotation(DisableKeyRotationRequest req)
                                              throws TencentCloudSDKException
```
    对指定的CMK禁止密钥轮换功能。
    
    Parameters:
    
    req - DisableKeyRotationRequest
    
    Returns:
    
    DisableKeyRotationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableKeys
```
public DisableKeysResponse DisableKeys(DisableKeysRequest req)
                                throws TencentCloudSDKException
```
    该接口用于批量禁止CMK的使用。
    
    Parameters:
    
    req - DisableKeysRequest
    
    Returns:
    
    DisableKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKey
```
public EnableKeyResponse EnableKey(EnableKeyRequest req)
                            throws TencentCloudSDKException
```
    用于启用一个指定的CMK。
    
    Parameters:
    
    req - EnableKeyRequest
    
    Returns:
    
    EnableKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKeyRotation
```
public EnableKeyRotationResponse EnableKeyRotation(EnableKeyRotationRequest req)
                                            throws TencentCloudSDKException
```
    对指定的CMK开启密钥轮换功能。
    
    Parameters:
    
    req - EnableKeyRotationRequest
    
    Returns:
    
    EnableKeyRotationResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableKeys
```
public EnableKeysResponse EnableKeys(EnableKeysRequest req)
                              throws TencentCloudSDKException
```
    该接口用于批量启用CMK。
    
    Parameters:
    
    req - EnableKeysRequest
    
    Returns:
    
    EnableKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - Encrypt
```
public EncryptResponse Encrypt(EncryptRequest req)
                        throws TencentCloudSDKException
```
    本接口用于加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
    
    Parameters:
    
    req - EncryptRequest
    
    Returns:
    
    EncryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - GenerateDataKey
```
public GenerateDataKeyResponse GenerateDataKey(GenerateDataKeyRequest req)
                                        throws TencentCloudSDKException
```
    本接口生成一个数据密钥，您可以用这个密钥进行本地数据的加密。
    
    Parameters:
    
    req - GenerateDataKeyRequest
    
    Returns:
    
    GenerateDataKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetKeyRotationStatus
```
public GetKeyRotationStatusResponse GetKeyRotationStatus(GetKeyRotationStatusRequest req)
                                                  throws TencentCloudSDKException
```
    查询指定的CMK是否开启了密钥轮换功能。
    
    Parameters:
    
    req - GetKeyRotationStatusRequest
    
    Returns:
    
    GetKeyRotationStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetServiceStatus
```
public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws TencentCloudSDKException
```
    用于查询该用户是否已开通KMS服务
    
    Parameters:
    
    req - GetServiceStatusRequest
    
    Returns:
    
    GetServiceStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListKeyDetail
```
public ListKeyDetailResponse ListKeyDetail(ListKeyDetailRequest req)
                                    throws TencentCloudSDKException
```
    根据指定Offset和Limit获取主密钥列表详情。
    
    Parameters:
    
    req - ListKeyDetailRequest
    
    Returns:
    
    ListKeyDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListKeys
```
public ListKeysResponse ListKeys(ListKeysRequest req)
                          throws TencentCloudSDKException
```
    列出账号下面的密钥列表（KeyId信息）。
    
    Parameters:
    
    req - ListKeysRequest
    
    Returns:
    
    ListKeysResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReEncrypt
```
public ReEncryptResponse ReEncrypt(ReEncryptRequest req)
                            throws TencentCloudSDKException
```
    使用指定CMK对密文重新加密。
    
    Parameters:
    
    req - ReEncryptRequest
    
    Returns:
    
    ReEncryptResponse
    
    Throws:
    
    TencentCloudSDKException
  - ScheduleKeyDeletion
```
public ScheduleKeyDeletionResponse ScheduleKeyDeletion(ScheduleKeyDeletionRequest req)
                                                throws TencentCloudSDKException
```
    CMK计划删除接口，用于指定CMK删除的时间，可选时间区间为[7,30]天
    
    Parameters:
    
    req - ScheduleKeyDeletionRequest
    
    Returns:
    
    ScheduleKeyDeletionResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateAlias
```
public UpdateAliasResponse UpdateAlias(UpdateAliasRequest req)
                                throws TencentCloudSDKException
```
    用于修改CMK的别名。
    
    Parameters:
    
    req - UpdateAliasRequest
    
    Returns:
    
    UpdateAliasResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateKeyDescription
```
public UpdateKeyDescriptionResponse UpdateKeyDescription(UpdateKeyDescriptionRequest req)
                                                  throws TencentCloudSDKException
```
    该接口用于对指定的cmk修改描述信息。
    
    Parameters:
    
    req - UpdateKeyDescriptionRequest
    
    Returns:
    
    UpdateKeyDescriptionResponse
    
    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

CancelKeyDeletion

CreateKey

Decrypt

DescribeKey

DescribeKeys

DisableKey

DisableKeyRotation

DisableKeys

EnableKey

EnableKeyRotation

EnableKeys

Encrypt

GenerateDataKey

GetKeyRotationStatus

GetServiceStatus

ListKeyDetail

ListKeys

ReEncrypt

ScheduleKeyDeletion

UpdateAlias

UpdateKeyDescription