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

Obter uma configuração do blockstore S3 por ID

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Recupera a configuração de um blockstore s3.

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

GET /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}
Nome
Tipo
Descrição
S3-blockstore-CONFIG-ID
string
O nome único que rotula essa configuração do blockstore do S3.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
Sinalizador indicando 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 da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
Status
Código de resposta HTTP
envelope
Corpo de resposta esperado
false

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

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 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 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
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.

Valor
Estilo de endpoint do blockstore S3
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

s3AuthMethod
string

Método utilizado para autorizar o acesso ao contêiner de armazenamento compatível com S3s especificado no s3BucketName.

Os valores aceitos para esta opção são: KEYS, IAM_ROLE.

KEYS ou nenhum
O Ops Manager usa awsAccessKey e awsSecretKey para autorizar o acesso ao bucket de armazenamento compatível com o S3s especificado em s3BucketName.
IAM_ROLE
O MongoDB Ops Manager usa uma função do Amazon Web Services IAM para autorizar o acesso ao bucket de armazenamento compatível com o S3especificado em s3BucketName. Os campos awsAccessKey e awsSecretKey são ignorados. Para saber mais,consulte a documentação do Amazon Web Services
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 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 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 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:

  • 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/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?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}
{
"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-CONFIG-ID}",
"rel": "self"
}
],
"loadFactor": 50,
"s3BucketEndpoint": "http://example.com/backupbucket",
"s3BucketName": "buck1",
"uri": "mongodb://localhost:27017",
"ssl": true,
"writeConcern": "W2"
}

Voltar

Configurações do S3 blockstore