Encrypt - - Centre de documentation Alibaba Cloud

Description de l'opération

Précautions

Pour plus d'informations sur la stratégie d'accès requise pour autoriser un utilisateur RAM ou un rôle RAM à utiliser cette opération, consultez Resource Access Management.
Cette opération est accessible via une passerelle partagée ou une passerelle dédiée. Pour plus d'informations, consultez Alibaba Cloud SDK.
- Passerelle partagée : vous pouvez accéder à KMS via Internet ou un VPC. Pour utiliser cette méthode, vous devez activer l'accès à Internet. Pour plus d'informations, consultez Clés d'accès d'une instance KMS via Internet.
- Passerelle dédiée : vous pouvez accéder à KMS en utilisant le point de terminaison privé de KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Limites de QPS

Lors d'un accès via une passerelle partagée, la limite de requêtes par seconde (QPS) pour un seul utilisateur est de 1 000. Si cette limite est dépassée, les requêtes sont limitées, ce qui peut affecter votre activité. Nous vous recommandons de rester en deçà de cette limite pour éviter toute limitation.
Lors d'un accès via une passerelle dédiée, la limite de QPS pour un seul utilisateur dépend des spécifications de performances de calcul de votre instance KMS. Pour plus d'informations, consultez Indicateurs de performance.

Description

KMS chiffre les données spécifiées à l'aide de la version principale d'une clé spécifiée.
Vous pouvez chiffrer un maximum de 6 Ko de données, telles qu'une clé RSA, un mot de passe de base de données ou d'autres informations sensibles.
Si vous migrez des données chiffrées d'une région à une autre, vous pouvez appeler l'opération Encrypt dans la région de destination pour rechiffrer la clé de données en texte en clair provenant de la région source. Cela génère une nouvelle clé de données chiffrée. Vous pouvez ensuite appeler l'opération Decrypt pour déchiffrer cette nouvelle clé dans la région de destination.

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
KeyId	string	Oui	L'identifiant de la clé. Vous pouvez également spécifier l'alias ou l'Amazon Resource Name (ARN) de la clé. Pour plus d'informations sur les alias, consultez Gérer les alias. Remarque Lorsque vous accédez à une clé dans un autre compte Alibaba Cloud, vous devez spécifier l'ARN de la clé. L'ARN d'une clé suit le format `acs:kms:${region}:${account}:key/${keyid}`.	key-hzz630494463ejqjx****
Plaintext	string	Oui	Le texte en clair à chiffrer. Le texte en clair doit être encodé en Base64.	SGVsbG8gd29y****
EncryptionContext	object	Non	Une chaîne JSON composée de paires clé-valeur. Si vous spécifiez ce paramètre, vous devez spécifier le même paramètre lors de l'appel de l'opération Decrypt. Pour plus d'informations, consultez EncryptionContext.	{"Example":"Example"}
DryRun	string	Non	Indique si la fonctionnalité de test à blanc doit être activée. true : active la fonctionnalité de test à blanc. false (par défaut) : désactive la fonctionnalité de test à blanc. La fonctionnalité de test à blanc est utilisée pour tester les appels d'API et vérifier les autorisations sur les ressources dont vous disposez ainsi que la validité des paramètres de la requête. Vous pouvez consulter les résultats de la vérification dans la réponse. DryRunOperationError : les autorisations et les paramètres sont valides. Si vous ne spécifiez pas le paramètre DryRun, la requête aboutit. ValidationError : les paramètres de la requête ne sont pas valides. AccessDeniedError : vous n'êtes pas autorisé à effectuer cette opération sur la ressource KMS.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object
KeyVersionId	string	L'identifiant de la version de clé utilisée pour chiffrer le texte en clair. Il s'agit de la version principale de la clé spécifiée.	86a9efd9-3d16-4894-bd4f-1fc43f3f****
KeyId	string	L'identifiant de la clé. Si vous utilisez un alias ou un ARN de la clé dans la requête, l'identifiant de la clé est renvoyé.	key-hzz630494463ejqjx****
CiphertextBlob	string	Le texte chiffré des données chiffrées à l'aide de la version principale de la clé spécifiée.	DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
RequestId	string	L'identifiant de la requête, qui est un identifiant unique généré par Alibaba Cloud pour la requête. Vous pouvez utiliser cet identifiant pour résoudre les problèmes.	475f1620-b9d3-4d35-b5c6-3fbdd941423d

Exemples

JSON format

{
  "KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter	The specified parameter is invalid.	An invalid value is specified for the parameter.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.
404	Forbidden.AliasNotFound	The specified Alias is not found.	The error message returned because the specified alias does not exist.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

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

Notes de version

Consultez Notes de version pour la liste complète.