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

Descrição da operação

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

A instância está no estado Running.
A instância é uma instância de replica set ou cluster fragmentado.
- A versão do MongoDB de uma instância de replica set deve ser 3.4 ou posterior.
- O modo de armazenamento de uma instância de cluster fragmentado deve ser disco em nuvem ESSD.

Nota

Ao ativar, atualizar ou desativar o SSL, a instância é reiniciada uma vez. Execute esta operação fora do horário de pico.

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

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-bp2235****
SSLAction	string	Sim	A operação a ser executada no recurso SSL. Valores válidos: Open: Ativa a criptografia Secure Sockets Layer (SSL). Close: Desativa a criptografia Secure Sockets Layer (SSL). Update: Atualiza o certificado SSL.	Open
SwitchMode	string	Não	O momento em que a configuração SSL da instância MongoDB é modificada. Valores válidos: 0: Modifica a configuração imediatamente. 1: Modifica a configuração dentro da janela de O&M.	0
ForceEncryption	string	Não	Especifica se deve forçar a criptografia Secure Sockets Layer (SSL) para conexões. Valores válidos: 1: Força a criptografia Secure Sockets Layer (SSL). 0: Não força a criptografia Secure Sockets Layer (SSL). Nota A criptografia forçada Secure Sockets Layer (SSL) aplica-se apenas a instâncias MongoDB 7.0 e 8.0 que usam discos em nuvem e atendem aos seguintes requisitos de versão secundária do mecanismo: MongoDB 7.0: A versão secundária do mecanismo deve ser 8.0.13 ou posterior. MongoDB 8.0: A versão secundária do mecanismo deve ser 9.0.5 ou posterior. Aviso Após ativar a criptografia forçada Secure Sockets Layer (SSL), você não pode se conectar à instância usando conexões não SSL. Valores válidos: 0 : 0 1 : 1	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	6D806B11-078F-4154-BF9F-844F56D08964

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParam	Specified parameters is not valid.
400	SSLAlreadyEnabled	SSL have already been enabled.
400	SSLAlreadyDisabled	SSL have already been disabled.
403	SSLNotEnabled	SSL not enabled.
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.	O status atual da instância de banco de dados não suporta esta operação.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	O modo de bloqueio atual da instância de banco de dados não suporta esta operação.
404	EnabledSSLNotSupport	Specified region does not support enable ssl.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.