Atualizar configuração das tarefas de backup de um projeto

Nesta página

Resource

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

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

Atualiza a configuração das tarefas de backup de um projeto.

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

Resource

PUT /groups/{PROJECT-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	O identificador único que representa este projeto e sua configuração de tarefa de backup.

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
daemonFilter	array de objetos	Opcional. Uma array de pares de hosts do Backup Daemon e seusdiretórios head para os quais as tarefas de backup deste projeto são limitadas. Se omitido, todos os Backup Daemons disponíveis serão usados.
daemonFilter.headRootDirectory	string	Opcional. O caminho relativo à raiz do diretório principal neste host do Backup Daemon .
daemonFilter.machine	string	O endereço de host para um host do Backup Daemon .
id	string	O identificador único que representa este projeto e sua configuração de tarefa de backup.
kmipClientCertPassword	string	Opcional. A senha que criptografa o certificado do cliente KMIP .
kmipClientCertPath	string	Opcional. O caminho relativo à raiz no host do Backup Daemon que armazena o certificado do cliente KMIP .
filtro de etiqueta	array de strings	Opcional. Uma array de tags que limita quais Backup Daemons e armazenamentos de snapshots podem processar tarefas de backup para esse projeto. Se um armazenamento de snapshots ou qualquer Backup Daemon tiver o mesmo `labels` definido como este `labelFilter`, eles poderão processar tarefas de backup para este projeto. Se omitido, as tarefas de backup do projeto podem usar qualquer Backup Daemon ou armazenamento de snapshots disponível.
oplogStoreFilter	Array de objetos	Opcional. Uma array de identificadores únicos representando armazenamentos deoplog que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de oplog disponíveis podem ser usados.
oplogStoreFilter.id	string	Identificador único que representa um armazenamento de oplog que pode ser usado com as tarefas de backup deste projeto. Recupere o `id` do armazenamento de oplog que você deseja usar com Obter todas as configurações de oplog .
oplogStoreFilter.type	string	Tipo de armazenamento de oplog a ser usado. O único valor suportado é `oplogStore`.
snapshotStoreFilter	Array de objetos	Opcional. Array de identificadores únicos representando armazenamentos de snapshots específicos e seus tipos que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de snapshots disponíveis serão usados.
snapshotStoreFilter.id	string	Opcional. O identificador exclusivo que representa armazenamentos de snapshots específicos que podem ser usados com as tarefas de backup deste projeto.
snapshotStoreFilter.type	string	Opcional. O tipo do armazenamento de snapshots específico fornecido como `snapshotStoreFilter.id`. Os valores aceitos para esta opção são: `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	array de strings	Opcional. Uma array de filtros de armazenamento de sincronização que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de sincronização disponíveis serão usados.

Resposta

Nome	Tipo	Descrição
daemonFilter	array de objetos	Uma array de pares de hosts do Backup Daemon e seus diretórios principais para o qual as tarefas de backup deste projeto são limitadas.
daemonFilter.headRootDirectory	string	O caminho relativo à raiz do diretório principal neste host do Backup Daemon .
daemonFilter.machine	string	O endereço de host para um host do Backup Daemon .
id	string	O identificador único que representa este projeto e sua configuração de tarefa de backup.
kmipClientCertPassword	string	A senha que criptografa o certificado do cliente KMIP .
kmipClientCertPath	string	O caminho para o diretório no host do Backup Daemon que armazena o certificado do cliente KMIP .
links	array de objetos	Um ou mais links para sub-recursos e/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.
filtro de etiqueta	array de strings	Uma array de tags que limita quais Backup Daemons e armazenamentos de snapshots podem processar tarefas de backup para esse projeto.
oplogStoreFilter	Array de objetos	Uma array de identificadores únicos representando armazenamentos deoplog que podem ser usados com as tarefas de backup deste projeto.
oplogStoreFilter.id	string	Identificador único que representa um armazenamento de oplog que pode ser usado com as tarefas de backup deste projeto.
oplogStoreFilter.type	string	Tipo de armazenamento de oplog a ser usado. Esse valor é sempre `oplogStore`.
snapshotStoreFilter	Array de objetos	Array de identificadores únicos representando armazenamentos de snapshots específicos e seus tipos que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de snapshots disponíveis serão usados.
snapshotStoreFilter.id	string	O identificador exclusivo que representa armazenamentos de snapshots específicos que podem ser usados com as tarefas de backup deste projeto.
snapshotStoreFilter.type	string	O tipo do armazenamento de snapshots específico fornecido como `snapshotStoreFilter.id`. Os valores aceitos para esta opção são: `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	array de strings	Uma array de filtros de armazenamento de sincronização que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de sincronização disponíveis serão usados.

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/groups/{PROJECT-ID}?pretty=true' \
 --data '{
  "daemonFilter" : [ {
     "headRootDirectory" : "/data/backup",
     "machine" : "http://backup.example.com"
   } ],
   "id" : "{PROJECT-ID}",
   "kmipClientCertPassword" : "P4$$w0rD",
   "kmipClientCertPath" : "/certs/kmip",
   "labelFilter" : [ "label1", "label2" ],
   "oplogStoreFilter" : [ {
     "id" : "oplog1",
     "type" : "oplogStore"
   } ],
   "snapshotStoreFilter" : [ {
     "id" : "sPid",
     "type" : "s3blockstore"
   } ],
   "syncStoreFilter" : [ "s1", "s2" ]
 }'

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

{
  "daemonFilter" : [ {
    "headRootDirectory" : "/data/backup",
    "machine" : "http://backup.example.com"
  } ],
  "id" : "{PROJECT-ID}",
  "kmipClientCertPassword" : "P4$$w0rD",
  "kmipClientCertPath" : "/certs/kmip",
  "labelFilter" : [ "label1", "label2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",
    "rel" : "self"
  }, {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",
    "rel" : "http://mms.mongodb.com/group"
  } ],
  "oplogStoreFilter" : [ {
    "id" : "oplog1",
    "type" : "oplogStore"
  } ],
  "snapshotStoreFilter" : [ {
    "id" : "sPid",
    "type" : "s3blockstore"
  } ],
  "syncStoreFilter" : [ "s1", "s2" ]
}

Voltar

Obter todos

Backup chave de criptografia