DescribeCertificatePrivateKey - Certificate Management Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Esta API aplica-se apenas a certificados emitidos a partir de uma Solicitação de Assinatura de Certificado (CSR) gerada pelo sistema. Você pode usar esta API para recuperar a chave privada criptografada de um certificado de cliente ou servidor. Antes de chamar esta API, você deve ter emitido um certificado de cliente ou servidor chamando uma das seguintes APIs:

Para manter a chave privada segura durante a transmissão, esta API usa uma senha que você define para criptografar a chave privada. A API então retorna a chave privada criptografada. Depois de recuperar a chave privada criptografada, você pode descriptografá-la usando um dos seguintes métodos:

Se o certificado usar o algoritmo de criptografia RSA, execute o comando openssl rsa -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> para descriptografar a chave privada. Você deve executar este comando em um computador que tenha o OpenSSL ou o BabaSSL instalado.
Se o certificado usar o algoritmo de criptografia ECC, execute o comando openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> para descriptografar a chave privada. Você deve executar este comando em um computador que tenha o OpenSSL ou o BabaSSL instalado.
Se o certificado usar o algoritmo de criptografia SM2, execute o comando openssl ec -in <encrypted_private_key_file> -passin pass:<private_key_password> -out <decrypted_private_key_file> para descriptografar a chave privada. Você deve executar este comando em um computador que tenha o BabaSSL instalado.

Nota

Você pode chamar a API DescribeClientCertificate para consultar o algoritmo de criptografia do certificado de cliente ou servidor.

Limite de QPS

Esta API tem um limite de 10 consultas por segundo (QPS) para cada usuário. Se você exceder esse limite, suas chamadas de API sofrerão throttling. O throttling pode afetar seus negócios. Planeje suas chamadas adequadamente.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

yundun-cert:DescribeCertificatePrivateKey

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Identifier	string	Sim	O identificador exclusivo do certificado de cliente ou servidor para o qual você deseja obter a chave privada. Nota Chame a API ListClientCertificate para consultar os identificadores exclusivos de todos os certificados de cliente e servidor.	bc37133bb7ed68c7938d928fd26d****
EncryptedCode	string	Sim	A senha para criptografar a chave privada. A senha pode conter letras maiúsculas, letras minúsculas, dígitos e caracteres especiais, como `,.+-_#`. O comprimento máximo é de 32 bytes. Aviso Lembre-se da senha definida. Você precisa dessa senha para descriptografar a chave privada criptografada. Se você esquecer a senha, não poderá descriptografar a chave privada obtida nesta chamada de API. Você deve chamar esta API novamente para obter uma nova chave criptografada.	!Demo@WS3ed
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o certificado pertence.	test

Além dos parâmetros de solicitação específicos da API neste tópico, você deve especificar parâmetros de solicitação comuns ao fazer uma chamada de API.

Para o formato da solicitação, consulte o exemplo de solicitação na seção Exemplos.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	GetCertificatePrivateKeyResponse.
EncryptedData	string	O conteúdo criptografado da chave privada.	-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----
RequestId	string	O ID da solicitação.	09470F19-CEE8-5C63-BF2C-02B5E3F07A17

Exemplos

Resposta de sucesso

JSON formato

{
  "EncryptedData": "-----BEGIN ENCRYPTED PRIVATE KEY----- …… -----END ENCRYPTED PRIVATE KEY-----",
  "RequestId": "09470F19-CEE8-5C63-BF2C-02B5E3F07A17"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.