Criar uma configuração de armazenamento do sistema de arquivos

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

Configura um novo armazenamento do sistema de arquivos.

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

Resource

POST /snapshot/fileSystemConfigs

Parâmetros do caminho da solicitação

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

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
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Parâmetro do corpo	Tipo	necessidade	Descrição
assignEnabled	booleano	Opcional	Sinalizador que indica se é possível atribuir tarefa de backup a esse armazenamento do sistema de arquivos.
id	string	Obrigatório	Identificador único deste armazenamento do sistema de arquivos.
rótulos	array de strings	Opcional	Marcações para gerenciar quaistarefas de backup do o MongoDB Ops Manager pode atribuir a quais armazenamentos do sistema de arquivos. A definição dessas tags limita as tarefas de backup que esse armazenamento do sistema de arquivos pode processar. Se omitido, esse armazenamento do sistema de arquivos só poderá processar tarefas de backup para projetos que não usem rótulos para filtrar suas tarefas.
Fator de carga	número	Opcional	Inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar em comparação com outro armazenamento de snapshots. Defina esta opção somente se estiver usando mais de uma armazenamento de snapshots. Para saber mais sobre Load Factor, consulte Editar um blockstore existente.
mmapv1CompressionSetting	string	Condicional	Configuração de compactação se você usar o mecanismo de armazenamento MMAPv1 para seus snapshots. MongoDB Ops Manager aceita `NONE` ou `GZIP`. Se o MongoDB executar o FCV 4.2 ou posterior, o MongoDB Atlas ignorará essa configuração. IMPORTANTE: o MongoDB removeu o suporte para o mecanismo de armazenamento MMAPv1 no MongoDB 4.2. Se você editar a configuração do sistema para alterar o mecanismo de armazenamento para o Mecanismo de armazenamentoWiredTiger , o MongoDB Ops Manager reiniciará os processos do MongoDB .
storePath	string	Obrigatório	Local onde os backups baseados em sistema de arquivos são armazenados no host do armazenamento do sistema de arquivos.
wtCompressionSetting	string	Condicional	Configuração de compactação se você usar o storage engine WiredTiger para seus snapshots. MongoDB Ops Manager aceita `NONE` ou `GZIP`. Se o MongoDB executar o FCV 4.2 ou posterior, o MongoDB Atlas ignorará essa configuração.

Resposta

Nome	Tipo	Descrição
assignEnabled	booleano	Sinalizador que indica se é possível atribuir tarefa de backup a esse armazenamento do sistema de arquivos.
id	string	Identificador único deste armazenamento do sistema de arquivos.
rótulos	array de strings	Marcações que gerenciam quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos do sistema de arquivos.
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.
Fator de carga	número	Inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar em comparação com outro armazenamento de snapshots. Defina esta opção somente se estiver usando mais de uma armazenamento de snapshots. Para saber mais sobre Load Factor, consulte Editar um blockstore existente.
mmapv1CompressionSetting	string	Configuração de compactação se você usar o mecanismo de armazenamento MMAPv1 para seus snapshots. Ops Manager pode retornar `NONE` ou `GZIP`. Se o MongoDB executar o FCV 4.2 ou posterior, o MongoDB Ops Manager ignorará essa configuração. IMPORTANTE: o MongoDB removeu o suporte para o mecanismo de armazenamento MMAPv1 no MongoDB 4.2. Se você editar a configuração do sistema para alterar o mecanismo de armazenamento para o Mecanismo de armazenamentoWiredTiger , o MongoDB Ops Manager reiniciará os processos do MongoDB .
storePath	string	Caminho do diretório relativo à raiz do sistema em que os backups baseados no sistema de arquivos são armazenados no host de armazenamento do sistema de arquivos.
wtCompressionSetting	string	Configuração de compactação se você usar o storage engine WiredTiger para seus snapshots. Ops Manager pode retornar `NONE` ou `GZIP`. Se o MongoDB executar o FCV 4.2 ou posterior, o MongoDB Ops Manager ignorará essa configuração.

Exemplo de solicitação

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9        "labels" : [ "l1", "l2" ],
10        "loadFactor" : 50,
11        "mmapv1CompressionSetting" : "NONE",
12        "storePath" : "/data/backup",
13        "wtCompressionSetting" : "GZIP"
14      }'

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

1 {
2   "assignmentEnabled" : true,
3   "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
4   "labels" : [ "l1", "l2" ],
5   "links" : [ {
6     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs",
7     "rel" : "self"
8   }],
9   "loadFactor" : 50,
10   "mmapv1CompressionSetting" : "NONE",
11   "storePath" : "/data/backup",
12   "wtCompressionSetting" : "GZIP"
13 }

Voltar

Obter todas as configurações de armazenamento do sistema de arquivos

Atualizar uma configuração de armazenamento do sistema de arquivos

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9	"labels" : [ "l1", "l2" ],
10	"loadFactor" : 50,
11	"mmapv1CompressionSetting" : "NONE",
12	"storePath" : "/data/backup",
13	"wtCompressionSetting" : "GZIP"
14	}'