Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/ / / /

Obtenha todos os snapshots para um servidor de configuração

Nesta página

  • Resource
  • Parâmetros da solicitação
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta

Importante

Descontinuado ao usar MongoDB 3.4

A partir do MongoDB 3.4, sistemas de servidor de configuração espelhada (também conhecidas como SCCC) não são mais suportadas. 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 Get All Snapshots for One 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 MongoDB Server .

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots
Nome
Tipo
Descrição

ID do projeto

string

Identificador exclusivo do projeto que possui o snapshot.

ID DE HOST

string

Identificador exclusivo do host que o snapshot representa.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pageNum

número

Opcional

Um inteiro baseado que retorna uma subseção de resultados.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

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, configure envelope : true na query.

Para endpoints que retornam uma lista de resultados, o objeto content é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

false

backupJobsEnabledOnly

booleano

Opcional

Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.

true

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

links

array

A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

Cada resultado é um snapshot.

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 doNotDelete estiver definido para true, qualquer valor em expires será ignorado.

expira

timestamp

A data em ISO 8601 formato de data e hora em UTC após o qual este snapshot pode ser excluído.

Se doNotDelete estiver definido para true, qualquer valor em expires será removido.

Se o valor expires for anterior à data e hora atuais, ele não poderá mais ser editado.

groupId

ObjectId

ID do projeto que possui o snapshot.

id

ObjectId

ID do snapshot.

lastOplogAppliedTimestamp

documento

Os componentes do carimbo de data/hora da última entrada do oplog foram aplicados.

lastOplogAppliedTimestamp.date

timestamp

O ponto exato no tempo em que o último oplog foi aplicado na ISO 8601 formato de data e hora em UTC .

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 links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

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.

  • Se esse valor for definido como blacklist, os namespaces em namespaceFilterList.filterList serão excluídos do snapshot.

  • Se esse valor for definido como whitelist, somente os namespaces em namespaceFilterList.filterList serão incluídos no snapshot.

O valor padrão é blacklist.

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:

  • CONFIG_SERVER

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true"
HTTP/1.1 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
HTTP/1.1 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}
{
"links" : [ {
"href" : "https://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"clusterId" : "{CLUSTER-ID}",
"complete" : true,
"created" : {
"date" : "2016-08-21T23:47:38Z",
"increment" : 1
},
"doNotDelete" : false,
"expires" : "2017-08-20T23:47:38Z",
"groupId" : "{PROJECT-ID}",
"id" : "{SNAPSHOT-ID}",
"lastOplogAppliedTimestamp" : {
"date" : "2017-08-21T09:14:51Z",
"increment" : 1
},
"links" : [ {
"href" : "https://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}",
"rel" : "self"
} ],
"namespaceFilterList" : {
"filterList" : [ ],
"filterType" : "blacklist"
},
"parts" : [ {
"clusterId" : "{CLUSTER-ID}",
"compressionSetting" : "GZIP",
"dataSizeBytes" : 503779557,
"encryptionEnabled" : false,
"fileSizeBytes" : 2855605344,
"mongodVersion" : "4.0.9",
"replicaSetName" : "proton",
"storageSizeBytes" : 547516416,
"typeName" : "REPLICA_SET"
} ]
}, {
} ],
"totalCount" : 28
}

Voltar

Remover um