DescribeDBInstanceEncryptionKey - - Centre de documentation Alibaba Cloud

Description de l'opération

Lorsque vous appelez l'opération DescribeDBInstanceEncryptionKey, l'instance doit avoir le chiffrement transparent des données (TDE) activé en mode BYOK. Vous pouvez appeler l'opération ModifyDBInstanceTDE pour activer le TDE.

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

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-bp2235****
EncryptionKey	string	Non	La clé personnalisée de l'instance. Vous pouvez appeler l'opération DescribeUserEncryptionKeyList pour interroger la liste des clés personnalisées d'une instance ApsaraDB for MongoDB.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
Origin	string	La source de la clé de l'instance.	Aliyun_KMS
Description	string	La description de la clé de l'instance.	exemple de description de clé
RequestId	string	L'identifiant de la requête.	783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus	string	Indique si la clé de l'instance est activée. Valeurs valides : Enabled Disabled	Enabled
MaterialExpireTime	string	L'heure d'expiration de la clé de l'instance. L'heure est affichée en UTC. Si le paramètre est laissé vide, la clé de l'instance n'expire pas.	2020-07-06T18:22:03Z
KeyUsage	string	L'usage de la clé de l'instance.	ENCRYPT/DECRYPT
EncryptionKey	string	La clé de l'instance.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator	string	L'UID du créateur de la clé.	123456
DeleteDate	string	L'heure prévue à laquelle la clé de l'instance sera supprimée. Si le paramètre est laissé vide, la clé ne sera pas supprimée.	2020-07-06T18:22:03Z

Exemples

JSON format

{
  "Origin": "Aliyun_KMS",
  "Description": "key description example",
  "RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
  "EncryptionKeyStatus": "Enabled",
  "MaterialExpireTime": "2020-07-06T18:22:03Z",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Creator": "123456",
  "DeleteDate": "2020-07-06T18:22:03Z"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty
403	NO_ACTIVE_BYOK	This custins no active byok.

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

Notes de version

Consultez Notes de version pour la liste complète.