AsymmetricSign_密钥管理服务_API文档-阿里云OpenAPI开发者门户

接口说明

注意事项

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

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

QPS 限制

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

详细说明

仅支持 Usage 为SIGN/VERIFY的非对称密钥。支持的签名算法如下表：

KeySpec	Algorithm	说明
RSA_2048	RSA_PSS_SHA_256	RSASSA-PSS using SHA-256 and MGF1 with SHA-256
RSA_2048	RSA_PKCS1_SHA_256	RSASSA-PKCS1-v1_5 using SHA-256
RSA_3072	RSA_PSS_SHA_256	RSASSA-PSS using SHA-256 and MGF1 with SHA-256
RSA_3072	RSA_PKCS1_SHA_256	RSASSA-PKCS1-v1_5 using SHA-256
EC_P256	ECDSA_SHA_256	ECDSA on the P-256 Curve(secp256r1) with a SHA-256 digest
EC_P256K	ECDSA_SHA_256	ECDSA on the P-256K Curve(secp256k1) with a SHA-256 digest
EC_SM2	SM2DSA	SM2 椭圆曲线数字签名算法

说明按照国家标准 GB/T 32918.2《信息安全技术 SM2 椭圆曲线公钥密码算法第 2 部分：数字签名算法》，计算 SM2 签名值时，Digest 参数不是对原始消息直接计算 SM3 摘要，而是对 Z(A)和 M 的拼接值计算的摘要，其中 M 是待签名的原始消息，Z(A)是 GB/T 32918.2 中定义的用户 A 的杂凑值。

本文将提供一个示例，使用密钥 ID 为5c438b18-05be-40ad-b6c2-3be6752c****、密钥版本 ID 为2ab1a983-7072-4bbc-a582-584b5bd8****的非对称密钥，通过签名算法RSA_PSS_SHA_256对摘要信息ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=进行签名。

流控信息

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

授权信息

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

请求参数

字段名称	字段详情
KeyIdstring	主密钥（CMK）的全局唯一标识符。展开详情示例值:5c438b18-05be-40ad-b6c2-3be6752c****参考取值来源: ListKeys CreateKey
KeyVersionIdstring	密钥版本 ID。密钥版本的全局唯一标识符。示例值:2ab1a983-7072-4bbc-a582-584b5bd8****参考取值来源: ListKeyVersions CreateKeyVersion GenerateAndExportDataKey
Algorithmstring	签名算法。示例值:RSA_PSS_SHA_256
Digeststring	使用 Algorithm 中对应的哈希算法，对原始消息生成的摘要。展开详情示例值:ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiu****=
DryRunstring	是否开启 DryRun 模式。展开详情示例值:false

返回参数

字段名称	字段详情
KeyVersionIdstring	密钥版本 ID。密钥版本的全局唯一标识符。示例值:2ab1a983-7072-4bbc-a582-584b5bd8****
KeyIdstring	主密钥的全局唯一标识符。展开详情示例值:5c438b18-05be-40ad-b6c2-3be6752c****
Valuestring	计算出来的签名。展开详情示例值:M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==
RequestIdstring	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例值:475f1620-b9d3-4d35-b5c6-3fbdd941423d

返回示例

错误码

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

全局错误码

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

400	InvalidParameter	The specified parameter is not valid.	诊断
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	诊断
404	Forbidden.KeyNotFound	The specified Key is not found.	诊断
404	Forbidden.AliasNotFound	The specified Alias is not found.	诊断

变更历史

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