Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Criar uma configuração do S3 blockstore

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 que indica se o corpo da resposta está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve envolver a resposta em um envelope.

Alguns clientes de 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:

  • 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 os termos de serviço para usar armazenamentos compatíveis com S3com o MongoDB Ops Manager. Você deve definir isso como true para criar um 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

AWS ID da chave de acesso que pode acessar o bucket de armazenamento compatível com S3especificado em s3BucketName.

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

Chave secreta AWS

string

Condicional

Chave de Acesso Secreto da AWS que pode acessar o bucket de armazenamento compatível com S3especificado em <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

Obrigatório

Ao conectar ao armazenamento compatível com S3, indica se deve usar o HTTP proxy. Você deve incluir este campo em todas as solicitações para criar ou atualizar um blockstore de armazenamento compatível com S3, mesmo que não 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.

objectLockEnabled

booleano

Opcional

Sinalizador que indica se o bloqueio de objeto está ativado para impedir que os objetos em um bucket S3 sejam excluídos.

objectRetentionDays

inteiro

Opcional

Número de dias que o MongoDB Ops Manager protege os objetos deste blockstore de armazenamento compatível com S3com o bloqueio de objeto. Defina este valor para corresponder ao período de retenção padrão configurado no bucket de armazenamento compatível com S3. Ao salvar um armazenamento com assignmentEnabled definido como true, o MongoDB Ops Manager valida o comportamento do Object Lock do bucket usando objetos de teste temporários. No entanto, o MongoDB Ops Manager não lê a configuração do Object Lock do bucket, portanto, não pode detectar uma incompatibilidade entre esse valor e as configurações de retenção do bucket.

objectRetentionMode

string

Opcional

Modo de retenção do bloqueio de objeto que o Ops Manager aplica aos objetos deste blockstore de armazenamento compatível com S3. Defina este valor para corresponder ao modo de retenção configurado no bucket de armazenamento compatível com S3. Ao salvar um armazenamento com assignmentEnabled definido como true, o MongoDB Ops Manager valida o comportamento do Object Lock do bucket usando objetos de teste temporários. No entanto, o MongoDB Ops Manager não lê a configuração do Object Lock do bucket, portanto, não pode detectar uma incompatibilidade entre esse valor e as configurações de retenção do bucket.

O MongoDB Ops Manager aceita os seguintes valores para esta opção:

  • GOVERNANCE

  • COMPLIANCE

OIDC

objeto

Opcional

Opcional. OIDC configurações de autenticação para este armazenar. O objeto oidc aceita os seguintes campos:

  • enabled: booleano. Habilita a autenticação OIDC para este armazenar.

  • method: string. Um de callback, azure, gcp ou k8s.

  • tokenUri: string. O ponto de extremidade de token do provedor de identidade. Obrigatório quando method é callback.

  • clientId: string. O ID do cliente registrado com o provedor de identidade. Obrigatório quando method é callback; opcional quando method é azure.

  • clientSecret: string. O segredo do cliente registrado com o provedor de identidade. Obrigatório quando method está definido como callback. Se você editar um armazenar existente e omitir este campo ou enviar o valor editado retornado por uma solicitação GET anterior, o MongoDB Ops Manager preservará o segredo existente.

  • scope: string. O escopo OAuth2 solicitado do provedor de identidade. Usado apenas quando method é callback.

  • tokenResource: string. O identificador de público ou recurso para o token de identidade de carga de trabalho. Obrigatório quando method for azure ou gcp. Este valor deve corresponder ao audience configurado para este provedor de identidade na configuração oidcIdentityProviders da implantação do MongoDB de destino.

Os métodos callback, azure, gcp e k8s não exigem todos os mesmos campos. Os métodos azure, gcp e k8s não exigem clientSecret.

Quando oidc.enabled é true, forneça apenas hosts e opções de conexão no campo uri do armazenamento. O MongoDB Ops Manager ignora qualquer nome de usuário ou senha incorporado no URI.

Para alternar um repositório de OIDC para outro mecanismo de autenticação, envie oidc: {enabled: false} na solicitação em vez de omitir o objeto oidc.

pathStyleAccessEnabled

booleano

Obrigatório

Sinalizador que indica o estilo deste endpoint.

  • true: ponto de extremidade de URL no estilo de caminho. Por exemplo, s3.amazonaws.com/<bucket>.

  • false: ponto de extremidade de URL no estilo de hospedar virtual. Por exemplo, <bucket>.s3.amazonaws.com.

Para revisar as convenções de URL do bucket de armazenamento compatível com o S3, consulte a documentaçãodo AWS S3.

s3AuthMethod

string

Opcional

Método usado para autorizar o acesso ao bucket de armazenamento compatível com o S3 especificado em s3BucketName.

O MongoDB Ops Manager aceita os seguintes valores para esta opção:

  • KEYS ou Nenhum: O Ops Manager utiliza awsAccessKey e awsSecretKey para autorizar o acesso ao contêiner de armazenamento compatível com S3especificado em s3BucketName.

  • IAM_ROLE: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation

s3BucketEndpoint

string

Obrigatório

URL usada para acessar este contêiner 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 este campo somente se o s3BucketEndpoint do seu armazenamento compatível com S3não oferecer suporte ao escopo de região. Não use este campo com buckets AWS S3.

sseEnabled

booleano

Obrigatório

Sinalizador que indica se este blockstore de armazenamento compatível com S3habilita a criptografia do lado do servidor.

ssl

booleano

Opcional

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

uri

string

Obrigatório

string de conexão que se conecta ao banco de dados de metadados para este blockstore 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.

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 os termos de serviço para usar armazenamento compatível com S3com o MongoDB Ops Manager. Você deve definir isso como true para criar um 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

AWS ID da chave de acesso que pode acessar o bucket de armazenamento compatível com S3especificado em s3BucketName.

Chave secreta AWS

string

Amazon Web Services Chave de Acesso Secreta que pode acessar o bucket de armazenamento compatível com S3especificado 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 utilizado 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 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.

objectLockEnabled

booleano

Sinalizador que indica se o bloqueio de objeto está ativado para impedir que os objetos em um bucket S3 sejam excluídos.

objectLockEnabledAt

timestamp

Data e hora em que o bloqueio de objeto foi habilitado para este blockstore de armazenamento compatível com S3. O MongoDB Ops Manager retorna este campo apenas em resposta a solicitações GET.

objectRetentionDays

inteiro

Número de dias que o Ops Manager protege os objetos deste blockstore de armazenamento compatível com S3com o bloqueio de objeto.

objectRetentionMode

string

Modo de retenção do bloqueio de objeto que o MongoDB Ops Manager aplica aos objetos deste blockstore de armazenamento compatível com S3.

O Ops Manager retorna um dos seguintes valores:

  • GOVERNANCE

  • COMPLIANCE

OIDC

objeto

OIDC configurações de autenticação para este armazenar. O objeto oidc contém os seguintes campos:

  • enabled: booleano. Indica se a autenticação OIDC está habilitada para este armazenar.

  • method: string. Um de callback, azure, gcp ou k8s.

  • tokenUri: string. O ponto de extremidade de token do provedor de identidade. Presente apenas quando method é callback.

  • clientId: string. O ID do cliente registrado com o provedor de identidade.

  • clientSecret: string. O Ops Manager redige esse valor na resposta e não retorna o segredo bruto do cliente.

  • scope: string. O escopo OAuth2 solicitado do provedor de identidade. Apenas quando method for callback.

  • tokenResource: string. O identificador de público ou recurso para o token de identidade da carga de trabalho. Presente apenas quando method é azure ou gcp.

pathStyleAccessEnabled

booleano

Sinalizador que indica o estilo deste endpoint.

  • true: Ponto de extremidade de URL no estilo de caminho. exemplo: s3.amazonaws.com/<bucket>

  • false: ponto de extremidade de URL no estilo de hospedar virtual. exemplo: <bucket>.s3.amazonaws.com

Para revisar as convenções de URL do bucket de armazenamento compatível com o S3, consulte a documentaçãodo AWS S3.

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 None: o MongoDB Ops Manager usa awsAccessKey e awsSecretKey para autorizar o acesso ao bucket de armazenamento compatível com S3especificado em s3BucketName.

  • IAM_ROLE: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation

s3BucketEndpoint

string

URL que o Ops Manager utiliza para acessar este contêiner 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.

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

sseEnabled

booleano

Sinalizador que indica se este blockstore de armazenamento compatível com S3habilita a criptografia do lado do servidor.

ssl

booleano

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

uri

string

string de conexão que se conecta ao banco de dados de metadados para este blockstore 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.

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' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "acceptedTos": true, "customCertificates" : [{ "filename" : "CA.pem", "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-----" }], "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "KEYS", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "acceptedTos": true, "assignmentEnabled": true, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "customCertificates" : [{ "filename" : "CA.pem", "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-----" }], "encryptedCredentials": false, "id": "{S3-BLOCKSTORE-CONFIG-ID}", "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", "rel": "self" } ], "loadFactor": 1, "pathStyleAccessEnabled": false, "s3AuthMethod": "KEYS", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "ssl": false, "uri": "mongodb://127.0.0.1:27017", "writeConcern": "ACKNOWLEDGED"}