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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeKeyPairs	Operação a ser executada. Defina o valor como DescribeKeyPairs.
RegionId	String	Sim	cn-hangzhou	ID da região do par de chaves. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
KeyPairName	String	Não	SshKey	Nome do par de chaves. Use o asterisco () como caractere curinga em expressões regulares para buscar pares de chaves aproximadamente. Padrões de exemplo: `SshKey`: consulta pares de chaves cujos nomes terminam com SshKey, incluindo o par chamado SshKey. `SshKey*`: consulta pares de chaves cujos nomes começam com SshKey, incluindo o par chamado SshKey. `SshKey`: consulta pares de chaves cujos nomes contêm SshKey, incluindo o par chamado SshKey. `SshKey`: consulta o par de chaves chamado SshKey.
KeyPairFingerPrint	String	Não	ABC1234567	Impressão digital do par de chaves. Utiliza o algoritmo message-digest 5 (MD5) com base no formato de impressão digital de chave pública definido na RFC 4716. Para obter mais informações, consulte a RFC 4716.
PageNumber	Integer	Não	1	Número da página a retornar. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	10	Quantidade de entradas a retornar por página. Valor máximo: 50. Valor padrão: 10.
ResourceGroupId	String	Não	rg-amnhr7u7c7hj****	ID do grupo de recursos. Se especificado na consulta, a resposta pode exibir até 1.000 recursos pertencentes ao grupo indicado. Nota Recursos do grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.
Tag.N.Key	String	Não	TestKey	Chave da tag N do par de chaves. Valores válidos para N: 1 a 20. Se uma única tag for especificada, a resposta pode exibir até 1.000 recursos associados a ela. Caso múltiplas tags sejam informadas, até 1.000 recursos vinculados a todas simultaneamente podem ser listados. Para consultar mais de 1.000 recursos com tags específicas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	Valor da tag N do par de chaves. Valores válidos para N: 1 a 20.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	Quantidade de entradas retornadas por página.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID da solicitação.
PageNumber	Integer	1	Número da página retornada.
TotalCount	Integer	1	Total de pares de chaves.
KeyPairs	Array of KeyPair		Detalhes dos pares de chaves.
KeyPair
CreationTime	String	2023-09-04T08:33Z	Data e hora de criação do par de chaves.
KeyPairName	String	testKeyPairName	Nome do par de chaves.
KeyPairFingerPrint	String	ABC1234567	Impressão digital do par de chaves.
ResourceGroupId	String	rg-amnhr7u7c7hj****	ID do grupo de recursos.
Tags	Array of Tag		Tags do par de chaves.
Tag
TagValue	String	TestValue	Valor da tag do par de chaves.
TagKey	String	TestKey	Chave da tag do par de chaves.

Exemplos

Exemplos de solicitações

https://ecs.aliyuncs.com/?Action=DescribeKeyPairs
&RegionId=cn-qingdao
&KeyPairFingerPrint=ABC1234567
&KeyPairName=SshKey
&PageNumber=1
&PageSize=20
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeKeyPairsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <KeyPairs>
        <KeyPair>
            <CreationTime>2023-09-04T08:33Z</CreationTime>
            <ResourceGroupId/>
            <KeyPairName>testKeyPairName</KeyPairName>
            <KeyPairFingerPrint>ABC1234567</KeyPairFingerPrint>
        </KeyPair>
    </KeyPairs>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeKeyPairsResponse>

Formato JSON

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

{
  "PageNumber" : 1,
  "PageSize" : 2,
  "TotalCount" : 1,
  "KeyPairs" : {
    "KeyPair" : [ {
      "CreationTime" : "2023-09-04T08:33Z",
      "ResourceGroupId" : "",
      "KeyPairName" : "testKeyPairName",
      "KeyPairFingerPrint" : "ABC1234567"
    } ]
  },
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.