AI 助理
文档备案控制台
官方文档
首页 密钥管理服务 密钥管理服务KMS 开发参考 API参考 OpenAPI API参考（KMS） API目录 密码运算 AsymmetricEncrypt - 使用非对称密钥进行加密

AsymmetricEncrypt - 使用非对称密钥进行加密

更新时间：
复制 MD 格式
产品详情
我的收藏

使用非对称密钥进行加密。

接口说明

注意事项

  • RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。

  • 本接口可以通过共享网关或专属网关调用。详细介绍，请参见阿里云 SDK。

    • 共享网关：通过公网、VPC 域名访问 KMS，该方式需要打开公网开关。具体操作，请参见通过公网访问 KMS 实例中的密钥。

    • 专属网关：通过 KMS 私网地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）访问 KMS。

QPS 限制

  • 通过共享网关调用：本接口的单用户 QPS 限制为 200 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

  • 通过专属网关调用：本接口的单用户 QPS 限制以您 KMS 实例的计算性能规格为准。详细介绍，请参见性能数据。

详细说明

仅支持 Usage 为ENCRYPT/DECRYPT的非对称密钥。支持的加密算法如下表：

KeySpecAlgorithm说明可加密的最大字节数
RSA_2048RSAES_OAEP_SHA_256RSAES-OAEP using SHA-256 and MGF1 with SHA-256190
RSA_2048RSAES_OAEP_SHA_1RSAES-OAEP using SHA1 and MGF1 with SHA1214
RSA_3072RSAES_OAEP_SHA_256RSAES-OAEP using SHA-256 and MGF1 with SHA-256318
RSA_3072RSAES_OAEP_SHA_1RSAES-OAEP using SHA1 and MGF1 with SHA1342
EC_SM2SM2PKESM2 椭圆曲线公钥加密算法6047

本文将提供一个示例，使用密钥 ID 为key-hzz630494463ejqjx**** 、密钥版本 ID 为2ab1a983-7072-4bbc-a582-584b5bd8****的非对称密钥，通过加密算法RSAES_OAEP_SHA_1对明文SGVsbG8gd29ybGQ=进行加密。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kms:AsymmetricEncrypt

get

*Key

acs:kms:{#regionId}:{#accountId}:key/{#KeyId}
  • kms:tag
 无

请求参数

名称

类型

必填

描述

示例值
Plaintext

string

是

要加密的明文，使用 Base64 编码。

SGVsbG8gd29ybGQ=
KeyId

string

是

密钥的 ID，也可以指定为密钥别名或密钥资源名称（ARN）。关于别名的详细介绍，请参见管理密钥别名。

说明

访问其他阿里云账号下的密钥时，必须输入密钥 ARN。密钥 ARN 的格式为acs:kms:${region}:${account}:key/${keyid}。

key-hzz630494463ejqjx****
KeyVersionId

string

是

密钥版本 ID。密钥版本的全局唯一标识符。

说明

您可以调用 ListKeyVersions 接口获取 KeyVersionId（密钥版本 ID）。

2ab1a983-7072-4bbc-a582-584b5bd8****
Algorithm

string

是

加密算法。

RSAES_OAEP_SHA_1
DryRun

string

否

是否开启 DryRun 模式。

  • true：开启

  • false（默认值）：关闭

DryRun 模式用于测试 API 调用，验证您是否具有相应资源的权限，以及请求参数是否配置正确。DryRun 模式开启后，KMS 会始终返回失败并提示失败原因。失败原因包含如下：

  • DryRunOperationError：不配置 DryRun 参数时，请求会成功。

  • ValidationError：请求中指定的参数有误。

  • AccessDeniedError：您无权在 KMS 资源上执行该操作。

false

返回参数

名称

类型

描述

示例值

object

KeyVersionId

string

对明文数据进行加密的主密钥版本号。

2ab1a983-7072-4bbc-a582-584b5bd8****
KeyId

string

密钥 ID。如果请求中的 KeyId 参数使用的是密钥别名、密钥 ARN，在响应中也会返回密钥 ID。

key-hzz630494463ejqjx****
CiphertextBlob

string

加密后的密文，使用 Base64 编码。

BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==
RequestId

string

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

475f1620-b9d3-4d35-b5c6-3fbdd941423d

示例

正常返回示例

JSON格式

{
  "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

错误码

HTTP status code

错误码

错误信息

描述
400 Rejected.UnsupportedOperation Unsupported operation. 不支持的操作
404 Forbidden.AliasNotFound The specified Alias is not found. 指定的别名找不到
404 Forbidden.KeyNotFound The specified Key is not found. 指定的密钥不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：AsymmetricVerify - 使用非对称密钥进行验签下一篇：AsymmetricDecrypt - 使用非对称密钥进行解密