DescribeEncryptionKey - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Consulta los detalles de una clave personalizada para una instancia de Tair (compatible con Redis® OSS) que utiliza cifrado transparente de datos (TDE).

Descripción de la operación

Antes de llamar a esta operación, debe habilitar TDE para la instancia de Tair (compatible con Redis OSS) mediante una clave personalizada. Para obtener más información, consulte ModifyInstanceTDE.

Nota

Para obtener más información sobre TDE, consulte Habilitar TDE.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

kvstore:DescribeEncryptionKey

get

*DBInstance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeInstances para consultar el ID de la instancia.	r-bp1zxszhcgatnx****
EncryptionKey	string	No	El ID de la clave personalizada. Puede llamar a la operación DescribeEncryptionKeyList para consultar el ID de la clave.	ad463061-992d-4195-8a94-ed63********

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
DeleteDate	string	La hora en la que se prevé eliminar la clave personalizada. La hora sigue el estándar ISO 8601 con el formato aaaa-MM-ddTHH:mm:ssZ. La hora se muestra en UTC. Nota Si el valor devuelto es una cadena vacía, la clave personalizada no se puede eliminar automáticamente.	2021-09-24T18:22:03Z
RequestId	string	El ID de la solicitud.	9A931CE5-C926-5E09-B0EC-6299C4A6****
Description	string	La descripción de la clave personalizada. De forma predeterminada, se devuelve una cadena vacía.	testkey
Origin	string	El origen de la clave personalizada. El valor Aliyun_KMS indica Key Management Service (KMS) de Alibaba Cloud.	Aliyun_KMS
MaterialExpireTime	string	La hora en la que caduca la clave personalizada. La hora sigue el estándar ISO 8601 con el formato aaaa-MM-ddTHH:mm:ssZ. La hora se muestra en UTC. Nota Si el valor devuelto es una cadena vacía, la clave personalizada no caduca.	2021-09-24T18:22:03Z
EncryptionKeyStatus	string	El estado de la clave personalizada. Valores válidos: Enabled: La clave personalizada está disponible. Disabled: La clave personalizada no está disponible.	Enabled
KeyUsage	string	El propósito de la clave personalizada. El valor `ENCRYPT/DECRYPT` indica cifrado y descifrado.	ENCRYPT/DECRYPT
EncryptionKey	string	El ID de la clave personalizada.	ad463061-992d-4195-8a94-ed63********
Creator	string	El ID de la cuenta de Alibaba Cloud que se utilizó para crear la clave personalizada.	17649847********
EncryptionName	string	El algoritmo de cifrado.	AES-CTR-256
RoleArn	string	El nombre de recurso de Alibaba Cloud (ARN) del rol de Resource Access Management (RAM) al que desea otorgar permisos.	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InstanceType.NotSupport	Current instance type does not support this operation.	The current instance type does not support this operation

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.