DescribeKeyPairs - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte une ou plusieurs paires de clés.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeKeyPairs

get

KeyPair

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

KeyPair

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région des paires de clés. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
KeyPairName	string	Non	Le nom de la paire de clés. Vous pouvez utiliser des expressions régulières pour une recherche approximative, avec l'astérisque () pour faire correspondre les expressions de sous-chaîne. Exemples : `SshKey` : recherche les noms de paires de clés se terminant par SshKey, y compris SshKey. `SshKey` : recherche les noms de paires de clés commençant par SshKey, y compris SshKey. `SshKey*` : recherche les noms de paires de clés contenant SshKey, y compris SshKey. `SshKey` : correspondance exacte de SshKey.	SshKey
KeyPairFingerPrint	string	Non	L'empreinte de la paire de clés. L'empreinte utilise l'algorithme de hachage MD5 (Message-Digest Algorithm 5) basé sur le format d'empreinte de clé publique défini dans la RFC 4716. Pour plus d'informations, consultez la RFC 4716.	ABC1234567
PageNumber	integer	Non	Le numéro de page de la liste des paires de clés. Valeur minimale : 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page dans les requêtes paginées. Paramètres : Valeur maximale : 50. Valeur par défaut : 10.	10
IncludePublicKey	boolean	Non	Indique si PublicKey doit être inclus dans la réponse. Valeur par défaut : false.	false
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel appartiennent les paires de clés. Lorsque vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1000. Remarque Le filtrage par le groupe de ressources par défaut n'est pas pris en charge.	rg-amnhr7u7c7hj****
Tag	array<object>	Non	Les balises.
	object	Non
Key	string	Non	La clé de balise de la paire de clés. Valeurs valides de N : 1 à 20. Si vous utilisez une seule balise pour filtrer les ressources, le nombre de ressources avec la balise spécifiée ne peut pas dépasser 1000. Si vous utilisez plusieurs balises pour filtrer les ressources, le nombre de ressources auxquelles toutes les balises spécifiées sont attachées ne peut pas dépasser 1000. Si le nombre de ressources dépasse 1000, appelez l'opération ListTagResources pour interroger les ressources.	TestKey
Value	string	Non	La valeur de balise de la paire de clés. Valeurs valides de N : 1 à 20.	TestValue

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	Le numéro de page actuel.	1
TotalCount	integer	Le nombre total de paires de clés.	1
KeyPairs	object
KeyPair	array<object>	Les informations de la paire de clés.
	array<object>
CreationTime	string	The time when the key pair was created.	2023-09-04T08:33Z
KeyPairName	string	The name of the key pair.	testKeyPairName
KeyPairFingerPrint	string	The fingerprint of the key pair.	ABC1234567
ResourceGroupId	string	The resource group ID.	rg-amnhr7u7c7hj****
PublicKey	string	The public key content.	ssh-rsa****
Tags	object
Tag	array<object>	The tags of the key pair.
	object
TagValue	string	The tag value of the key pair.	TestValue
TagKey	string	The tag key of the key pair.	TestKey

Exemples

JSON format

{
  "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"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.