ListKeys - - Centre de documentation Alibaba Cloud

Description de l'opération

Pour plus d'informations sur la stratégie d'accès requise par un utilisateur RAM ou un rôle RAM pour appeler cette API, consultez Resource Access Management.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageNumber	integer	Non	Le numéro de page. Valeurs valides : supérieur à 0. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à retourner sur chaque page. Valeurs valides : de 1 à 100. Valeur par défaut : 10.	10
Filters	string	Non	Un filtre pour les clés principales. Le filtre se compose de 0 à 10 paires clé-valeur. Key Description : la propriété à filtrer. Type : chaîne. Values Description : la valeur à inclure après le filtrage. Type : tableau de chaînes. Longueur : de 0 à 10. Valeurs valides : Si `Key` est défini sur `KeyState`, cela spécifie l'état de la clé. Les valeurs valides pour `Value` sont `Enabled`, `Disabled`, `PendingDeletion` et `PendingImport`. Si `Key` est défini sur `KeySpec`, cela spécifie le type de clé. Les valeurs valides pour `Value` sont `Aliyun_AES_256`, `Aliyun_SM4`, `RSA_2048`, `EC_P256`, `EC_P256K`, `EC_SM2` et `Aliyun_SM4`. Remarque : vous ne pouvez créer des clés de type `EC_SM2` et `Aliyun_SM4` que dans les régions qui prennent en charge les HSM gérés et qui ont réussi l'évaluation de conformité de l'Office of State Commercial Cryptography Administration (OSCCA). Pour plus d'informations sur les régions prises en charge, consultez Régions prises en charge. Si vous spécifiez `EC_SM2` ou `Aliyun_SM4` dans une région qui ne prend pas en charge ces types de clés, les paramètres sont ignorés. Si `Key` est défini sur `KeyUsage`, cela spécifie l'utilisation de la clé. Les valeurs valides pour `Value` sont `ENCRYPT/DECRYPT` (pour le chiffrement et le déchiffrement des données) et `SIGN/VERIFY` (pour la génération et la vérification des signatures numériques). Si `Key` est défini sur `ProtectionLevel`, cela spécifie le niveau de protection de la clé. Les valeurs valides pour `Value` sont `SOFTWARE` et `HSM`. Remarque : le niveau de protection HSM n'est pris en charge que dans des régions spécifiques. Pour plus d'informations sur les régions prises en charge, consultez Régions prises en charge. Si vous spécifiez `HSM` dans une région qui ne le prend pas en charge, le paramètre est ignoré. Si `Key` est défini sur `CreatorType`, cela spécifie le type de créateur. Les valeurs valides pour `Value` sont `User` (renvoie les clés principales créées par les utilisateurs) et `Service` (renvoie les clés principales qui sont automatiquement créées par d'autres services Alibaba Cloud en fonction de votre autorisation). Si `Key` est défini sur `DKMSInstanceId`, cela spécifie l'identifiant de l'instance KMS. Définissez `Value` selon vos besoins. Si `Key` est défini sur `keyId`, cela spécifie l'identifiant de la clé. Définissez `Value` selon vos besoins. Si `Key` est défini sur `AliasName`, cela spécifie l'alias de la clé. Définissez `Value` selon vos besoins. Si `Key` est défini sur `Creator`, cela spécifie le créateur de la clé. Définissez `Value` selon vos besoins. Si `Key` est défini sur `TagKey`, cela spécifie la clé d'une balise de clé. Définissez `Value` selon vos besoins. Si `Key` est défini sur `TagValue`, cela spécifie la valeur d'une balise de clé. Définissez `Value` selon vos besoins. La relation logique entre les différentes clés dans `Filters` est `AND`. La relation logique entre plusieurs valeurs pour la même clé est `OR`. Par exemple, si vous saisissez `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]`, la sémantique est la suivante : `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)`.	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées retournées par page.	10
RequestId	string	L'identifiant de la requête. Il s'agit d'un identifiant unique global (GUID) généré par Alibaba Cloud. Vous pouvez utiliser l'identifiant de la requête pour résoudre les problèmes.	8252db58-2036-408c-a3d5-56e656dc2551
TotalCount	integer	Le nombre total de clés principales.	3
Keys	object
Key	array<object>	Les clés principales.
	object	La clé principale.
KeyId	string	The globally unique identifier of the master key.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
KeyArn	string	The Alibaba Cloud Resource Name (ARN) of the master key.	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

Exemples

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "TotalCount": 3,
  "Keys": {
    "Key": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "KeyArn": "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.