CreateClientKey - - Centre de documentation Alibaba Cloud

Description de l'opération

Pour effectuer des opérations cryptographiques et récupérer des valeurs secrètes, les applications autogérées doivent utiliser une clé client pour accéder à une instance Key Management Service (KMS). Le processus suivant montre comment créer un point d'accès d'application (AAP) basé sur une clé client :

Créer une règle de contrôle d'accès : vous pouvez configurer les adresses IP privées ou les blocs CIDR privés autorisés à accéder à une instance KMS. Pour plus d'informations, consultez CreateNetworkRule.
Créer une stratégie d'autorisation : vous pouvez configurer les clés et les secrets autorisés à accéder et lier des règles de contrôle d'accès aux clés et aux secrets. Pour plus d'informations, consultez CreatePolicy.
Créer un AAP : vous pouvez configurer une méthode d'authentification et lier une stratégie d'autorisation à un AAP. Pour plus d'informations, consultez CreateApplicationAccessPoint.
Créer une clé client : vous pouvez configurer le mot de passe de chiffrement et la période de validité d'une clé client, et lier la clé client à un AAP.

Précautions

Une clé client possède une période de validité. Une fois qu'une clé client expire, les applications dans lesquelles la clé client est intégrée ne peuvent plus accéder à l'instance KMS requise. Vous devez remplacer la clé client avant son expiration. Nous vous recommandons de supprimer la clé client expirée dans KMS après l'utilisation de la nouvelle clé client.

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
AapName	string	Oui	L'opération que vous souhaitez effectuer. Définissez la valeur sur CreateClientKey.	aap_test
Password	string	Oui	Le nom de l'AAP.	bcfefe15-46f0****
NotAfter	string	Non	Le mot de passe de chiffrement de la clé client. Le mot de passe doit comporter entre 8 et 64 caractères et doit contenir au moins deux des types suivants : chiffres, lettres et caractères spéciaux. Les caractères spéciaux incluent `~ ! @ # $ % ^ & * ? _ -`.	2028-08-31T17:14:33Z
NotBefore	string	Non	La fin de la période de validité de la clé client. Spécifiez l'heure selon la norme ISO 8601. L'heure doit être en UTC. L'heure doit être au format yyyy-MM-ddTHH:mm:ssZ. Remarque Si vous ne configurez pas NotAfter, la valeur par défaut est l'heure de création de la clé client plus cinq ans. Si vous configurez NotAfter, vous devez configurer NotBefore.	2023-08-31T17:14:33Z

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	Le début de la période de validité de la clé client. Spécifiez l'heure selon la norme ISO 8601. L'heure doit être en UTC. L'heure doit être au format yyyy-MM-ddTHH:mm:ssZ. Remarque Si vous ne configurez pas NotBefore, la valeur par défaut est l'heure de création de la clé client. Si vous configurez NotBefore, vous devez configurer NotAfter.	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeyId	string	L'identifiant de la requête, utilisé pour localiser et résoudre les problèmes.	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
KeyAlgorithm	string	L'identifiant de la clé client.	RSA_2048
PrivateKeyData	string	L'algorithme utilisé pour chiffrer la clé privée de la clé client. Actuellement, seul RSA_2048 est pris en charge.	MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******
NotBefore	string	La clé privée de la clé client.	2023-08-31T17:14:33Z
NotAfter	string	Le début de la période de validité de la clé client.	2028-08-31T17:14:33Z

Exemples

JSON format

{
  "RequestId": "2312e45f-b2fa-4c34-ad94-3eca50932916",
  "ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
  "KeyAlgorithm": "RSA_2048",
  "PrivateKeyData": "MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******",
  "NotBefore": "2023-08-31T17:14:33Z",
  "NotAfter": "2028-08-31T17:14:33Z"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.