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

Obter todas as configurações do S3 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 todos os armazenamentos de oplog do s3 .

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

GET /oplog/s3Configs

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 results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false
backupJobsEnabledOnly
booleano
Opcional
Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.
true
assignableOnly
booleano
Sinalizador que indica se esse armazenamento de oplog S3 pode ser atribuído a 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 Documento incorporadoresults .
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 é o armazenamento de oplog3 de um s.

Nome
Tipo
Descrição
acceptTos
booleano
Sinalizador que indica se você aceitou ou não os termos de serviço para usar armazenamentos compatíveis com armazenamento compatível com S3com o MongoDB Ops Manager. Você deve definir isso como true para criar um armazenamento compatível com armazenamento compatível com S3 .
assignEnabled
booleano
Sinalizador que indica se você pode atribuir tarefas de backup a esse armazenamento de dados.
Chave de acesso AWS
string
ID da chave de acesso da Amazon Web Services que pode acessar o bucket de armazenamento compatível com o S3 especificado em s3BucketName.
Chave secreta AWS
string
Chave de acesso secreto da Amazon Web Services que pode acessar o bucket de armazenamento compatível com o S3 especificado em s3BucketName.
customCertificates
array
Lista de certificados de autoridade de certificação válidos que se aplicam ao bucket de armazenamento associado compatível com S3.
customCertificates[n].filename
string
Nome que identifica o arquivo PEM da Autoridade de certificação.
customCertificates[n].certString
string
Conteúdo do arquivo PEM da autoridade de certificação que compõem sua cadeia de autoridade de certificação.
disableProxyS3
booleano
Sinalizador que indica se oHTTP proxy deve ser usado ao conectar-se ao armazenamento compatível com S3.
Credenciais criptografadas
booleano
Sinalizador que indica se o nome de usuário e a senha deste armazenamento de oplog de armazenamento compatível com S3foram criptografados usando a ferramenta de credenciais.
id
string
Nome que identifica exclusivamente este armazenamento de oplog de armazenamento compatível com S3 .
rótulos
array de strings
Array de marcações para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos de oplog compatíveis com S3.
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.

pathStyleAccessEnabled
booleano

Sinalizador que indica o estilo deste endpoint.

Valor
S3 estilo de endpoint da loja oplog
Exemplo
true
Endpoint de URL no estilo de caminho
s3.amazonaws.com/<bucket>
false
Endpoint de URL no estilo de host virtual
<bucket>.s3.amazonaws.com

Para revisar as convenções3de URL do contêiner de armazenamento compatível com S , consulte a documentação do Amazon Web Services S .3

s3BucketEndpoint
string
URL que o MongoDB Ops Manager usa para acessar esse Amazon Web Services S3-compatible storage ou S3-compatible storage compatível com o bucket.
Nome do bucket do S3
string
Nome do bucket de armazenamento compatível com S3que hospeda o armazenamento de oplog de armazenamento compatível com S3 .
s3RegionOverride
string

Região onde reside seu contêiner de armazenamento compatível com S3 . Esse campo se aplica somente se o BucketEndpoint3 3do seu armazenamento compatível com armazenamento não for compatível com o escopo de região.

MongoDB Ops Manager retorna esse campo somente se você o tiver incluído ao criar ou atualizar esse armazenamento de oplog de armazenamento compatível com S3.

sseEnabled
booleano
Sinalizador que indica se este armazenamento3de oplog de armazenamento compatível com S habilita a criptografia do lado do servidor.
ssl
booleano
Sinalizador que indica se este armazenamento de oplog de armazenamento compatível com S3só aceita conexões criptografadas usando TLS.
uri
string
Connection string que se conecta ao banco de banco de dados de metadados desse armazenamento de oplog de armazenamento compatível com S3. Este banco de dados de dados armazena as localizações dos blocos no bucket de armazenamento compatível com o Amazon Web Services S3.
writeConcern
string

Write concern usado para este armazenamento de oplog.

O Ops Manager retorna um dos seguintes valores:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern.

curl --user '{USERNAME}:{APIKEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?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/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"assignmentEnabled": true,
"awsAccessKey": "access",
"awsSecretKey": "secret",
"encryptedCredentials": false,
"id": "id",
"labels": [
"l1",
"l2"
],
"links": [
{
"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-ID}",
"rel": "self"
}
],
"s3BucketEndpoint": "http://backup.example.com/oplog",
"s3BucketName": "oplog",
"uri": "mongodb://localhost:27017",
"ssl": true,
"writeConcern": "W2"
} ],
"totalCount" : 1
}

Voltar

Obter uma configuração do oplog S3 por ID