DescribeKeyPairs - ENS: Central de Documentação do Alibaba Cloud

Consulta um ou mais pares de chaves.

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

ens:DescribeKeyPairs

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
KeyPairName	string	Não	O nome do par de chaves que você deseja vincular ao servidor de aplicação simples. O nome deve ter de 2 a 128 caracteres. O nome deve começar com uma letra, mas não pode começar com `http://` ou `https://`. O nome pode conter os seguintes caracteres: Números. : _ . Você pode especificar apenas um nome. Por padrão, todos os pares de chaves são consultados.	TestKeyPairName
PageNumber	string	Não	O número da página retornada. Valores válidos: inteiros maiores que 0. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página. Valores válidos: inteiros maiores que 0. Valor padrão: 10.	10
KeyPairId	string	Não	O ID do par de chaves.	ssh-50cynkq42sgj4ej1tn78t4***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
KeyPairs	object
KeyPair	array<object>	Detalhes sobre os pares de chaves.
	object
CreationTime	string	The time when the key pair was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2020-04-26T15:38:27Z
KeyPairFingerPrint	string	The fingerprint of the key pair.	fdaf8ff7a756ef843814fc****
KeyPairName	string	The name of the SSH key pair.	TestKeyPairName
KeyPairId	string	The ID of the key pair.	ssh-50cynkq42sgj4ej1tn78t4***
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	37B52F33-6879-49D0-A39B-22966B01449E
TotalCount	integer	O número total de pares de chaves.	7

Exemplos

Resposta de sucesso

JSON formato

{
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2020-04-26T15:38:27Z",
        "KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
        "KeyPairName": "TestKeyPairName",
        "KeyPairId": "ssh-50cynkq42sgj4ej1tn78t4***"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "37B52F33-6879-49D0-A39B-22966B01449E",
  "TotalCount": 7
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.