Atualizar uma configuração do S3 blockstore
Nesta página
Atualiza a configuração de um blockstore s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
S3-blockstore-CONFIG-ID | string | O nome único que rotula essa configuração do blockstore do S3. |
Solicitar parâmetros de query
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:
| false |
Parâmetros do corpo da solicitação
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 compatíveis com armazenamento compatível 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 | 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 | |||||||||
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 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 | 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. | |||||||||
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.
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. O Ops Manager aceita os seguintes valores:
| |||||||||
s3BucketEndpoint | string | Obrigatório | URL usado para acessar esse bucket de armazenamento compatível com S3 da Amazon Web Services ou bucket compatível com 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 3 do seu armazenamento compatível com armazenamento compatível com3S não suportar o escopo de região. Não use este campo com blocos de armazenamento compatíveis com o 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. | |||||||||
uri | string | Obrigatório | Lista separada por vírgulas de hosts no formato <hostname:port> que podem acessar este blockstore de armazenamento compatível com S3. | |||||||||
ssl | booleano | Opcional | Sinalizador que indica se este blockstore de armazenamento compatível com S3 aceita apenas conexões criptografadas usando TLS. | |||||||||
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 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 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 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:
Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern. |
Exemplo de solicitação
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "awsAccessKey": "<access>", 9 "awsSecretKey": "<secret>", 10 "encryptedCredentials": false, 11 "labels": [ 12 "l1", 13 "l2" 14 ], 15 "loadFactor": 50, 16 "s3BucketEndpoint": "http://example.com/backupbucket", 17 "s3BucketName": "bucketname", 18 "uri": "mongodb://localhost:27017", 19 "ssl": true, 20 "writeConcern": "W2" 21 }'
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "encryptedCredentials": false, 9 "labels": [ 10 "l1", 11 "l2" 12 ], 13 "loadFactor": 50, 14 "s3AuthMethod": "IAM_ROLE", 15 "s3BucketEndpoint": "http://example.com/backupbucket", 16 "s3BucketName": "bucketname", 17 "uri": "mongodb://localhost:27017", 18 "ssl": true, 19 "writeConcern": "W2" 20 }'
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
1 { 2 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "awsAccessKey": "<access>", 5 "awsSecretKey": "<secret>", 6 "encryptedCredentials": false, 7 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 8 "labels": [ 9 "l1", 10 "l2" 11 ], 12 "links": [ 13 { 14 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 15 "rel": "self" 16 } 17 ], 18 "loadFactor": 50, 19 "pathStyleAccessEnabled": false, 20 "s3AuthMethod": "KEYS", 21 "s3BucketEndpoint": "http://example.com/backupbucket", 22 "s3BucketName": "bucketname", 23 "s3MaxConnections": 50, 24 "sseEnabled": true, 25 "ssl": false, 26 "uri": "mongodb://127.0.0.1:27017", 27 "writeConcern": "W2" 28 }
1 { 2 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "encryptedCredentials": false, 5 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 6 "labels": [ 7 "l1", 8 "l2" 9 ], 10 "links": [ 11 { 12 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 13 "rel": "self" 14 } 15 ], 16 "loadFactor": 50, 17 "pathStyleAccessEnabled": false, 18 "s3AuthMethod": "IAM_ROLE", 19 "s3BucketEndpoint": "http://example.com/backupbucket", 20 "s3BucketName": "bucketname", 21 "s3MaxConnections": 50, 22 "sseEnabled": true, 23 "ssl": false, 24 "uri": "mongodb://127.0.0.1:27017", 25 "writeConcern": "W2" 26 }