Decrypt_密钥管理服务_API文档

2016-01-20

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

注意事项

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

共享网关：通过公网、VPC 域名访问 KMS，该方式需要打开公网开关。具体操作，请参见通过公网访问 KMS 实例中的密钥。
专属网关：通过 KMS 私网地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）访问 KMS。

QPS 限制

通过共享网关调用：本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。
通过专属网关调用：本接口的单用户 QPS 限制以您 KMS 实例的计算性能规格为准。详细介绍，请参见性能数据。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称	字段详情
CiphertextBlobstring	待解密的密文。展开详情示例值:DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
EncryptionContextobject	key/value 的 JSON 字符串。展开详情示例值:{"Example":"Example"}
DryRunstring	是否开启 DryRun 模式。展开详情示例值:false

返回参数

字段名称	字段详情
KeyVersionIdstring	主密钥下用于解密密文的密钥版本标识符。示例值:2ab1a983-7072-4bbc-a582-584b5bd8****
KeyIdstring	解密密文使用的主密钥 ID。展开详情示例值:202b9877-5a25-46e3-a763-e20791b5****
RequestIdstring	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例值:207596a2-36d3-4840-b1bd-f87044699bd7
Plaintextstring	解密后的明文。示例值:tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	UnsupportedOperation	This action is not supported.	诊断
404	Forbidden.AliasNotFound	The specified Alias is not found.	诊断
404	Forbidden.KeyNotFound	The specified Key is not found.	诊断
409	Rejected.Disabled	The request was rejected because the key state is Disabled.	诊断
409	Rejected.PendingDeletion	The request was rejected because the key state is PendingDeletion.	诊断
409	Rejected.Unavailable	The request was rejected because the key state is Unavailable.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-08-13	新增请求参数DryRun
	2023-12-20	变更错误码400 变更错误码404 新增错误码409
	2022-09-22	新增错误码400 新增错误码404

相关示例

对称密钥解密示例

通过调用 Decrypt 接口使用对称密钥进行解密示例

2023-03-29