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

Criar uma configuração do S3 blockstore

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

Configura um novo blockstore s3.

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

POST /snapshot/s3Configs

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

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

content

Corpo de resposta esperado

false

Nome
Tipo
necessidade
Descrição

acceptTos

booleano

Obrigatório

Sinalizador que indica se você aceitou ou não os termos de serviço para usar armazenamentos de armazenamento compatíveis com o S3 com o Ops Manager. Você deve definir isso como true para criar um armazenamento de armazenamento compatível com S3.

Se você definir isso como false, o Ops Manager retornará um erro. O erro informa que o Ops Manager não pode criar o armazenamento de armazenamento compatível com o S3.

assignEnabled

booleano

Opcional

Sinalizador que indica se você pode atribuir tarefas de backup a esse armazenamento de dados.

Chave de acesso AWS

string

Condicional

ID da chave de acesso da Amazon Web Services que pode acessar o bucket de armazenamento compatível com o S3 especificado em s3BucketName.

Se "s3AuthMethod" : "IAM_ROLE", você não precisa incluir o AWSAccessKey.

Chave secreta AWS

string

Condicional

Chave de acesso secreto Amazon Web Services que pode acessar o bucket de armazenamento compatível com S3s especificado no <s3BucketName>.

Se "s3AuthMethod" : "IAM_ROLE", então você não precisa incluir awsSecretKey.

customCertificates

array

Opcional

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

Opcional

Nome que identifica o arquivo PEM da Autoridade de certificação.

customCertificates[n].certString

string

Opcional

Conteúdo do arquivo PEM da autoridade de certificação que compõem sua cadeia de autoridade de certificação.

disableProxyS3

booleano

Opcional

Sinalizador que indica se oHTTP proxy deve ser usado ao conectar-se ao armazenamento compatível com S3. Você não precisa definir esse valor, a menos que tenha configurado o MongoDB Ops Manager para usar o HTTP proxy.

Credenciais criptografadas

booleano

Opcional

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

Obrigatório

Nome que identifica exclusivamente este S3 Snapshot Store.

rótulos

array de strings

Opcional

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

A definição dessas tags limita quais tarefas de backup esse blockstore de armazenamento compatível com S3 pode processar. Se omitido, esse blockstore compatível com S3 só poderá processar tarefa de backup para projeto que não usam rótulos para filtrar suas tarefa.

Fator de carga

número

Opcional

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

Obrigatório

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

Opcional

Método usado para autorizar o acesso ao bucket de armazenamento compatível com o S3 especificado em 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 S3 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

Obrigatório

URL usada para acessar esse bucket de armazenamento compatível com S3.

Nome do bucket do S3

string

Obrigatório

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

número

Obrigatório

Inteiro positivo que indica o número máximo de conexões a este blockstore de armazenamento compatível com S3.

s3RegionOverride

string

Condicional

Região onde reside seu contêiner de armazenamento compatível com S3.

Use esse campo somente se o s3BucketEndpoint do seu armazenamento de armazenamento compatível com S3 não for compatível com o escopo de região. Não use este campo com Amazon Web Services S3.

sseEnabled

booleano

Obrigatório

Sinalizador que indica se este3blockstore de armazenamento compatível com S habilita a criptografia do lado do servidor.

ssl

booleano

Opcional

Sinalizador que indica se este blockstore de armazenamento compatível com S3 aceita apenas conexões criptografadas usando TLS.

uri

string

Obrigatório

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

Opcional

Write concern usada para este blockstore.

O Ops Manager aceita os seguintes valores:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

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

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 true para criar um armazenamento de 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 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 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 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:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

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

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6 --data '{
7 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8 "assignmentEnabled": true,
9 "pathStyleAccessEnabled": false,
10 "awsAccessKey": "<access>",
11 "awsSecretKey": "<secret>",
12 "acceptedTos": true,
13 "customCertificates" : [{
14 "filename" : "CA.pem",
15 "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
16 }],
17 "encryptedCredentials": false,
18 "loadFactor": 1,
19 "s3AuthMethod": "KEYS",
20 "s3BucketEndpoint": "s3.amazonaws.com",
21 "s3BucketName": "bucketname",
22 "s3MaxConnections": 50,
23 "sseEnabled": true,
24 "uri": "mongodb://127.0.0.1:27017",
25 "ssl": false,
26 "writeConcern": "ACKNOWLEDGED"
27 }'
1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6 --data '{
7 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8 "assignmentEnabled": true,
9 "pathStyleAccessEnabled": false,
10 "acceptedTos": true,
11 "encryptedCredentials": false,
12 "loadFactor": 1,
13 "s3AuthMethod": "IAM_ROLE",
14 "s3BucketEndpoint": "s3.amazonaws.com",
15 "s3BucketName": "bucketname",
16 "s3MaxConnections": 50,
17 "sseEnabled": true,
18 "uri": "mongodb://127.0.0.1:27017",
19 "ssl": false,
20 "writeConcern": "ACKNOWLEDGED"
21 }'
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}
1{
2 "acceptedTos": true,
3 "assignmentEnabled": true,
4 "awsAccessKey": "<access>",
5 "awsSecretKey": "<secret>",
6 "customCertificates" : [{
7 "filename" : "CA.pem",
8 "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----"
9 }],
10 "encryptedCredentials": false,
11 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
12 "links": [
13 {
14 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
15 "rel": "self"
16 }
17 ],
18 "loadFactor": 1,
19 "pathStyleAccessEnabled": false,
20 "s3AuthMethod": "KEYS",
21 "s3BucketEndpoint": "s3.amazonaws.com",
22 "s3BucketName": "bucketname",
23 "s3MaxConnections": 50,
24 "sseEnabled": true,
25 "ssl": false,
26 "uri": "mongodb://127.0.0.1:27017",
27 "writeConcern": "ACKNOWLEDGED"
28}
1{
2 "acceptedTos": true,
3 "assignmentEnabled": true,
4 "encryptedCredentials": false,
5 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
6 "links": [
7 {
8 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
9 "rel": "self"
10 }
11 ],
12 "loadFactor": 1,
13 "pathStyleAccessEnabled": false,
14 "s3AuthMethod": "IAM_ROLE",
15 "s3BucketEndpoint": "s3.amazonaws.com",
16 "s3BucketName": "bucketname",
17 "s3MaxConnections": 50,
18 "sseEnabled": true,
19 "ssl": false,
20 "uri": "mongodb://127.0.0.1:27017",
21 "writeConcern": "ACKNOWLEDGED"
22}

Voltar

Obter todos