方法:cryptoKeys.encrypt

全名:projects.locations.keyRings.cryptoKeys.encrypt

加密数据,以便数据只能通过调用 cryptoKeys.decrypt 来恢复。CryptoKey.purpose 必须是 ENCRYPT_DECRYPT

HTTP 请求

POST https://cloudkms.googleapis.com/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/**}:encrypt

网址使用 gRPC 转码语法。

路径参数

参数
name

string

必需。要用于加密的 CryptoKeyCryptoKeyVersion 的资源名称。

如果指定了 CryptoKey,则服务器将使用其 primary version

必须对指定的资源 name 具有以下 Google IAM 权限才能获得授权:

  • cloudkms.cryptoKeyVersions.useToEncrypt

请求正文

请求正文中包含结构如下的数据:

JSON 表示法

{
  "plaintext": string,
  "additionalAuthenticatedData": string
}
字段
plaintext

string (bytes format)

必需。要加密的数据。不得大于 64KiB。

最大大小取决于密钥版本的 protectionLevel。对于 SOFTWARE 密钥,明文不得大于 64KiB。对于 HSM 密钥,明文和 additionalAuthenticatedData 字段的总长度不得大于 8KiB。

base64 编码的字符串。

additionalAuthenticatedData

string (bytes format)

如果指定该字段,则还必须在解密过程中通过 DecryptRequest.additional_authenticated_data 提供可选数据。

最大大小取决于密钥版本的 protectionLevel。对于 SOFTWARE 密钥,AAD 不得大于 64KiB。对于 HSM 密钥,明文和 additionalAuthenticatedData 字段的总长度不得大于 8KiB。

base64 编码的字符串。

响应正文

如果成功,响应正文将包含结构如下的数据:

KeyManagementService.Encrypt 的响应消息。

JSON 表示法

{
  "name": string,
  "ciphertext": string
}
字段
name

string

加密中使用的 CryptoKeyVersion 的资源名称。

ciphertext

string (bytes format)

加密的数据。

base64 编码的字符串。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

立即试用!

此页内容是否有用?请给出您的反馈和评价:

发送以下问题的反馈:

此网页
Cloud KMS 文档