Normes API et SDK multilingues prédéfinis
L'OpenAPI de ce produit (Kms/2016-01-20) utilise le style de signature RPC. Des SDK sont disponibles pour les langages de programmation courants. Les développeurs peuvent télécharger le SDK pour appeler directement l'OpenAPI de ce produit, sans se soucier des détails techniques. Si le SDK existant ne répond pas à vos besoins, utilisez le mécanisme de signature pour une intégration par auto-signature. L'auto-signature étant particulièrement complexe, comptez environ 5 jours ouvrables. Nous vous recommandons donc de rejoindre notre groupe d'assistance DingTalk (147535001692) pour bénéficier d'un accompagnement expert lors de l'intégration.
Avant d'utiliser l'API, préparez votre compte d'identité et votre clé d'accès (AccessKey) afin d'accéder efficacement à l'API via des outils clients (tels que SDK et CLI). Pour plus d'informations, consultez Obtenir un AccessKey.
Scénarios de signature personnalisée
Si votre scénario métier présente des exigences particulières et nécessite une intégration par auto-signature, consultez d'abord notre équipe de support technique (groupe d'assistance DingTalk : 147535001692) pour obtenir un accompagnement professionnel et garantir une intégration efficace.
Préparation du compte et de la sécurité
Les comptes Alibaba Cloud disposent de permissions administratives complètes sur l'ensemble des ressources. En cas de compromission d'un AccessKey, toutes les ressources associées sont exposées à un risque d'accès non autorisé. Pour garantir la sécurité, créez un utilisateur RAM disposant uniquement de permissions d'accès API et configurez son AccessKey. Appliquez ensuite des politiques RAM selon le principe du moindre privilège (PoLP). N'utilisez le compte Alibaba Cloud que dans les scénarios spécifiques où ses permissions sont explicitement requises.
Gestion des services
|
API |
Titre |
Description |
| DescribeAccountKmsStatus | DescribeAccountKmsStatus. | Consulte l'état de Key Management Service (KMS) au sein de votre compte Alibaba Cloud. |
| OpenKmsService | OpenKmsService. | Active le service Key Management Service (KMS) pour votre compte Alibaba Cloud. |
Gestion des instances
|
API |
Titre |
Description |
| ListKmsInstances | ListKmsInstances. | Consulte toutes les instances KMS de la région actuelle. |
| ConnectKmsInstance | ConnectKmsInstance. | Active une instance Key Management Service (KMS). |
| GetKmsInstance | GetKmsInstance. | Obtient les détails d'une instance KMS. |
| UpdateKmsInstanceBindVpc | UpdateKmsInstanceBindVpc. | Met à jour les associations VPC d'une instance KMS. |
| ReleaseKmsInstance | ReleaseKmsInstance. | Libère une instance KMS postpayée. |
| GetDefaultKmsInstance | GetDefaultKmsInstance. | Consulte l'instance KMS par défaut dans une région spécifiée. |
Gestion des clés
|
API |
Titre |
Description |
| CreateKey | CreateKey. | Crée une clé maître client (CMK) pour le chiffrement d'enveloppe, les signatures numériques ou d'autres opérations cryptographiques. |
| ListKeys | ListKeys. | Consulte les identifiants et les ARN de toutes les CMK de la région actuelle. |
| DescribeKey | DescribeKey. | Consulte les métadonnées d'une CMK, telles que l'état de la clé, l'utilisation et la configuration de rotation. |
| UpdateKeyDescription | UpdateKeyDescription. | Met à jour la description d'une CMK. |
| EnableKey | EnableKey. | Active une clé pour chiffrer et déchiffrer des données. |
| DisableKey | DisableKey. | Désactive une clé. |
| GetPublicKey | GetPublicKey | Obtient la clé publique d'une clé asymétrique. Vous pouvez utiliser cette clé publique pour chiffrer des données ou vérifier une signature sur votre appareil. |
| CreateAlias | CreateAlias. | Crée un alias pour une clé. |
| ListAliases | ListAliases. | Consulte tous les alias de la région actuelle pour le compte actuel. |
| ListAliasesByKeyId | ListAliasesByKeyId. | Consulte tous les alias associés à une clé. |
| DeleteAlias | DeleteAlias. | Supprime un alias. |
| UpdateAlias | Mise à jour de l'alias. | Associe un alias existant à un identifiant de clé principale client (CMK) différent. |
| GetParametersForImport | GetParametersForImport. | Consulte les paramètres utilisés pour importer du matériel de clé pour une clé principale client (CMK). |
| ImportKeyMaterial | ImportKeyMaterial. | Importe le matériel de clé généré en externe dans une CMK dont l'origine est EXTERNAL. |
| DeleteKeyMaterial | DeleteKeyMaterial. | Supprime le matériel de clé importé d'une CMK. Après la suppression, la CMK passe à l'état PendingImport jusqu'à ce que vous réimportiez le matériel de clé. |
| ScheduleKeyDeletion | ScheduleKeyDeletion. | Supprime une clé principale client (CMK) spécifiée. |
| CancelKeyDeletion | CancelKeyDeletion. | Annule la tâche de suppression d'une CMK. |
| SetDeletionProtection | Définir la protection contre la suppression. | Active ou désactive la protection contre la suppression pour une clé principale client (CMK). |
| UpdateRotationPolicy | UpdateRotationPolicy. | Met à jour la stratégie de rotation automatique d'une CMK. |
| DescribeKeyVersion | DescribeKeyVersion. | Consulte les métadonnées d'une version spécifique de CMK. |
| CreateKeyVersion | CreateKeyVersion. | Crée une version pour une clé principale client (CMK). |
| ListKeyVersions | ListKeyVersions. | Consulte toutes les versions d'une CMK spécifiée. |
| SetKeyPolicy | SetKeyPolicy. | Définit la stratégie de clé pour une CMK dans une instance KMS. |
| GetKeyPolicy | Consultation de la stratégie de clé. | Consulte la stratégie de clé d'une clé principale client (CMK) dans une instance KMS. |
Opérations cryptographiques
|
API |
Titre |
Description |
| GenerateDataKey | GenerateDataKey. | Génère une clé de données aléatoire pour le chiffrement d'enveloppe. La clé de données est renvoyée sous forme de texte en clair et de texte chiffré. |
| GenerateAndExportDataKey | GenerateAndExportDataKey. | Génère une clé de données aléatoire, la chiffre à l'aide d'une CMK et d'une clé publique que vous spécifiez, et renvoie les deux textes chiffrés. |
| Encrypt | Encrypt. | Chiffre du texte en clair à l'aide d'une CMK symétrique. |
| Decrypt | Decrypt. | Déchiffre le texte chiffré qui a été chiffré à l'aide d'une CMK. |
| ReEncrypt | ReEncrypt. | Rechiffre le texte chiffré avec une autre CMK sans exposer le texte en clair. |
| ExportDataKey | ExportDataKey. | Exporte une clé de données chiffrée par une CMK. La clé de données est rechiffrée par une clé publique que vous spécifiez pour une transmission sécurisée. |
| GenerateDataKeyWithoutPlaintext | GenerateDataKeyWithoutPlaintext. | Génère une clé de données aléatoire uniquement sous forme de texte chiffré, sans la copie en texte clair. |
| AsymmetricSign | AsymmetricSign. | Génère une signature numérique à l'aide d'une CMK asymétrique. |
| AsymmetricVerify | AsymmetricVerify. | Vérifie une signature numérique en utilisant la clé publique d'une CMK asymétrique. |
| AsymmetricEncrypt | AsymmetricEncrypt. | Chiffre des données à l'aide de la clé publique d'une clé maîtresse asymétrique. |
| AsymmetricDecrypt | AsymmetricDecrypt. | Déchiffre les données à l'aide de la clé privée d'une CMK asymétrique. |
| GenerateMac | Générer un code d'authentification de message HMAC. | Génère un code d'authentification de message HMAC pour un message en utilisant une clé spécifiée. |
| VerifyMac | Vérification du code d'authentification de message HMAC. | Vérifie le code d'authentification de message HMAC d'un message spécifique à l'aide d'une clé spécifiée. |
Gestion des secrets
|
API |
Titre |
Description |
| ListSecrets | ListSecrets. | Consulte tous les secrets de la région actuelle. |
| GetSecretValue | Obtention de la valeur d'un secret. | Obtient la valeur d'un secret. |
| BatchGetSecretValue | Obtenir les valeurs des secrets par lots. | Obtient les valeurs des secrets par lots. |
| DeleteSecret | DeleteSecret. | Supprime un secret. |
| CreateSecret | CreateSecret. | Crée un secret et stocke sa version initiale. |
| UpdateSecret | UpdateSecret. | Met à jour les métadonnées d'un secret. |
| UpdateSecretVersionStage | UpdateSecretVersionStage. | Déplace une étiquette d'étape de version vers une autre version d'un secret. |
| UpdateSecretRotationPolicy | UpdateSecretRotationPolicy. | Met à jour la stratégie de rotation d'un secret. |
| DescribeSecret | DescribeSecret. | Consulte les métadonnées d'un secret. |
| ListSecretVersionIds | Consultation de toutes les informations de version d'un secret. | Consulte toutes les informations de version d'un secret. |
| GetRandomPassword | GetRandomPassword. | Génère une chaîne de mot de passe aléatoire. |
| PutSecretValue | PutSecretValue. | Stocke une nouvelle version de la valeur d'un secret pour un secret générique. |
| RestoreSecret | RestoreSecret. | Restaure un secret supprimé. |
| RotateSecret | RotateSecret. | Effectue immédiatement la rotation d'un secret. |
| SetSecretPolicy | SetSecretPolicy. | Définit la stratégie d'accès pour un secret dans une instance KMS. |
| GetSecretPolicy | GetSecretPolicy. | Consulte la stratégie d'accès d'un secret spécifié dans une instance KMS. |
Gestion des balises
|
API |
Titre |
Description |
| UntagResources | UntagResources. | Supprime les balises des clés ou des secrets. |
| TagResources | TagResources. | Ajoute des balises à une ou plusieurs clés ou secrets. |
| ListTagResources | ListTagResources. | Répertorie les balises associées à une clé ou à un secret. |
| GetKmsInstanceQuotaInfos | GetKmsInstanceQuotaInfos. | Consulte l'utilisation et les limites des quotas pour une instance KMS. |
| ListResourceTags | ListResourceTags. | Consulte les balises d'une clé principale client (CMK). |
| TagResource | TagResource. | Ajoute des balises à une CMK, à un secret ou à un certificat. |
| UntagResource | UntagResource. | Supprime les balises d'une CMK, d'un secret ou d'un certificat. |
Gestion des applications
|
API |
Titre |
Description |
| CreateNetworkRule | CreateNetworkRule. | Crée une règle d'accès réseau pour configurer les adresses IP privées ou les blocs CIDR privés autorisés à accéder à une instance Key Management Service (KMS). |
| ListNetworkRules | ListNetworkRules. | Consulte toutes les règles d'accès réseau de la région actuelle. |
| DescribeNetworkRule | DescribeNetworkRule. | Obtient les détails d'une règle d'accès réseau. |
| UpdateNetworkRule | UpdateNetworkRule. | Met à jour une règle d'accès réseau. |
| DeleteNetworkRule | DeleteNetworkRule. | Supprime une règle d'accès réseau. |
| CreatePolicy | CreatePolicy. | Crée une stratégie d'autorisation pour configurer les clés et les secrets dont l'accès est autorisé. |
| ListPolicies | ListPolicies. | Consulte toutes les stratégies d'autorisation dans la région actuelle. |
| DescribePolicy | DescribePolicy. | Obtient les détails d'une stratégie d'autorisation. |
| UpdatePolicy | UpdatePolicy. | Met à jour une stratégie d'autorisation. |
| DeletePolicy | DeletePolicy. | Supprime une stratégie d'autorisation. |
| CreateApplicationAccessPoint | CreateApplicationAccessPoint. | Crée un point d'accès à l'application (AAP). |
| ListApplicationAccessPoints | ListApplicationAccessPoints. | Consulte tous les points d'accès aux applications (AAP) de la région actuelle. |
| DescribeApplicationAccessPoint | DescribeApplicationAccessPoint. | Obtient les détails d'un point d'accès à l'application (AAP). |
| UpdateApplicationAccessPoint | UpdateApplicationAccessPoint. | Met à jour les informations d'un point d'accès à l'application (AAP). |
| DeleteApplicationAccessPoint | DeleteApplicationAccessPoint. | Supprime un point d'accès à l'application (AAP). |
| CreateClientKey | CreateClientKey. | Crée une clé client. |
| ListClientKeys | ListClientKeys. | Consulte toutes les clés client au sein d'un AAP. |
| GetClientKey | GetClientKey. | Obtient les informations relatives à une clé client. |
| DeleteClientKey | DeleteClientKey. | Supprime une clé client. |
Autres
|
API |
Titre |
Description |
| DescribeRegions | DescribeRegions. | Consulte les régions où KMS est disponible. |
| GetManagedDataKey | Récupération du texte en clair de la clé de données gérée. | Obtient le texte en clair d'une clé de données gérée (DK). |
| ListManagedDataKeyVersions | Liste des versions d'une clé de données gérée. | Répertorie les versions d'une clé de données gérée (DK) spécifiée. |