Criar uma configuração de armazenamento de sincronização
Nesta página
Configura um novo armazenamento de sincronização.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /sync/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. |
| ||||||
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:
|
|
Parâmetros do corpo da solicitação
Nome | Tipo | Descrição |
|---|---|---|
assignEnabled | booleano | Opcional. Sinalizador que indica se tarefas de backup podem ser atribuídas a esse armazenamento de sincronização. |
Credenciais criptografadas | booleano | Opcional. Sinalizador que indica se o nome de usuário e a senha desse armazenamento de sincronização foram criptografados usando a ferramenta decredenciais . |
id | string | O nome exclusivo que rotula esse armazenamento de sincronização. |
rótulos | array de strings | Opcional. Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos de sincronização. A definição dessas tags limita quais tarefas de backup esse armazenamento de sincronização pode processar. Se omitido, esse armazenamento de sincronização só poderá processar tarefas de backup para projetos que não usam rótulos para filtrar suas tarefas. |
maxCapacityGB | número | Opcional. A quantidade máxima de dados em GB que este armazenamento de sincronização pode armazenar. |
uri | string | Uma lista separada por vírgulas de hosts no formato |
ssl | booleano | Opcional. Sinalizador que indica se este armazenamento de sincronização aceita apenas conexões criptografadas usando TLS. |
writeConcern | string | Opcional. A referência de escrita usada para este armazenamento de sincronização. 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 tarefas de backup podem ser atribuídas a esse armazenamento de sincronização. |
Credenciais criptografadas | booleano | Sinalizador que indica se o nome de usuário e a senha desse armazenamento de sincronização foram criptografados usando a ferramenta de credenciais. |
id | string | O nome exclusivo que rotula esse armazenamento de sincronização. |
rótulos | array de strings | Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos de sincronização. |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
maxCapacityGB | número | A quantidade máxima de dados em GB que este armazenamento de sincronização pode armazenar. |
uri | string | Uma lista separada por vírgulas de hosts no formato |
ssl | booleano | Sinalizador que indica se este armazenamento de sincronização 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 | A referência de escrita usada para este armazenamento de sincronização. 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/sync/mongoConfigs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "encryptedCredentials" : false, 9 "id" : "{SYNCSTORE-CONFIG-ID}", 10 "labels" : [ "l1", "l2" ], 11 "maxCapacityGB" : 8, 12 "uri" : "mongodb://localhost:27017", 13 "ssl" : true, 14 "writeConcern" : "W2" 15 }'
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" : "{SYNCSTORE-CONFIG-ID}", 5 "labels" : [ "l1", "l2" ], 6 "links" : [ { 7 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs", 8 "rel" : "self" 9 }], 10 "maxCapacityGB" : 8, 11 "uri" : "mongodb://localhost:27017", 12 "ssl" : true, 13 "usedSize" : 222, 14 "writeConcern" : "W2" 15 }