Habilitação ou desabilitação do SSL
Descrição da API
Esta API é usada para ativar ou desativar o SSL.
Restrições
- Esta operação não pode ser executada em instâncias congeladas ou anormais.
- A instância de banco de dados deve ser reiniciada para que as alterações entrem em vigor. Tenha cuidado ao ativar ou desativar o SSL.
Depuração
Você pode depurar essa API no API Explorer.
URI
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário |
project_id |
string |
path |
Sim |
ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
instance_id |
string |
path |
Sim |
ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma. |
Solicitações
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
ssl_option
String
Sim
Habilitar ou desabilitar o SSL.
Valor válido:
- O valor 0 indica que o SSL está desabilitado por padrão.
- O valor 1 indica que o SSL está habilitado por padrão.
- Exemplo de solicitação
{ "ssl_option": "0" }
Respostas
- Descrição do parâmetro
Tabela 3 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
job_id
String
Sim
O ID do fluxo de trabalho.
ssl_option
String
Sim
Habilitar ou desabilitar o SSL.
Valor válido:
- O valor 0 indica que o SSL está desabilitado por padrão.
- O valor 1 indica que o SSL está habilitado por padrão.
- Exemplo de resposta
{ "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5", "ssl_option": "0" }
SDK
Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.
Código de status
Para obter mais informações, consulte Código de status.
Código de erro
Para obter mais informações, consulte Código de erro.