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

Descrição da operação

Você pode usar as chaves personalizadas retornadas por esta operação para ativar a criptografia de dados transparente (TDE). Para obter mais informações, consulte ModifyDBInstanceTDE.

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

get

*dbinstance

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
TargetRegionId	string	Não	O ID da região de destino. Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis.	cn-shanghai
RoleARN	string	Não	O Alibaba Cloud Resource Name (ARN) da função RAM. Formato: `acs:ram::$accountID:role/$roleName`. O valor padrão é `acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole`.\n\n> - `$accountID`: o ID da sua conta Alibaba Cloud. Para visualizar o ID, faça login no Console de Gerenciamento da Alibaba Cloud, passe o cursor sobre a foto do perfil no canto superior direito e clique em Configurações de Segurança.\n>\n> - `$roleName`: o nome da função RAM. Para visualizar o nome da função, faça login no console RAM. No painel de navegação à esquerda, clique em Gerenciamento de Funções RAM. Encontre o nome da função na lista Nome da Função RAM.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIds	object
KeyId	array	Uma lista de chaves da instância.
	string	A chave da instância.	2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.