Todos os produtos
Search
Central de documentação

Key Management Service:GetPublicKey

Última atualização: Jun 28, 2026

Obtém a chave pública de uma chave assimétrica. Você pode usar a chave pública para criptografar dados ou verificar uma assinatura no seu dispositivo.

Descrição da operação

  • Para mais informações sobre a política de acesso necessária para que um usuário RAM ou função RAM chame esta operação OpenAPI, consulte Resource Access Management.

  • Esta operação suporta tanto gateways compartilhados quanto gateways dedicados. Para mais informações, consulte Alibaba Cloud SDK.

    • Gateway compartilhado: Você pode acessar o KMS pela Internet ou usando um nome de domínio VPC. Se você acessar o KMS pela Internet, deverá habilitar o acesso à Internet. Para mais informações, consulte Acessar chaves em uma instância KMS pela Internet.

    • Gateway dedicado: Você pode acessar o KMS usando o endpoint privado do KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

KeyId

string

Sim

O identificador globalmente exclusivo da chave mestra do cliente (CMK). Este parâmetro também pode ser um alias vinculado à CMK. Para mais informações, consulte Uso de aliases.

5c438b18-05be-40ad-b6c2-3be6752c****

KeyVersionId

string

Sim

O identificador globalmente exclusivo da versão da chave.

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

DryRun

string

Não

Especifica se o modo DryRun deve ser ativado.

  • true: ativa o modo DryRun.

  • false (padrão): desativa o modo DryRun.

O modo DryRun é usado para testar chamadas de API, verificar suas permissões em recursos e verificar se os parâmetros são válidos. Se você ativar o modo DryRun, o KMS sempre retornará uma resposta de falha e um motivo de falha. Os motivos de falha incluem os seguintes:

  • DryRunOperationError: A solicitação teria sido bem-sucedida se o parâmetro DryRun não fosse especificado.

  • ValidationError: Os parâmetros especificados na solicitação são inválidos.

  • AccessDeniedError: Você não está autorizado a realizar a operação no recurso do KMS.

false

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

KeyVersionId

string

O identificador globalmente exclusivo da versão da chave.

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

KeyId

string

O identificador globalmente exclusivo da CMK.

Nota

Se você especificar um alias da CMK para o parâmetro KeyId na solicitação, o ID da CMK à qual o alias está vinculado será retornado.

5c438b18-05be-40ad-b6c2-3be6752c****

RequestId

string

O ID da solicitação.

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

PublicKey

string

A chave pública no formato 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

Exemplos

Resposta de sucesso

JSON formato

{
  "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"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.
404 Forbidden.KeyNotFound The specified Key is not found. The error message returned because the specified CMK does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.