Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/ /
Snapshots
Página inicial do Docs
/ /
Backup e restauração
/
Snapshots
Página inicial do Docs
/
Gestão
/
Cloud Manager
/
Recursos
/
Backup e restauração
/
Snapshots

Obtenha todos os snapshots de um cluster

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

Unique identifier of the project that owns the 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 formato de impressão bonita.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the 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

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

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

Registro de data/hora no formato de data e hora ISO 8601 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

Unique identifier of the project that owns the 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 .

To take a snapshot of a sharded cluster in a consistent state, the Backup temporarily turns off the balancer before creating the snapshot. In some cases, it cannot turn off the balancer in a timely manner. The snapshot is then created with the balancer still running.

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

Registro de data/hora no formato de data e hora ISO 8601 em UTC a 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 denyList, os namespaces em namespaceFilterList.filterList serão excluídos do snapshot.

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

O valor padrão é denyList.

missingShards

Array de objetos

Lista de fragmentos que o snapshot está faltando. missingShards aparece somente para snapshots de cluster fragmentado .

In steady state, this array is empty. If the Backup cannot connect to a shard when a snapshot is created, the shard is omitted from the snapshot. Each document in the array is a cluster document containing a self link.

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

  • CONFIG_SHARD_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

Registro de data/hora no formato de data e hora ISO 8601 em UTC a UTC quando a última pulsação foi recebida do fragmento ausente.

parts

Array de objetos

Partes individuais que compõem o snapshot completo.

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

KMIP master key ID used to encrypt the snapshot data. parts.masterKeyUUID appears only if this snapshot has parts.encryptionEnabled : true.

parts
.mongodVersion

string

Version of mongod that the replica set primary was running when the snapshot was created.

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

  • CONFIG_SHARD_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" : "denyList"
    },
    "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
Próximo
Obter um (cluster)
Avalie esta página

Nesta página