DescribeDBInstanceEncryptionKey - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Descripción de la operación

Al llamar a la operación DescribeDBInstanceEncryptionKey, la instancia debe tener habilitado el cifrado transparente de datos (TDE) en modo BYOK. Puede llamar a la operación ModifyDBInstanceTDE para 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

dds:DescribeDBInstanceEncryptionKey

get

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-bp2235****
EncryptionKey	string	No	La clave personalizada para la instancia. Puede llamar a la operación DescribeUserEncryptionKeyList para consultar la lista de claves personalizadas de una instancia de ApsaraDB for MongoDB.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
Origin	string	El origen de la clave de la instancia.	Aliyun_KMS
Description	string	La descripción de la clave de la instancia.	ejemplo de descripción de clave
RequestId	string	El ID de la solicitud.	783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus	string	Indica si la clave de la instancia está habilitada. Valores válidos: Enabled Disabled	Enabled
MaterialExpireTime	string	La hora de caducidad de la clave de la instancia. La hora se muestra en formato UTC. Si el parámetro se deja vacío, la clave de la instancia no caducará.	2020-07-06T18:22:03Z
KeyUsage	string	El propósito de la clave de la instancia.	ENCRYPT/DECRYPT
EncryptionKey	string	La clave de la instancia.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator	string	El UID del creador de la clave.	123456
DeleteDate	string	La hora programada en la que se eliminará la clave de la instancia. Si el parámetro se deja vacío, la clave no se eliminará.	2020-07-06T18:22:03Z

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty
403	NO_ACTIVE_BYOK	This custins no active byok.

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.