Página inicial do Docs

/ /

Sincronizar armazenamento

Página inicial do Docs

/ /

Administração de backup

Sincronizar armazenamento

Página inicial do Docs

Administração de backup

Sincronizar armazenamento

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

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

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

Resource

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	Identificador exclusivo para 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 que indica se o corpo da resposta está em um formato pretty-print.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de 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: `status`: Código de resposta HTTP `content`: 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 MongoDB 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 capacidade máxima disponível esperada do armazenamento de sincronização para uso no alerta. `maxCapacityGB` não impõe nenhuma limitação ao tamanho do banco de dados de apoio.
OIDC	objeto	Opcional. Configuraçõesde autenticação OIDC para este armazenamento. O `oidc` objeto aceita os seguintes campos: `enabled`: booleano. Habilita a autenticação OIDC para este armazenamento. `method`: Corda. Um entre `callback`, `azure`, `gcp` ou `k8s`. `tokenUri`: Corda. O ponto de extremidade do token IdP. Obrigatório `method` quando `callback` é. `clientId`: Corda. O ID do cliente registrado com o IdP. Obrigatório `method` quando `callback` é; opcional quando `method` `azure`é. `clientSecret`: Corda. O segredo do cliente registrado no IdP. Obrigatório `method` quando `callback` é. Se você editar um armazenamento existente e omitir esse campo ou enviar o valor editado retornado por uma `GET` solicitação anterior, o Ops Manager preservará o segredo existente. `scope`: Corda. O escopo OAuth2 solicitado do IdP. Usado somente `method` quando `callback` é. `tokenResource`: Corda. O identificador de público ou recurso para o token de identidade do volume de trabalho. Obrigatório quando `method` é `azure` `gcp`ou. Esse valor deve corresponder ao `audience` configurado para esse IdP na configuração do sistema do MongoDB de `oidcIdentityProviders` destino. Os métodos `callback`, `azure`, `gcp` e `k8s` não exigem todos os mesmos campos. Os métodos `azure`, `gcp` e `k8s` não exigem `clientSecret`. Quando `oidc.enabled` for `true`, forneça apenas hosts e opções de conexão no campo `uri` do armazenamento. O Ops Manager ignora qualquer nome de usuário ou senha incorporado no URI. Para mudar um armazenamento do OIDC para outro mecanismo de autenticação, envie `oidc: {enabled: false}` na solicitação em vez de omitir o `oidc` objeto.
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.
writeConcern	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` 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 MongoDB Ops Manager pode atribuir a quais armazenamentos de sincronização.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` 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	Opcional. A capacidade máxima disponível esperada do armazenamento de sincronização para uso no alerta. `maxCapacityGB` não impõe nenhuma limitação ao tamanho do banco de dados de apoio.
OIDC	objeto	Configuraçõesde autenticação OIDC para este armazenamento. O `oidc` objeto contém os seguintes campos: `enabled`: booleano. Indica se a autenticação OIDC está habilitada para este armazenamento. `method`: Corda. Um entre `callback`, `azure`, `gcp` ou `k8s`. `tokenUri`: Corda. O ponto de extremidade do token IdP. Presente somente `method` quando `callback` é. `clientId`: Corda. O ID do cliente registrado com o IdP. `clientSecret`: Corda. O Ops Manager edita esse valor na resposta e não retorna o segredo bruto do cliente . `scope`: Corda. O escopo OAuth2 solicitado do IdP. Presente somente `method` quando `callback` é. `tokenResource`: Corda. O identificador de público ou recurso para o token de identidade do volume de trabalho. Presente somente quando `method` é `azure` ou `gcp`.
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.
writeConcern	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` 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"
}

Voltar

criar

Excluir