Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

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

Configura um novo armazenamento de sincronização.

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

POST /sync/mongoConfigs

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

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

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.

id

string

O nome exclusivo que rotula esse armazenamento de sincronização.

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. OIDC configurações de autenticação para este armazenar. O objeto oidc aceita os seguintes campos:

  • enabled: booleano. Habilita a autenticação OIDC para este armazenar.

  • method: string. Um de callback, azure, gcp ou k8s.

  • tokenUri: string. O ponto de extremidade de token do provedor de identidade. Obrigatório quando method é callback.

  • clientId: string. O ID do cliente registrado com o provedor de identidade. Obrigatório quando method é callback; opcional quando method é azure.

  • clientSecret: string. O segredo do cliente registrado com o provedor de identidade. Obrigatório quando method está definido como callback. Se você editar um armazenar existente e omitir este campo ou enviar o valor editado retornado por uma solicitação GET anterior, o MongoDB Ops Manager preservará o segredo existente.

  • scope: string. O escopo OAuth2 solicitado do provedor de identidade. Usado apenas quando method é callback.

  • tokenResource: string. O identificador de público ou recurso para o token de identidade de carga de trabalho. Obrigatório quando method for azure ou gcp. Este valor deve corresponder ao audience configurado para este provedor de identidade na configuração oidcIdentityProviders da implantação do MongoDB de 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 é true, forneça apenas hosts e opções de conexão no campo uri do armazenamento. O MongoDB Ops Manager ignora qualquer nome de usuário ou senha incorporado no URI.

Para alternar um repositório de OIDC para outro mecanismo de autenticação, envie oidc: {enabled: false} na solicitação em vez de omitir o objeto oidc.

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

Optional. Flag indicating whether this sync store only accepts connections encrypted using 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.

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

OIDC configurações de autenticação para este armazenar. O objeto oidc contém os seguintes campos:

  • enabled: booleano. Indica se a autenticação OIDC está habilitada para este armazenar.

  • method: string. Um de callback, azure, gcp ou k8s.

  • tokenUri: string. O ponto de extremidade de token do provedor de identidade. Presente apenas quando method é callback.

  • clientId: string. O ID do cliente registrado com o provedor de identidade.

  • clientSecret: string. O Ops Manager redige esse valor na resposta e não retorna o segredo bruto do cliente.

  • scope: string. O escopo OAuth2 solicitado do provedor de identidade. Apenas quando method for callback.

  • tokenResource: string. O identificador de público ou recurso para o token de identidade da carga de trabalho. Presente apenas 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.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true' \ --data '{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{SYNCSTORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "writeConcern" : "W2" }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{SYNCSTORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2"}