Criar uma configuração do blockstore
Nesta página
Configura um novo blockstore.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/mongoConfigs
Parâ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 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 | Descrição |
|---|---|---|
assignEnabled | booleano | Opcional. Sinalizador que indica se esse blockstore pode receber tarefas de backup. |
Credenciais criptografadas | booleano | Opcional. Sinalizador que indica se o nome de usuário e a senha desse blockstore foram criptografados usando a ferramenta de credenciais . |
id | string | O nome exclusivo que rotula este blockstore. |
rótulos | array de strings | Opcional. Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais blockstores. A definição dessas tags limita quais tarefas de backup esse blockstore pode processar. Se omitido, este blockstore só poderá processar tarefas de backup para projetos que não usem rótulos para filtrar suas tarefas. |
Fator de carga | número | Opcional. Um número inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar 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. |
maxCapacityGB | número | Opcional. A quantidade máxima de dados em GB que este blockstore pode armazenar. |
uri | string | Uma lista separada por vírgula de hosts no formato <hostname:port> que pode ser utilizado para acessar este blockstore. |
ssl | booleano | Opcional. Sinalizador que indica se este blockstore aceita apenas conexões criptografadas usando TLS. |
writeConcern | string | Opcional. O write concern usado para este blockstore. Os valores aceitos para esta opção são:
Para saber mais sobre os níveis de reconhecimento de escrita no MongoDB, consulte Write Concern. |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
assignEnabled | booleano | Sinalizador que indica se esse blockstore pode receber tarefas de backup. |
Credenciais criptografadas | booleano | Sinalizador que indica se o nome de usuário e a senha desse blockstore foram criptografados usando a ferramenta de credenciais. |
id | string | O nome exclusivo que rotula este blockstore. |
rótulos | array de strings | Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais blockstores. |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
Fator de carga | número | Um número inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar 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. |
maxCapacityGB | número | A quantidade máxima de dados em GB que este blockstore pode armazenar. |
uri | string | Uma lista separada por vírgula de hosts no formato <hostname:port> que pode ser utilizado para acessar este blockstore. |
ssl | booleano | Sinalizador que indica se este blockstore aceita apenas conexões criptografadas usando TLS. |
usadoSize | número | A quantidade de capacidade de backup em MB que os backups existentes consomem. |
writeConcern | string | O write concern usado para este blockstore. Os valores aceitos para esta opção são:
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 POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "encryptedCredentials" : false, 9 "id" : "{BLOCKSTORE-CONFIG-ID}", 10 "labels" : [ "l1", "l2" ], 11 "loadFactor" : 2, 12 "maxCapacityGB" : 8, 13 "uri" : "mongodb://localhost:27017", 14 "ssl" : true, 15 "writeConcern" : "W2" 16 }'
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 "assignmentEnabled" : true, 3 "encryptedCredentials" : false, 4 "id" : "{BLOCKSTORE-CONFIG-ID}", 5 "labels" : [ "l1", "l2" ], 6 "links" : [ { 7 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs", 8 "rel" : "self" 9 }], 10 "loadFactor" : 2, 11 "maxCapacityGB" : 8, 12 "uri" : "mongodb://localhost:27017", 13 "ssl" : true, 14 "usedSize" : 222, 15 "writeConcern" : "W2" 16 }