DescribeKeyPairs - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta um ou mais pares de chaves SSH.

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

ecs:DescribeKeyPairs

get

Par de chaves.

acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}

Par de chaves.

acs:ecs:{#regionId}:{#accountId}:keypair/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região dos pares de chaves. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
KeyPairName	string	Não	O nome do par de chaves. Há suporte para pesquisa aproximada com expressões regulares. Você pode usar um asterisco () para corresponder a subexpressões. Exemplos: `SshKey`: consulta nomes de pares de chaves que terminam com SshKey, incluindo SshKey. `SshKey`: consulta nomes de pares de chaves que começam com SshKey, incluindo SshKey. `SshKey*`: consulta nomes de pares de chaves que contêm SshKey, incluindo SshKey. `SshKey`: correspondência exata de SshKey.	SshKey
KeyPairFingerPrint	string	Não	A impressão digital do par de chaves. O formato de impressão digital da chave pública é definido na RFC 4716 e usa o algoritmo de resumo de mensagem MD5. Para mais informações, consulte RFC 4716.	ABC1234567
PageNumber	integer	Não	O número da página da lista de pares de chaves. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
IncludePublicKey	boolean	Não	Especifica se deve incluir PublicKey na resposta. Valor padrão: false.	false
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual os pares de chaves pertencem. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1000. Nota Não há suporte para filtragem pelo grupo de recursos padrão.	rg-amnhr7u7c7hj****
Tag	array<object>	Não	As tags.
	object	Não
Key	string	Não	A chave da tag do par de chaves. Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos com a tag especificada não pode exceder 1000. Se você usar várias tags para filtrar recursos, a contagem de recursos aos quais todas as tags especificadas estão anexadas não pode exceder 1000. Se a contagem de recursos exceder 1000, chame a operação ListTagResources para consultar os recursos.	TestKey
Value	string	Não	O valor da tag do par de chaves. Valores válidos de N: 1 a 20.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	O número da página atual.	1
TotalCount	integer	O número total de pares de chaves.	1
KeyPairs	object
KeyPair	array<object>	As informações do par de chaves.
	array<object>
CreationTime	string	A hora em que o par de chaves foi criado. A hora segue o padrão ISO 8601 em UTC.	2023-09-04T08:33Z
KeyPairName	string	O nome do par de chaves.	testKeyPairName
KeyPairFingerPrint	string	A impressão digital do par de chaves.	ABC1234567
ResourceGroupId	string	O ID do grupo de recursos.	rg-amnhr7u7c7hj****
PublicKey	string	O conteúdo da chave pública.	ssh-rsa****
Tags	object
Tag	array<object>	As tags do par de chaves.
	object
TagValue	string	O valor da tag do par de chaves.	TestValue
TagKey	string	A chave da tag do par de chaves.	TestKey

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2023-09-04T08:33Z",
        "KeyPairName": "testKeyPairName",
        "KeyPairFingerPrint": "ABC1234567",
        "ResourceGroupId": "rg-amnhr7u7c7hj****",
        "PublicKey": "ssh-rsa****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

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.