Página inicial do Docs → MongoDB Ops Manager
Obter todas as configurações do S3 oplog
Nesta página
Recupera as configurações de todos os armazenamentos de oplog do s3 .
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Recurso
GET /oplog/s3Configs
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 | boleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato. | false |
envelope | boleano | 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 Para endpoints que retornam uma lista de resultados, o objeto | false |
backupJobsEnabledOnly | boleano | 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 | boleano | Sinalizador que indica se esse armazenamento de oplog S3 pode ser atribuído a novas tarefas 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 | variedade | A array inclui um objeto para cada item detalhado na seção Documento incorporado results . |
links | variedade | 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 é o armazenamento de oplog3 de um s.
Nome | Tipo | Descrição | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | boleano | Sinalizador que indica se você aceitou ou não os termos de serviço para usar armazenamentos compatíveis com armazenamento S3compatível com o Ops Manager. Você deve definir isso como true para criar um armazenamento compatível com armazenamento compatível com S3 . | |||||||||
assignEnabled | boleano | 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 | variedade | 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 | boleano | Sinalizador que indica se o HTTP proxy deve ser usado ao se conectar ao armazenamento compatível com S3. | |||||||||
Credenciais criptografadas | boleano | 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 managed quais tarefa de backup o Ops Manager pode atribuir a quais armazenamentos de oplog de armazenamento compatíveis com S3 . | |||||||||
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as | |||||||||
pathStyleAccessEnabled | boleano | Sinalizador que indica o estilo deste endpoint.
Para revisar as convenções3 de URL do bucket de armazenamento compatível com o S , consulte a documentação3 do AWS S . | |||||||||
s3BucketEndpoint | string | URL que o Ops Manager usa para acessar esse AWS S3- armazenamento compatível ou S3- armazenamento compatível com armazenamento compatível. | |||||||||
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. O Ops Manager retorna esse campo somente se você o incluir ao criar ou atualizar o armazenamento de oplog de armazenamento compatível com o S3 . | |||||||||
sseEnabled | boleano | Sinalizador que indica se este armazenamento3de oplog de armazenamento compatível com S habilita a criptografia do lado do servidor. | |||||||||
ssl | boleano | Sinalizador que indica se este armazenamento de oplog de armazenamento compatível com S3só aceita conexões criptografadas usando TLS. | |||||||||
uri | string | Cadeia de conexão que se conecta ao banco de dados de metadados para este armazenamento de oplog de armazenamento compatível com S3 . Este banco de dados armazena as localizações dos blocos no bucket de armazenamento compatível com AWS S3 . | |||||||||
Escreva preocupação | string | Write concern usada para este armazenamento de oplog. O Ops Manager retorna um dos seguintes valores:
DicaVeja também:Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern |
Exemplo de solicitação
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'
Exemplo de resposta
Cabeçalho de resposta
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
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
{ "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 }