文档

API概览

更新时间:

本文介绍KMS实例API提供的API接口及相关描述。

密钥接口

使用KMS提供的密钥接口前,请关注以下信息:

  • AdvanceEncrypt、AdvanceDecrypt、AdvanceGenerateDataKey和GenerateDataKey:KMS密钥应为对称密钥。

  • Encrypt和Decrypt:KMS密钥可以为对称密钥,也可以为非对称密钥。

  • Sign、Verify和GetPublicKey:KMS密钥应为非对称密钥。

API

描述

AdvanceEncrypt

用于将明文数据通过KMS密钥加密为密文。

重要
  • 如果密钥开启了自动轮转,请您使用AdvanceEncrypt、AdvanceDecrypt和AdvanceGenerateDataKey接口,以避免轮转功能不生效。关于密钥轮转的相关内容,请参见密钥轮转

  • 您需要存储密文(CiphertextBlob)和认证数据(Aad),然后使用AdvanceDecrypt解密。

AdvanceDecrypt

将使用KMS密钥加密的密文解密为明文。

AdvanceGenerateDataKey

用于生成数据密钥,对数据按照KMS信封加密方式加密。

重要

您需要存储密文(CiphertextBlob)和认证数据(Aad),然后使用AdvanceDecrypt解密。

Encrypt

用于将明文数据通过KMS密钥加密为密文。

重要

您需要存储密钥的全局唯一标识符(KeyId)、密文(CiphertextBlob)、加密算法(Algorithm)、初始向量(Iv)、填充模式(PaddingMode)和认证数据(Aad),然后使用Decrypt或AdvanceDecrypt解密。

Decrypt

将使用KMS密钥加密的密文解密为明文。

GenerateDataKey

用于生成数据密钥,对数据按照KMS信封加密方式加密。

Sign

使用非对称密钥进行签名。

重要

您可以通过Verify接口验证签名,也可获取公钥(GetPublicKey)到本地自行验证签名。

Verify

使用非对称密钥进行验签。

GetPublicKey

获取指定非对称密钥的公钥。

凭据接口

API

描述

GetSecretValue

获取凭据值。

其他接口

API

描述

GenerateRandom

生成一个随机数。

  • 本页导读 (1)