Obtenha todos os snapshots de um cluster

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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

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

Resource

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	Identificador exclusivo do projeto que possui o snapshot.
ID DE CLUSTER	string	Identificador exclusivo do cluster que o snapshot representa.

Solicitar parâmetros de query

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	Sinalizador que indica 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 do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. 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`

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

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.

`results` documento incorporado

Cada resultado é um armazenamento de sincronização.

`Name`	Tipo	Descrição
`clusterId`	string	Identificador exclusivo do cluster que o snapshot representa.
`complete`	booleano	Sinalizador que indica que o snapshot foi criado. Isto é `false` se o trabalho de criação de snapshot ainda estiver em andamento.
`created`	documento	Componentes de um carimbo de data/hora.
`created` `.date`	timestamp	iso8601-hora em que o snapshot foi tirado.
`created` `.increment`	inteiro	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	Sinalizador que indica que o snapshot não pode ser excluído.
`expires`	timestamp	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC em UTC após o qual esse 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á ser editado.
`groupId`	string	Identificador exclusivo do projeto que possui o snapshot.
`id`	string	Identificador exclusivo do snapshot.
`isPossibly` `Inconsistent`	booleano	Sinalizador que indica a consistência desse snapshot. `isPossiblyInconsistent` aparece somente para snapshots de cluster fragmentado . Para tirar um snapshot de um cluster fragmentado em um estado consistente, o Backup desativa temporariamente o balancer antes de criar o snapshot. Em alguns casos, não é possível desligar o balanceador em tempo hábil. O snapshot é então criado com o balancer ainda em execução. Se isso acontecer, o snapshot pode estar em um estado inconsistente (por exemplo, migrações de partes podem estar em andamento).
`lastOplog` `AppliedTimestamp`	documento	Os componentes do carimbo de data/hora da última entrada do oplog foram aplicados.
`lastOplog` `AppliedTimestamp` `.date`	timestamp	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC em UTC quando o último oplog foi aplicado.
`lastOplog` `AppliedTimestamp` `.increment`	inteiro	Ordem de 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`	objeto	namespaces que estão incluídos ou excluídos deste snapshot.
`namespaceFilterList` `.filterList`	array de strings	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	Rótulo 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`.
`missingShards`	Array de objetos	Lista de fragmentos que o snapshot está faltando. `missingShards` aparece somente para snapshots de cluster fragmentado . Em estado constante, esta array está vazia. Se o Backup não puder se conectar a um fragmento quando um instantâneo for criado, o fragmento será omitido do instantâneo. Cada documento na array é um documento de cluster contendo um link `self` .
`missingShards` `.id`	string	Identificador exclusivo do fragmento ausente.
`missingShards` `.groupId`	string	Identificador exclusivo do projeto que possui o shard ausente.
`missingShards` `.typeName`	string	Tipo de servidor que o shard ausente representa: `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET`
`missingShards` `.clusterName`	string	Nome do cluster para o shard ausente.
`missingShards` `.shardName`	string	Nome do shard ausente.
`missingShards` `.replicaSetName`	string	Nome da réplica definida no fragmento ausente.
`missingShards` `.lastHeartbeat`	timestamp	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC em UTC quando a última pulsação foi recebida do fragmento ausente.
`parts`	Array de objetos	Partes individuais que compõem o snapshot completo. Para um conjunto de réplicas, essa array contém um único documento. Para um cluster fragmentado, essa array contém um documento para cada fragmento e um documento para o servidor de configuração.
`parts` `.clusterId`	string	Identificador único do conjunto de réplicas.
`parts` `.compressionSetting`	string	Método de compressão para o snapshot.
`parts` `.dataSizeBytes`	número	Tamanho total dos dados no snapshot em bytes.
`parts` `.encryptionEnabled`	booleano	Indicador do estado de criptografia dos dados de captura instantânea .
`parts` `.fileSizeBytes`	número	Tamanho total dos arquivos de dados em bytes.
`parts` `.masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . `parts.masterKeyUUID` aparece somente se esse snapshot tiver `parts.encryptionEnabled : true`.
`parts` `.mongodVersion`	string	Versão do `mongod` que o conjunto de réplicas principal estava executando quando o snapshot foi criado.
`parts` `.replicaSetName`	string	Nome do conjunto de réplicas.
`parts` `.storageSizeBytes`	número	Tamanho total do espaço alocado para armazenamento de documentos.
`parts` `.typeName`	string	Tipo de servidor que a parte representa: `REPLICA_SET` `CONFIG_SERVER_REPLICA_SET`

Exemplo de solicitação

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}/clusters/{CLUSTER-ID}/snapshots?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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

Snapshots

Obter um (cluster)