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

Descrição da operação

Nota

Para obter mais informações sobre este recurso, consulte Configurações para criptografia de dados transparente TDE.

Ao invocar esta operação, a instância deve atender às seguintes condições:

A instância é uma instância de conjunto de réplicas ou uma instância de cluster fragmentado.
O mecanismo de DPI de armazenamento da instância é o WiredTiger.
A versão do mecanismo de DPI do banco de dados da instância é 4.0 ou 4.2. Se a versão do mecanismo de DPI do banco de dados for anterior à versão necessária, você pode invocar a operação UpgradeDBInstanceEngineVersion para atualizar a versão do mecanismo de DPI do banco de dados.

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

get

*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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TDEStatus	string	O status de ativação do TDE. Valores válidos: enabled: o TDE está ativado. disabled: o TDE está desativado. Nota Se o status do TDE for disabled, os parâmetros RoleARN, EncryptionKey e EncryptorName não serão retornados.	enabled
RequestId	string	O ID da solicitação.	F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARN	string	O ARN (Alibaba Cloud Resource Name) do descritor de recurso global da função com autorização pendente.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	A chave personalizada da instância. Atualmente, apenas as seguintes regiões suportam o Bring Your Own Key (BYOK), que permite que você gerencie e possua chaves de criptografia: China (Hangzhou) China (Shanghai) China (Pequim) China (Shenzhen) Hong Kong (China) Singapura Malásia (Kuala Lumpur) Nota Se o BYOK for suportado, você poderá gerenciar e possuir a chave, e o sistema retornará sua chave personalizada. Se o BYOK não for suportado, você não poderá gerenciar a chave, e o sistema retornará a string `NoActiveBYOK`.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorName	string	O algoritmo de criptografia.	aes-256-cbc

Exemplos

Resposta de sucesso

JSON formato

{
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6",
  "RoleARN": "acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptorName": "aes-256-cbc"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.