DescribeDBInstanceTDEInfo - - Centre de documentation Alibaba Cloud

Description de l'opération

Remarque

Pour plus d'informations sur cette fonctionnalité, consultez Paramètres du chiffrement transparent des données TDE.

Lorsque vous appelez cette opération, l'instance doit satisfaire aux conditions suivantes :

L'instance est une instance de jeu de réplicas ou une instance de cluster fragmenté.
Le moteur de stockage de l'instance est WiredTiger.
La version du moteur de base de données de l'instance est 4.0 ou 4.2. Si la version du moteur de base de données est antérieure à la version requise, vous pouvez appeler l'opération UpgradeDBInstanceEngineVersion pour mettre à niveau la version du moteur de base de données.

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:DescribeDBInstanceTDEInfo

get

*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

Éléments de réponse

Élément	Type	Description	Exemple
	object
TDEStatus	string	L'état d'activation de TDE. Valeurs valides : enabled : TDE est activé. disabled : TDE est désactivé. Remarque Si l'état de TDE est désactivé, les paramètres RoleARN, EncryptionKey et EncryptorName ne sont pas renvoyés.	enabled
RequestId	string	L'identifiant de la requête.	F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARN	string	Le descripteur de ressource global ARN (Alibaba Cloud Resource Name) du rôle en attente d'autorisation.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	La clé personnalisée de l'instance. Actuellement, seules les régions suivantes prennent en charge Bring Your Own Key (BYOK), ce qui vous permet de gérer et de posséder des clés de chiffrement : Chine (Hangzhou) Chine (Shanghai) Chine (Pékin) Chine (Shenzhen) Hong Kong (Chine) Singapour Malaisie (Kuala Lumpur) Remarque Si BYOK est pris en charge, vous pouvez gérer et posséder la clé, et le système renvoie votre clé personnalisée. Si BYOK n'est pas pris en charge, vous ne pouvez pas gérer la clé et le système renvoie la chaîne `NoActiveBYOK`.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorName	string	L'algorithme de chiffrement.	aes-256-cbc

Exemples

JSON format

{
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6",
  "RoleARN": "acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptorName": "aes-256-cbc"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.