Atualizar uma configuração do oplog
Nesta página
Atualiza a configuração de um armazenamento de oplog.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /oplog/mongoConfigs/{OPLOG-CONFIG-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
OPLOG-CONFIG-ID | string | O identificador exclusivo que representa esta configuração de oplog . |
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 armazenamento de oplog pode receber tarefas de backup. |
Credenciais criptografadas | booleano | Opcional. Sinalizador que indica se o nome de usuário e a senha desse armazenamento de oplog foram criptografados usando a ferramenta decredenciais . |
rótulos | array de strings | Opcional. Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos deoplog . A definição dessas tags limita quais tarefas de backup esse armazenamento de oplog pode processar. Se omitido, esse armazenamento de oplog 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 oplog pode armazenar. |
uri | string | Uma lista separada por vírgula de hosts no formato <hostname:port> que pode ser utilizado para acessar este armazenamento de oplog. |
ssl | booleano | Opcional. Sinalizador que indica se este armazenamento de oplog aceita apenas conexões criptografadas usando TLS. |
writeConcern | string | Opcional. O write concern usado para esse armazenamento de oplog. 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 armazenamento de oplog pode receber tarefas de backup. |
Credenciais criptografadas | booleano | Sinalizador que indica se o nome de usuário e a senha desse armazenamento de oplog foram criptografados usando a ferramenta de credenciais. |
id | string | O nome exclusivo que rotula este armazenamento de oplog. |
rótulos | array de strings | Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais armazenamentos deoplog . |
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 oplog pode armazenar. |
uri | string | Uma lista separada por vírgula de hosts no formato <hostname:port> que pode ser utilizado para acessar este armazenamento de oplog. |
ssl | booleano | Sinalizador que indica se este armazenamento de oplog 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 esse armazenamento de oplog. 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
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true' \ --data '{ "assignmentEnabled" : true, "encryptedCredentials" : false, "labels" : [ "l1", "l2" ], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "writeConcern" : "W2" }'
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
{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" }