Obtenha um snapshot para um servidor de configuração
Nesta página
Importante
Descontinuado ao usar MongoDB 3.4
A partir do MongoDB 3.4, sistemas de servidor de configuração espelhados (também conhecidas como SCCC) não são mais suportados. O método de API a seguir funciona somente com servidores de configuração do SCCC . Os servidores de configuração do conjunto de réplicas (também conhecidos como CSRS) usam o método Obter um snapshot para um cluster . Para saber como converter seus servidores de configuração de SCCC para um CSRS, consulte Atualizar servidores de configuração para conjunto de réplicas no Manual do servidor MongoDB.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Recurso
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}
Parâmetros da solicitação
Parâmetros do caminho da solicitação
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 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:
| false |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Nome | Tipo | Descrição |
|---|---|---|
clusterId | ID do cluster que o snapshot representa. | |
completo | booleano | Indicador de que o snapshot foi criado. Isto é false se o trabalho de criação de snapshot ainda estiver em andamento. |
Criado | documento | Os componentes de um carimbo de data/hora. |
created.date | timestamp | O ponto exato no tempo em que o snapshot foi tirado em ISO 8601 formato de data e hora em UTC. |
created.increment | inteiro | A ordem de operação em que esse snapshot ocorreu neste ponto exato no tempo. Para saber como os carimbos de data/hora funcionam no MongoDB, consulte Carimbos de data/hora. |
doNotDelete | booleano | Indicador de que o snapshot não pode ser excluído. Se |
expira | timestamp | |
groupId | ObjectId | |
id | ObjectId | ID do snapshot. |
lastOplogAppliedTimestamp | documento | Os componentes do carimbo de data/hora da última entrada do oplog foram aplicados. |
lastOplogAppliedTimestamp.date | timestamp | |
lastOplogAppliedTimestamp.increment | inteiro | A ordem da operação em que o último oplog foi aplicado neste ponto exato no tempo. Para saber como os carimbos de data/hora funcionam no MongoDB, consulte Carimbos de data/hora. |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
namespaceFilterList | array de objetos | Os namespaces incluídos ou excluídos desse snapshot. |
namespaceFilterList.filterList | array de strings | Uma lista separada por vírgulas de qualquer combinação de bancos de dados ou namespaces que sejam incluídos exclusivamente ou explicitamente excluídos do snapshot. O valor padrão é uma array vazia ( |
namespaceFilterList.filterType | string | Um valor que determina como os namespaces são filtrados para esse snapshot.
O valor padrão é |
peças | array de objetos | As partes individuais que compõem o snapshot completo. Esta array contém um único documento. |
part.dataSizeBytes | número | O tamanho total dos dados no snapshot em bytes. |
part.encryptionEnabled | booleano | Indicador do estado de criptografia dos dados de captura instantânea . |
part.fileSizeBytes | número | O tamanho total dos arquivos de dados em bytes. |
part.hostId | string | ID de um servidor de configuração. |
part.MasterKeyUUID | ObjectId | O ID da chave mestra KMIP usada para criptografar os dados do snapshot. parts.masterKeyUUID aparece somente se esse snapshot tiver parts.encryptionEnabled : true. |
part.mongodVersion | string | A versão do mongod que estava em execução quando o snapshot foi criado. |
part.storageSizeBytes | número | O tamanho total do espaço alocado para o armazenamento de documentos. |
part.typeName | string | O tipo de servidor que a parte representa:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true"
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
{ "CLUSTER-ID" : "{CLUSTER-ID}", "complete" : true, "created" : { "date" : "2016-08-21T23:47:38Z", "increment" : 1 }, "doNotDelete" : false, "expires" : "2017-08-20T23:47:38Z", "GROUP-ID" : "{PROJECT-ID}", "HOST-ID" : "{HOST-ID}", "id" : "{SNAPSHOT-ID}", "lastOplogAppliedTimestamp" : { "date" : "2017-08-21T09:14:51Z", "increment" : 1 }, "links" : [ { "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "self" } ], "namespaceFilterList" : { "filterList" : [ ], "filterType" : "blacklist" }, "parts" : [ { "dataSizeBytes" : 503779557, "encryptionEnabled" : false, "fileSizeBytes" : 2855605344, "HOST-ID" : "{HOST-ID}", "mongodVersion" : "4.0.9", "storageSizeBytes" : 547516416, "typeName" : "REPLICA_SET" } ] }