GetPublicKey - : Central de Documentação do Alibaba Cloud

Observações

Você pode chamar esta operação de API usando um gateway compartilhado ou dedicado. Para mais informações, consulte Alibaba Cloud SDK.

Gateway compartilhado: acesse o Key Management Service (KMS) por um endpoint público ou de VPC. Esse método exige a ativação do acesso à rede pública. Para mais detalhes, consulte Acesso a chaves em uma instância KMS pela rede pública.
Gateway dedicado: acesse o KMS pelo endpoint privado da sua instância KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Depuração

Chame esta operação diretamente no OpenAPI Explorer. A ferramenta calcula a assinatura automaticamente e gera exemplos de código SDK após a execução bem-sucedida.

Parâmetros de solicitação

Nome	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetPublicKey	Parâmetro obrigatório. Defina o valor como GetPublicKey.
KeyId	String	Sim	5c438b18-05be-40ad-b6c2-3be6752c****	Identificador globalmente único da chave mestra do cliente (CMK). Você também pode especificar um alias vinculado à CMK. Para mais informações, consulte Uso de aliases.
KeyVersionId	String	Sim	2ab1a983-7072-4bbc-a582-584b5bd8****	Identificador globalmente único da versão da chave.
DryRun	String	Não	false	Especifique se uma simulação deve ser executada. Valores válidos: true: ative o modo de simulação. false (padrão): desativa o modo de simulação. O modo de simulação testa a chamada de API. Ele verifica as permissões nos recursos e a validade dos parâmetros da solicitação. Se você ativar esse modo, o KMS retornará uma resposta de falha com o motivo correspondente. O motivo pode ser um dos seguintes: DryRunOperationError: a solicitação teria êxito sem o parâmetro DryRun. ValidationError: um parâmetro na solicitação é inválido. AccessDeniedError: você não tem autorização para executar esta operação no recurso do KMS.

Parâmetros de resposta

Nome	Tipo	Exemplo	Descrição
KeyVersionId	String	2ab1a983-7072-4bbc-a582-584b5bd8****	ID da versão da chave mestra usada para criptografar os dados em texto simples.
KeyId	String	5c438b18-05be-40ad-b6c2-3be6752c****	Identificador globalmente único da CMK. Nota Se você usar um alias da CMK na solicitação, o ID da CMK será retornado.
RequestId	String	475f1620-b9d3-4d35-b5c6-3fbdd941423d	ID de acesso gerado aleatoriamente.
PublicKey	String	-----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	Chave pública no formato PEM.

Exemplos

Exemplo de solicitação

http(s)://[Endpoint]/?Action=GetPublicKey
&KeyId=5c438b18-05be-40ad-b6c2-3be6752c****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8****
&DryRun=false
&Common request parameters

Exemplos de resposta

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<GetPublicKeyResponse>
    <KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
    <KeyId>5c438b18-05be-40ad-b6c2-3be6752c****</KeyId>
    <RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
    <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</PublicKey>
</GetPublicKeyResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/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"
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is not valid.	O parâmetro especificado é inválido.
404	Forbidden.KeyNotFound	The specified Key is not found.	A chave especificada não existe.

Para obter mais informações sobre códigos de erro, consulte o Error Center.