GetPublicKey - 获取非对称密钥公钥_密钥管理服务(KMS)-阿里云帮助中心

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
本接口可以通过共享网关或专属网关调用。详细介绍，请参见阿里云 SDK。
- 共享网关：通过公网、VPC 域名访问 KMS，该方式需要打开公网开关。具体操作，请参见通过公网访问 KMS 实例中的密钥。
- 专属网关：通过 KMS 私网地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）访问 KMS。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
KeyId	string	是	主密钥（CMK）的全局唯一标识符。该参数也可以被指定为 CMK 绑定的别名，详情见别名使用说明。	5c438b18-05be-40ad-b6c2-3be6752c****
KeyVersionId	string	是	密钥版本的全局唯一标识符。	2ab1a983-7072-4bbc-a582-584b5bd8****
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	CMK 的全局唯一标识符。说明如果请求中的 KeyId 参数使用的是 CMK 的别名，在响应中会返回别名对应的 CMK 标识符。	5c438b18-05be-40ad-b6c2-3be6752c****
RequestId	string	随机的访问 ID。	475f1620-b9d3-4d35-b5c6-3fbdd941423d
PublicKey	string	PEM 格式的公钥。	-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\nJQIDAQAB\n-----END PUBLIC KEY-----\n

示例

正常返回示例

JSON格式

{
  "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId": "5c438b18-05be-40ad-b6c2-3be6752c****",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d",
  "PublicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\\nJQIDAQAB\\n-----END PUBLIC KEY-----\\n"
}

错误码

HTTP status code	错误码	错误信息	描述
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.	指定的密钥不存在。

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

变更历史

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