DescribeEncryptionKey - Tair (Redis® OSS-Compatible) - Centre de documentation Alibaba Cloud

Consulte les détails d'une clé personnalisée pour une instance Tair (compatible Redis OSS) afin d'utiliser le chiffrement transparent des données (TDE).

Description de l'opération

Avant d'appeler cette opération, le TDE doit être activé pour l'instance Tair (compatible Redis OSS) à l'aide d'une clé personnalisée. Pour plus d'informations, consultez ModifyInstanceTDE.

Remarque

Pour plus d'informations sur le TDE, consultez 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.

kvstore:DescribeEncryptionKey

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeInstances pour obtenir l'identifiant de l'instance.	r-bp1zxszhcgatnx****
EncryptionKey	string	Non	L'identifiant de la clé personnalisée. Vous pouvez appeler l'opération DescribeEncryptionKeyList pour obtenir l'identifiant de la clé.	ad463061-992d-4195-8a94-ed63********

Éléments de réponse

Élément	Type	Description	Exemple
	object
DeleteDate	string	L'heure à laquelle la clé personnalisée devrait être supprimée. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC. Remarque Si la valeur renvoyée est une chaîne vide, la clé personnalisée ne peut pas être supprimée automatiquement.	2021-09-24T18:22:03Z
RequestId	string	L'identifiant de la requête.	9A931CE5-C926-5E09-B0EC-6299C4A6****
Description	string	La description de la clé personnalisée. Par défaut, une chaîne vide est renvoyée.	testkey
Origin	string	La source de la clé personnalisée. La valeur Aliyun_KMS indique le Key Management Service (KMS) d'Alibaba Cloud.	Aliyun_KMS
MaterialExpireTime	string	L'heure à laquelle la clé personnalisée expire. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC. Remarque Si la valeur renvoyée est une chaîne vide, la clé personnalisée n'expire pas.	2021-09-24T18:22:03Z
EncryptionKeyStatus	string	L'état de la clé personnalisée. Valeurs valides : Enabled : la clé personnalisée est disponible. Disabled : la clé personnalisée n'est pas disponible.	Enabled
KeyUsage	string	L'objectif de la clé personnalisée. La valeur `ENCRYPT/DECRYPT` indique le chiffrement et le déchiffrement.	ENCRYPT/DECRYPT
EncryptionKey	string	L'identifiant de la clé personnalisée.	ad463061-992d-4195-8a94-ed63********
Creator	string	L'identifiant du compte Alibaba Cloud utilisé pour créer la clé personnalisée.	17649847********
EncryptionName	string	L'algorithme de chiffrement.	AES-CTR-256
RoleArn	string	L'Alibaba Cloud Resource Name (ARN) du rôle Resource Access Management (RAM) auquel vous souhaitez accorder des autorisations.	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

Exemples

JSON format

{
  "DeleteDate": "2021-09-24T18:22:03Z",
  "RequestId": "9A931CE5-C926-5E09-B0EC-6299C4A6****",
  "Description": "testkey",
  "Origin": "Aliyun_KMS",
  "MaterialExpireTime": "2021-09-24T18:22:03Z",
  "EncryptionKeyStatus": "Enabled",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "ad463061-992d-4195-8a94-ed63********",
  "Creator": "17649847********",
  "EncryptionName": "AES-CTR-256",
  "RoleArn": "acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InstanceType.NotSupport	Current instance type does not support this operation.	The current instance type does not support this operation

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

Notes de version

Consultez Notes de version pour la liste complète.