Modificação de parâmetros de uma instância de banco de dados especificada
Descrição
Esta API é usada para modificar os parâmetros de uma instância de banco de dados especificada. Os parâmetros podem ser o modelo de parâmetro de uma instância de banco de dados, grupo ou nó.
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 Parâmetros de corpo de solicitação Nome
Obrigatório
Tipo
Descrição
entity_id
Sim
String
ID da instância, ID do grupo ou ID do nó. Você pode chamar a API usada para consultar instâncias e detalhes para obter o valor. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.
- Se o tipo de instância de banco de dados for cluster e o modelo de parâmetro shard ou config for alterado, o valor será o ID do grupo. Se o modelo de parâmetro do nó mongos for alterado, o valor será o ID do nó.
- Se a instância de banco de dados a ser alterada for uma instância de conjunto de réplicas ou uma instância de nó único, o valor será o ID da instância.
parameter_values
Sim
Map<String,String>
Mapeamento entre nomes de parâmetros e valores de parâmetros. É possível personalizar valores de parâmetros com base nos parâmetros no modelo de parâmetro padrão.
- Exemplo de solicitação
{ "entity_id" : "73ea2bf70c73497f89ee0ad4ee008aa2no02", "parameter_values" : { "max_connections" : "10" } }
Respostas
- Descrição do parâmetro
Tabela 3 Parâmetros de corpo da resposta Parâmetro
Tipo
Descrição
job_id
String
O ID da tarefa assíncrona para modificar parâmetros de instância.
restart_required
Boolean
Verifique se a instância, o grupo ou o nó precisam ser reiniciados após a modificação do parâmetro.
- Se o valor for false, a instância não precisará ser reiniciada.
- Se o valor for true, a instância precisará ser reiniciada.
- Exemplo de resposta
{ "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f", "result_required" : false }
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.