Pontos de verificação
- 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 autenticação OAuth 2.0 , crie umaconta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID}
é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Este recurso permite que você visualize os metadados do checkpoint . Você pode usar checkpoint para criar snapshot personalizado de um cluster em ponto no tempo entre snapshots regulares.
Importante
Você pode utilizar pontos de verificação para clusters que executam MongoDB com Feature Compatibility Version
de 4.0 ou anterior. Os pontos de controle foram removidos das instâncias do MongoDB com FCV 4.2 ou posterior.
Endpoints
Obter todos os checkpoint
Obter todos os checkpoint de um cluster.
GET /groups/{PROJECT-ID}/clusters/CLUSTER-ID/checkpoints
Obter um checkpoint
Obtenha um único checkpoint.
GET /groups/{PROJECT-ID}/clusters/CLUSTER-ID/checkpoints/CHECKPOINT-ID
Entidade de amostra
1 { 2 "clusterId" : "{CLUSTER-ID}", 3 "completed" : "2015-07-31T23:19:51Z", 4 "groupId" : "{GROUP-ID}", 5 "id" : "{CHECKPOINT-ID}", 6 "parts" : [ { 7 "replicaSetName" : "shard_1", 8 "shardName" : "shard_1", 9 "tokenDiscovered" : true, 10 "tokenTimestamp" : { 11 "date" : "2015-07-31T23:19:51Z", 12 "increment" : 1 13 }, 14 "typeName" : "REPLICA_SET" 15 }, { 16 "replicaSetName" : "shard_0", 17 "shardName" : "shard_0", 18 "tokenDiscovered" : true, 19 "tokenTimestamp" : { 20 "date" : "2015-07-31T23:19:51Z", 21 "increment" : 1 22 }, 23 "typeName" : "REPLICA_SET" 24 }, { 25 "hostId" : "{HOST-ID}", 26 "tokenDiscovered" : true, 27 "tokenTimestamp" : { 28 "date" : "2015-07-31T23:19:51Z", 29 "increment" : 6 30 }, 31 "typeName" : "CONFIG_SERVER" 32 } ], 33 "restorable" : true, 34 "started" : "2015-07-31T23:19:51Z", 35 "timestamp" : "2015-07-31T23:19:47Z" 36 }
Campos da entidade
Nome | Tipo | Descrição |
---|---|---|
clusterId | string | Identificador único do cluster representado pelo checkpoint. |
completed | string | Carimbo de data/hora em ISO 8601 formato de data e hora em UTC para o point-in-time em que o checkpoint foi concluído e o balancer reiniciado. |
groupId | string | Identificador único do grupo proprietário do checkpoint. |
id | string | Identificador único do checkpoint. |
parts | Array de objetos | Partes individuais que compõem o checkpoint completo. haverá um elemento para cada fragmento e um elemento para os servidores de configuração. |
parts .replicaSetName | string | Nome do conjunto de réplicas. Não presente para um servidor de configuração. |
parts .shardName | string | Nome do fragmento. |
parts .tokenDiscovered | Boolean | Sinalizador que indica se o token existe. |
parts .tokenTimestamp | objeto | Carimbo de data/hora de uma entrada no oplog, conforme especificado pelo campo ts da entrada. O campo ts é um carimbo de data/hora BSON e tem dois componentes: o carimbo de data/hora, que é o valor em segundos desde a Unix epoch, e o incremento, que é um ordinal incrementado para operações dentro de um determinado segundo. |
parts .typeName | string | Tipo de servidor representado pela parte. Os valores possíveis são:
|
restorable | Boolean | Sinalizador que indica se o checkpoint pode ser usado para uma restauração. |
started | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o ponto no tempo em que o Cloud Manager interrompeu o balancer e iniciou o ponto de verificação. |
timestamp | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o ponto no tempo para o qual o ponto de verificação restaura os dados. |
links
Relação | Descrição |
---|---|
self | checkpoint |
http://mms.mongodb.com/cluster | Cluster ao qual o checkpoint pertence. |
http://mms.mongodb.com/group | projeto que possui o checkpoint. |
Exemplos
Obter todos os checkpoint
Solicitar
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-ID}/checkpoints"
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
1 { 2 "links" : [], 3 "results" : [ { 4 "clusterId" : "{CLUSTER-ID}", 5 "completed" : "2015-07-31T23:35:52Z", 6 "groupId" : "{GROUP-ID}", 7 "id" : "55bc0658e4b097a3efe06f1f", 8 "links" : [], 9 "parts" : [ { 10 "replicaSetName" : "shard_1", 11 "shardName" : "shard_1", 12 "tokenDiscovered" : true, 13 "tokenTimestamp" : { 14 "date" : "2015-07-31T23:35:52Z", 15 "increment" : 1 16 }, 17 "typeName" : "REPLICA_SET" 18 }, { 19 "replicaSetName" : "shard_0", 20 "shardName" : "shard_0", 21 "tokenDiscovered" : true, 22 "tokenTimestamp" : { 23 "date" : "2015-07-31T23:35:52Z", 24 "increment" : 1 25 }, 26 "typeName" : "REPLICA_SET" 27 }, { 28 "hostId" : "{HOST-ID}", 29 "tokenDiscovered" : true, 30 "tokenTimestamp" : { 31 "date" : "2015-07-31T23:35:52Z", 32 "increment" : 2 33 }, 34 "typeName" : "CONFIG_SERVER" 35 } ], 36 "restorable" : true, 37 "started" : "2015-07-31T23:35:52Z", 38 "timestamp" : "2015-07-31T23:34:47Z" 39 }, 40 ... 41 ], 42 "totalCount" : 6 43 }
Obter um checkpoint
Solicitar
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-ID}/checkpoints/{CHECKPOINT-ID}"
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
1 { 2 "clusterId" : "{CLUSTER-ID}", 3 "completed" : "2015-07-31T23:19:51Z", 4 "groupId" : "{GROUP-ID}", 5 "id" : "{CHECKPOINT-ID}", 6 "links" : [], 7 "parts" : [ { 8 "replicaSetName" : "shard_1", 9 "shardName" : "shard_1", 10 "tokenDiscovered" : true, 11 "tokenTimestamp" : { 12 "date" : "2015-07-31T23:19:51Z", 13 "increment" : 1 14 }, 15 "typeName" : "REPLICA_SET" 16 }, { 17 "replicaSetName" : "shard_0", 18 "shardName" : "shard_0", 19 "tokenDiscovered" : true, 20 "tokenTimestamp" : { 21 "date" : "2015-07-31T23:19:51Z", 22 "increment" : 1 23 }, 24 "typeName" : "REPLICA_SET" 25 }, { 26 "hostId" : "{HOST-ID}", 27 "tokenDiscovered" : true, 28 "tokenTimestamp" : { 29 "date" : "2015-07-31T23:19:51Z", 30 "increment" : 6 31 }, 32 "typeName" : "CONFIG_SERVER" 33 } ], 34 "restorable" : true, 35 "started" : "2015-07-31T23:19:51Z", 36 "timestamp" : "2015-07-31T23:19:47Z" 37 }