Obter todas as configurações 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
documento de resposta
results documento incorporado
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

Recupera as configurações de todos os armazenamentos do sistema de arquivos.

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

Resource

GET /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

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica 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 do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`

assignableOnly	booleano	Opcional	Sinalizador que indica se esse armazenamento do sistema de arquivos pode receber nova tarefa de backup.	`true`

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção `results` Documento incorporado .
`links`	array	A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
`totalCount`	número	Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

`results` documento incorporado

Cada resultado é um armazenamento de sistema de arquivos.

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

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?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   "links" : [ {
3     "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "assignmentEnabled" : true,
8     "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9     "labels" : [ "l1", "l2" ],
10     "links" : [ {
11       "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}",
12       "rel" : "self"
13     }],
14     "loadFactor" : 50,
15     "mmapv1CompressionSetting" : "NONE",
16     "storePath" : "/data/backup",
17     "wtCompressionSetting" : "GZIP"
18   } ],
19   "totalCount" : 1
20 }

Voltar

Obter por ID

criar

1	{
2	"links" : [ {
3	"href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"assignmentEnabled" : true,
8	"id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9	"labels" : [ "l1", "l2" ],
10	"links" : [ {
11	"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}",
12	"rel" : "self"
13	}],
14	"loadFactor" : 50,
15	"mmapv1CompressionSetting" : "NONE",
16	"storePath" : "/data/backup",
17	"wtCompressionSetting" : "GZIP"
18	} ],
19	"totalCount" : 1
20	}