ModifyDBInstanceTDE - - Centre de documentation Alibaba Cloud

Description de l'opération

Le chiffrement transparent des données (TDE) fournit un chiffrement et un déchiffrement des E/S en temps réel pour les fichiers de données. Les données sont chiffrées avant d'être écrites sur un disque et déchiffrées lorsqu'elles sont lues du disque vers la mémoire. Pour plus d'informations, consultez Configurer le TDE.

Remarque

Vous ne pouvez pas désactiver le TDE une fois qu'il est activé.

Avant d'appeler cette opération, assurez-vous que l'instance répond aux exigences suivantes :

L'instance est une instance de jeu de réplicas ou une instance de cluster fragmenté.
L'instance utilise le moteur de stockage WiredTiger.
L'instance utilise des disques locaux.
L'instance exécute MongoDB 4.0 ou 4.2. Si l'instance exécute une version antérieure, vous devez mettre à niveau la version de la base de données en appelant l'opération UpgradeDBInstanceEngineVersion.

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.

dds:ModifyDBInstanceTDE

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance.	dds-bpxxxxxxxx
TDEStatus	string	Oui	L'état du TDE. Définissez la valeur sur enabled pour activer le TDE. Remarque Vous ne pouvez pas désactiver le TDE une fois qu'il est activé. Activez cette fonctionnalité avec prudence.	enabled
EncryptorName	string	Non	La méthode de chiffrement. Définissez la valeur sur aes-256-cbc. Remarque Ce paramètre n'est disponible que lorsque TDEStatus est défini sur enabled.	aes-256-cbc
EncryptionKey	string	Non	L'identifiant de la clé personnalisée. Les clés personnalisées ne sont prises en charge que dans les régions suivantes. Dans les autres régions, la clé par défaut est utilisée. Singapour (ap-southeast-1) Hangzhou (cn-hangzhou) Shanghai (cn-shanghai) Pékin (cn-beijing) Shenzhen (cn-shenzhen) Hong Kong (cn-hongkong) Malaisie (ap-southeast-3)	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
RoleARN	string	Non	Le nom de ressource Alibaba Cloud (ARN) du rôle RAM. Le format est `acs:ram::$accountID:role/$roleName`. Remarque `$accountID` : L'identifiant de votre compte Alibaba Cloud. Pour afficher l'identifiant, connectez-vous à la console de gestion Alibaba Cloud, passez le pointeur sur votre photo de profil dans le coin supérieur droit, puis cliquez sur Paramètres de sécurité. `$roleName` : Le nom du rôle RAM. Pour afficher le nom, connectez-vous à la console RAM, cliquez sur Gestion des rôles RAM dans le volet de navigation de gauche, puis consultez le nom du rôle dans la liste Nom du rôle RAM.	acs:ram::123456789012****:role/adminrole
SwitchMode	string	Non	Indique quand activer le TDE. Valeurs valides : 0 : Active le TDE immédiatement. 1 : Active le TDE pendant la fenêtre de maintenance.	0

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	434D7127-6229-4355-BA50-7A3685A725DF

Exemples

JSON format

{
  "RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	UnsupportedDBTdeStatus	Specified DB TDEStatus does not support this operation.
403	UnsupportedEngine	Current DB Instance engine does not support this operation.
403	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The current database instance locking mode does not support this operation.
404	InvalidClusterKms	this cluster not kms service.
404	InvalidParam	Specified parameters is not valid.

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

Notes de version

Consultez Notes de version pour la liste complète.