Configura um novo blockstore s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/s3ConfigsParâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
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. |
|
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:
|
|
Parâmetros do corpo da solicitação
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 Se você definir isso como |
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 |
Chave secreta AWS | string | Condicional | Chave de Acesso Secreto da AWS que pode acessar o bucket de armazenamento compatível com S3especificado em Se |
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 |
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 O MongoDB Ops Manager aceita os seguintes valores para esta opção:
|
OIDC | objeto | Opcional | Opcional. OIDC configurações de autenticação para este armazenar. O objeto
Os métodos Quando Para alternar um repositório de OIDC para outro mecanismo de autenticação, envie |
pathStyleAccessEnabled | booleano | Obrigatório | Sinalizador que indica o estilo deste endpoint.
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:
|
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:
Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern. |
Resposta
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 |
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 |
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 |
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:
|
OIDC | objeto | OIDC configurações de autenticação para este armazenar. O objeto
|
pathStyleAccessEnabled | booleano | Sinalizador que indica o estilo deste endpoint.
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 Os valores aceitos para esta opção são:
|
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:
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' \ --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" }'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, "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'Exemplo de resposta
Cabeçalho de resposta
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-aliveHTTP/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}Corpo de resposta
{ "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"}{ "acceptedTos": true, "assignmentEnabled": true, "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": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "ssl": false, "uri": "mongodb://127.0.0.1:27017", "writeConcern": "ACKNOWLEDGED"}