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

Descripción de la operación

El cifrado de datos transparente (TDE) proporciona cifrado y descifrado de E/S en tiempo real para archivos de datos. Los datos se cifran antes de escribirse en un disco y se descifran cuando se leen del disco a la memoria. Para obtener más información, consulte Configurar TDE.

Nota

No puede deshabilitar TDE después de habilitarlo.

Antes de llamar a esta operación, asegúrese de que la instancia cumpla con los siguientes requisitos:

La instancia es una instancia de conjunto de réplicas o una instancia de clúster fragmentado.
La instancia utiliza el motor de almacenamiento WiredTiger.
La instancia utiliza discos locales.
La instancia ejecuta MongoDB 4.0 o 4.2. Si la instancia ejecuta una versión anterior, debe actualizar la versión de la base de datos mediante la operación UpgradeDBInstanceEngineVersion.

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

update

*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-bpxxxxxxxx
TDEStatus	string	Sí	El estado de TDE. Establezca el valor en enabled para habilitar TDE. Nota No puede deshabilitar TDE después de habilitarlo. Habilite esta función con precaución.	enabled
EncryptorName	string	No	El método de cifrado. Establezca el valor en aes-256-cbc. Nota Este parámetro está disponible solo cuando TDEStatus se establece en enabled.	aes-256-cbc
EncryptionKey	string	No	El ID de la clave personalizada. Las claves personalizadas solo son compatibles en las siguientes regiones. En otras regiones, se utiliza la clave predeterminada. Singapur (ap-southeast-1) Hangzhou (cn-hangzhou) Shanghái (cn-shanghai) Pekín (cn-beijing) Shenzhen (cn-shenzhen) Hong Kong (cn-hongkong) Malasia (ap-southeast-3)	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
RoleARN	string	No	El nombre de recurso de Alibaba Cloud (ARN) del rol de RAM. El formato es `acs:ram::$accountID:role/$roleName` . Nota `$accountID`: El ID de su cuenta de Alibaba Cloud. Para ver el ID, inicie sesión en la consola de administración de Alibaba Cloud, mueva el puntero sobre su foto de perfil en la esquina superior derecha y luego haga clic en Configuración de seguridad. `$roleName`: El nombre del rol de RAM. Para ver el nombre, inicie sesión en la consola de RAM, haga clic en Gestión de roles de RAM en el panel de navegación izquierdo y luego vea el nombre del rol en la lista Nombre de rol de RAM.	acs:ram::123456789012****:role/adminrole
SwitchMode	string	No	Especifica cuándo habilitar TDE. Valores válidos: 0: Habilita TDE inmediatamente. 1: Habilita TDE durante la ventana de mantenimiento.	0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	434D7127-6229-4355-BA50-7A3685A725DF

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	UnsupportedDBTdeStatus	Specified DB TDEStatus does not support this operation.
403	UnsupportedEngine	Current DB Instance engine does not support this operation.
403	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The current database instance locking mode does not support this operation.
404	InvalidClusterKms	this cluster not kms service.
404	InvalidParam	Specified parameters is not valid.

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.