Encrypt - 对称加密--密钥管理系统-火山引擎

文档中心

立即注册

导航

Encrypt - 对称加密

最近更新时间：2024.08.29 17:20:37首次发布时间：2024.08.29 17:20:37

对称加密

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	Encrypt	要执行的操作，取值：Encrypt。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	否	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	否	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyID	String	否	0324d9b3-c5d9-4b6f-94e7-884010a16fee	主密钥ID，二选一： KeyringName 和 KeyName KeyID
EncryptionContext	String	否	{"user":"alice","path":"path/to/alice/plaintext.txt"}	key/value的JSON字符串。如果指定了该参数，则在调用Decrypt时需要提供同样的参数。
Plaintext	String	是	tWB54tTvEu47YjRjuuj+fAt5PskpUaqwsjLeEy4YMNg=	加密的明文的Base64编码，取值：[1, 4096]

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
CiphertextBlob	String	43y7grE9TjamX4P7ZOHFbwAAqoNHFtMZ6RNyblKlEhIhrfP6zy034cwJN6MSqFGiDm8oiGqu2Rahs1aKPIcMjaOuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo=	明文加密后的密文，Base64编码

请求示例

POST /?Action=Encrypt&Version=2021-02-18&KeyringName=demo&KeyName=demo&KeyID=0324d9b3-c5d9-4b6f-94e7-884010a16fee HTTP/1.1
Host: kms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240708T064450Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Plaintext": "tWB54tTvEu47YjRjuuj+fAt5PskpUaqwsjLeEy4YMNg="
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407081445581770951421937A1E35",
    "Action": "Encrypt",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "CiphertextBlob": "43y7grE9TjamX4P7ZOHFbwAAqoNHFtMZ6RNyblKlEhIhrfP6zy034cwJN6MSqFGiDm8oiGqu2Rahs1aKPIcMjaOuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo="
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	InvalidParameter	The request parameter %s is invalid.
400	MissingParameter	The request is missing %s parameter.
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.CMK	The request of CMK: %s upper limit is exceeded.
403	KeyMaterialExpire	Key expire in, %s
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.