Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Obter todas as configurações de Oplog

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 todas as lojas de oplog.

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

GET /oplog/mongoConfigs

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

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

Sinalizador que indica se esse armazenamento de oplog pode receber novas tarefas de backup.

true

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

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.

Cada resultado é um armazenamento de oplog.

Nome
Tipo
Descrição

assignEnabled

booleano

Sinalizador que indica se esse armazenamento de oplog pode receber tarefas de backup.

Credenciais criptografadas

booleano

Sinalizador que indica se o nome de usuário e a senha desse armazenamento de oplog foram criptografados usando a ferramenta de credenciais.

id

string

O nome exclusivo que rotula este armazenamento de oplog.

rótulos

array de strings

Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos deoplog .

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.

maxCapacityGB

número

A quantidade máxima de dados em GB que este armazenamento de oplog pode armazenar.

uri

string

Uma lista separada por vírgula de hosts no formato <hostname:port> que pode ser utilizado para acessar este armazenamento de oplog.

ssl

booleano

Sinalizador que indica se este armazenamento de oplog 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

O write concern usado para esse armazenamento de oplog.

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' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs?pretty=true'
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}
{
"links" : [ {
"href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"assignmentEnabled" : true,
"encryptedCredentials" : false,
"id" : "{CONFIG-ID}",
"labels" : [ "l1", "l2" ],
"links" : [ {
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-ID}",
"rel" : "self"
}],
"maxCapacityGB" : 8,
"uri" : "mongodb://localhost:27017",
"ssl" : true,
"usedSize" : 222,
"writeConcern" : "W2"
} ],
"totalCount" : 1
}

Voltar

Obter por ID