Obter todas as configurações do S3 blockstore
Nesta página
Recupera as configurações de todos os blockstores s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /snapshot/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. |
|
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato. |
|
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 Para endpoints que retornam uma lista de resultados, o objeto |
|
assignableOnly | booleano | Sinalizador que indica se esse blockstore S3 pode receber novas tarefas de backup. |
|
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 |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| 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. |
| 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 blockstore S3.
Nome | Tipo | Descrição | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | booleano | Sinalizador que indica se você aceitou ou não os termos de serviço para usar armazenamento compatível com o S3 com o Ops Manager. Você deve definir isso como | |||||||||
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 o HTTP proxy deve ser usado ao se conectar ao armazenamento compatível com S3. | |||||||||
Credenciais criptografadas | booleano | Sinalizador que indica se o nome de usuário e a senha desse blockstore de armazenamento compatível com S3 foram criptografados usando a ferramenta de credenciais. | |||||||||
id | string | Nome que identifica exclusivamente este blockstore de armazenamento compatível com S3. | |||||||||
rótulos | array de strings | Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais blockstores S3. | |||||||||
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays | |||||||||
Fator de carga | inteiro | Inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots executa em comparação com outro armazenamento de snapshots. Esta opção é necessária somente se mais de um armazenamento de snapshots estiver em uso. Para saber mais sobre Load Factor, consulte Editar um blockstore existente. | |||||||||
pathStyleAccessEnabled | booleano | Sinalizador que indica o estilo deste endpoint.
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 | |||||||||
s3AuthMethod | string | Método utilizado para autorizar o acesso ao contêiner de armazenamento compatível com S3s especificado no Os valores aceitos para esta opção são:
| |||||||||
s3BucketEndpoint | string | URL que o Ops Manager usa para acessar esse bucket de armazenamento compatível com S3. | |||||||||
Nome do bucket do S3 | string | Nome do bucket de armazenamento compatível com o S3 que hospeda o blockstore de armazenamento compatível com o S3. | |||||||||
Conexões máx. S3 | inteiro | Inteiro positivo que indica o número máximo de conexões a este blockstore 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 s3BucketEndpoint do seu armazenamento de armazenamento compatível com S3 não suportar o escopo de região. O Ops Manager retorna esse campo somente se você o incluiu ao criar ou atualizar esse blockstore de armazenamento compatível com o S3. | |||||||||
sseEnabled | booleano | Sinalizador que indica se este3blockstore de armazenamento compatível com S habilita a criptografia do lado do servidor. | |||||||||
ssl | booleano | Sinalizador que indica se este blockstore de armazenamento compatível com S3 aceita apenas conexões criptografadas usando TLS. | |||||||||
uri | string | Connection string que se conecta ao banco de dados de metadados desse blockstore de armazenamento compatível com S3. Esse banco de dados armazena as localizações dos blocos no bucket de armazenamento compatível com o Amazon Web Services S3 . | |||||||||
writeConcern | string | Write concern usada para este blockstore. O Ops Manager retorna um dos seguintes valores:
Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern. |
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/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/snapshot/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/snapshot/s3Configs/{S3-BLOCKSTORE-ID}", "rel": "self" } ], "loadFactor": 50, "s3BucketEndpoint": "http://example.com/backupbucket", "s3BucketName": "buck1", "uri": "mongodb://localhost:27017", "ssl": true, "writeConcern": "W2" } ], "totalCount" : 1 }