Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Administração de backup
/
Configurações de armazenamento do sistema de arquivos

Obter uma configuração de armazenamento do sistema de arquivos por ID

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

Recupera a configuração de um armazenamento do sistema de arquivos.

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

Resource

GET /snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}

Parâmetros do caminho da solicitação

parâmetro de caminho
Tipo
necessidade
Descrição
FILE-SYSTEM-CONFIG-ID
string
Obrigatório
Nome exclusivo que rotula essa configuração de armazenamento do sistema de arquivos .

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

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 quaistarefas 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

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}?pretty=true'

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/{FILE-SYSTEM-CONFIG-ID}",
7    "rel" : "self"
8  }],
9  "loadFactor" : 50,
10  "mmapv1CompressionSetting" : "NONE",
11  "storePath" : "/data/backup",
12  "wtCompressionSetting" : "GZIP"
13}

Voltar

Configurações de armazenamento do sistema de arquivos

Próximo

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