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

Descrição da operação

Ao chamar a operação DescribeDBInstanceEncryptionKey, a instância deve ter a criptografia de dados transparente (TDE) ativada no modo BYOK. Você pode chamar a operação ModifyDBInstanceTDE para ativar o TDE.

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

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-bp2235****
EncryptionKey	string	Não	A chave personalizada para a instância. Você pode chamar a operação DescribeUserEncryptionKeyList para consultar a lista de chaves personalizadas de uma instância do ApsaraDB for MongoDB.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
Origin	string	A origem da chave da instância.	Aliyun_KMS
Description	string	A descrição da chave da instância.	key description example
RequestId	string	O ID da solicitação.	783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus	string	Indica se a chave da instância está ativada. Valores válidos: Enabled Disabled	Enabled
MaterialExpireTime	string	O horário de expiração da chave da instância. O horário é exibido em UTC. Se o parâmetro for deixado em branco, a chave da instância não expirará.	2020-07-06T18:22:03Z
KeyUsage	string	A finalidade da chave da instância.	ENCRYPT/DECRYPT
EncryptionKey	string	A chave da instância.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator	string	O UID do criador da chave.	123456
DeleteDate	string	O horário agendado para a exclusão da chave da instância. Se o parâmetro for deixado em branco, a chave não será excluída.	2020-07-06T18:22:03Z

Exemplos

Resposta de sucesso

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 erro

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

Notas de versão

Consulte Notas de Versão para uma lista completa.