ModifyDBInstanceTDE - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Descrição da operação

O Transparent Data Encryption (TDE) fornece criptografia e descriptografia de I/O em tempo real para arquivos de dados. Os dados são criptografados antes de serem gravados em disco e descriptografados quando são lidos do disco para a memória. Para mais informações, consulte Configurar TDE.

Nota

Você não pode desativar o TDE após ele ser ativado.

Antes de chamar esta operação, certifique-se de que a instância atende aos seguintes requisitos:

A instância é uma instância de conjunto de réplicas ou uma instância de cluster fragmentado.
A instância usa o mecanismo de armazenamento WiredTiger.
A instância usa discos locais.
A instância executa MongoDB 4.0 ou 4.2. Se a instância executar uma versão anterior, você deve atualizar a versão do banco de dados chamando a operação UpgradeDBInstanceEngineVersion.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:ModifyDBInstanceTDE

update

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bpxxxxxxxx
TDEStatus	string	Sim	O status do TDE. Defina o valor como enabled para ativar o TDE. Nota Você não pode desativar o TDE após ativá-lo. Ative este recurso com cautela.	enabled
EncryptorName	string	Não	O método de criptografia. Defina o valor como aes-256-cbc. Nota Este parâmetro está disponível apenas quando TDEStatus está definido como enabled.	aes-256-cbc
EncryptionKey	string	Não	O ID da chave personalizada. Chaves personalizadas são suportadas apenas nas seguintes regiões. Em outras regiões, a chave padrão é utilizada. Singapura (ap-southeast-1) Hangzhou (cn-hangzhou) Xangai (cn-shanghai) Pequim (cn-beijing) Shenzhen (cn-shenzhen) Hong Kong (cn-hongkong) Malásia (ap-southeast-3)	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
RoleARN	string	Não	O Alibaba Cloud Resource Name (ARN) da função RAM. O formato é `acs:ram::$accountID:role/$roleName` . Nota `$accountID`: O ID da sua conta Alibaba Cloud. Para visualizar o ID, faça login no Console de Gerenciamento da Alibaba Cloud, passe o ponteiro sobre sua foto de perfil no canto superior direito e clique em Configurações de Segurança. `$roleName`: O nome da função RAM. Para visualizar o nome, faça login no console RAM, clique em Gerenciamento de Funções RAM no painel de navegação à esquerda e visualize o nome da função na lista Nome da Função RAM.	acs:ram::123456789012****:role/adminrole
SwitchMode	string	Não	Especifica quando ativar o TDE. Valores válidos: 0: Ativa o TDE imediatamente. 1: Ativa o TDE durante a janela de manutenção.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	434D7127-6229-4355-BA50-7A3685A725DF

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.