DescribeKeyPairs - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta uno o más key pairs de SSH.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:DescribeKeyPairs

get

KeyPair.

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

KeyPair.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de los key pairs. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
KeyPairName	string	No	El nombre del key pair. Se admite la búsqueda aproximada con expresiones regulares. Puede usar un asterisco () para coincidir con subexpresiones. Ejemplos: `SshKey`: consulta los nombres de key pairs que terminan en SshKey, incluido SshKey. `SshKey`: consulta los nombres de key pairs que empiezan por SshKey, incluido SshKey. `SshKey*`: consulta los nombres de key pairs que contienen SshKey, incluido SshKey. `SshKey`: coincidencia exacta con SshKey.	SshKey
KeyPairFingerPrint	string	No	La huella digital del key pair. El formato de la huella digital de la clave pública se define en RFC 4716 y usa el algoritmo de resumen de mensajes MD5. Para obtener más información, consulte RFC 4716.	ABC1234567
PageNumber	integer	No	El número de página de la lista de key pairs. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para una consulta paginada. Valor máximo: 50. Valor predeterminado: 10.	10
IncludePublicKey	boolean	No	Especifica si se debe incluir PublicKey en la respuesta. Valor predeterminado: false.	false
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenecen los key pairs. Cuando use este parámetro para filtrar recursos, la cantidad de recursos no puede exceder 1,000. Nota No se admite el filtrado por el grupo de recursos predeterminado.	rg-amnhr7u7c7hj****
Tag	array<object>	No	Las etiquetas.
	object	No
Key	string	No	La clave de la etiqueta del key pair. Valores válidos de N: 1 a 20. Si usa una sola etiqueta para filtrar recursos, la cantidad de recursos con la etiqueta especificada no puede exceder 1,000. Si usa varias etiquetas para filtrar recursos, la cantidad de recursos que tengan todas las etiquetas especificadas no puede exceder 1,000. Si la cantidad de recursos excede 1,000, llame a la operación ListTagResources para consultar los recursos.	TestKey
Value	string	No	El valor de la etiqueta del key pair. Valores válidos de N: 1 a 20.	TestValue

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageSize	integer	El número de entradas por página.	10
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	El número de página actual.	1
TotalCount	integer	El número total de key pairs.	1
KeyPairs	object
KeyPair	array<object>	La información del key pair.
	array<object>
CreationTime	string	La hora de creación del key pair. La hora sigue el estándar ISO 8601 en UTC.	2023-09-04T08:33Z
KeyPairName	string	El nombre del key pair.	testKeyPairName
KeyPairFingerPrint	string	La huella digital del key pair.	ABC1234567
ResourceGroupId	string	El ID del grupo de recursos.	rg-amnhr7u7c7hj****
PublicKey	string	El contenido de la clave pública.	ssh-rsa****
Tags	object
Tag	array<object>	Las etiquetas del key pair.
	object
TagValue	string	El valor de la etiqueta del key pair.	TestValue
TagKey	string	La clave de la etiqueta del key pair.	TestKey

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.