Página inicial do Docs → MongoDB Ops Manager

Atualizar uma configuração de armazenamento de sincronização

Nesta página

Recurso

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

Atualiza a configuração de um armazenamento de sincronização.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Recurso

PUT /sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
armazenamento de sincronização-CONFIG-ID	string	O identificador exclusivo que representa esta configuração do armazenamento de sincronização.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome

Tipo

necessidade

Descrição

default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
Status	Código de resposta HTTP
envelope	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome	Tipo	Descrição
assignEnabled	booleano	Opcional. Sinalizador que indica se tarefas de backup podem ser atribuídas a esse armazenamento de sincronização.
Credenciais criptografadas	booleano	Opcional. Sinalizador que indica se o nome de usuário e a senha desse armazenamento de sincronização foram criptografados usando a ferramenta de credenciais.
rótulos	array de strings	Opcional. Array de tags para gerenciar quais tarefas de backup o Ops Manager pode atribuir a quais armazenamentos de sincronização. A definição dessas tags limita quais tarefas de backup esse armazenamento de sincronização pode processar. Se omitido, esse armazenamento de sincronização só poderá processar tarefas de backup para projetos que não usam rótulos para filtrar suas tarefas.
maxCapacityGB	número	Opcional. A quantidade máxima de dados em GB que este armazenamento de sincronização pode armazenar.
uri	string	Uma lista separada por vírgulas de hosts no formato `<hostname:port>` que pode ser usada para acessar esse armazenamento de sincronização.
ssl	booleano	Opcional. Sinalizador que indica se este armazenamento de sincronização aceita apenas conexões criptografadas usando TLS.
Escreva preocupação	string	Opcional. A referência de escrita usada para este armazenamento de sincronização. Os valores aceitos para esta opção são: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Dica Veja também: Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern

Resposta

Nome	Tipo	Descrição
assignEnabled	booleano	Sinalizador que indica se tarefas de backup podem ser atribuídas a esse armazenamento de sincronização.
Credenciais criptografadas	booleano	Sinalizador que indica se o nome de usuário e a senha desse armazenamento de sincronização foram criptografados usando a ferramenta de credenciais.
id	string	O nome exclusivo que rotula esse armazenamento de sincronização.
rótulos	array de strings	Array de tags para gerenciar quais tarefas de backup o Ops Manager pode atribuir a quais armazenamentos de sincronização.
links	array de objetos	Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as `links` arrays nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
maxCapacityGB	número	A quantidade máxima de dados em GB que este armazenamento de sincronização pode armazenar.
uri	string	Uma lista separada por vírgulas de hosts no formato `<hostname:port>` que pode ser usada para acessar esse armazenamento de sincronização.
ssl	booleano	Sinalizador que indica se este armazenamento de sincronização aceita apenas conexões criptografadas usando TLS.
usadoSize	número	A quantidade de capacidade de backup em MB que os backups existentes consomem.
Escreva preocupação	string	A referência de escrita usada para este armazenamento de sincronização. Os valores aceitos para esta opção são: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Dica Veja também: Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "writeConcern" : "W2"
}'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

← Criar uma configuração de armazenamento de sincronização

Excluir uma configuração do armazenamento de sincronização →