Alterar a validade de um snapshot
Nesta página
Todas as solicitações para esse endpoint devem ser originadas de um IP endereço na MongoDB Ops Manager API lista de acesso à do usuário do . Para obter a documentação completa sobre a configuração de listas de acesso à API, consulte Exigir uma lista de acesso à API para sua organização.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-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 da 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
Nome | Tipo | Descrição |
---|---|---|
doNotDelete | booleano | Indicador de que o snapshot não pode ser excluído. ImportanteNão é possível definir |
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 Se Se o carimbo de data/hora |
Resposta
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 Se o valor |
groupId | string | |
id | string | Identificador exclusivo do snapshot. |
isPossibly Inconsistent | booleano | Sinalizador que indica a consistência desse snapshot. 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 |
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.
O valor padrão é |
missingShards | Array de objetos | Lista de fragmentos que o snapshot está faltando. 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 |
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:
|
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.
|
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:
|
links
Array
A array links
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
Relação | Descrição |
---|---|
auto | O ponto de conexão da URL desse recurso. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}?pretty=true" \ --data ' { "doNotDelete": 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
{ "id" : "{SNAPSHOT-ID}", "CLUSTER-ID" : "{CLUSTER-ID}", "complete" : true, "created" : { "date" : "2014-07-09T15:24:37Z", "increment" : 1 }, "doNotDelete" : true, "GROUP-ID" : "{PROJECT-ID}", "lastOplogAppliedTimestamp" : { "date" : "2017-08-21T09:14:51Z", "increment" : 1 }, "links" : [ { "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "self" } ], "namespaceFilterList" : { "filterList" : [ ], "filterType" : "blacklist" }, "parts" : [ { "CLUSTER-ID" : "{CLUSTER-ID}", "dataSizeBytes" : 17344, "fileSizeBytes" : 67108864, "mongodVersion" : "2.6.3", "replicaSetName" : "rs0", "storageSizeBytes" : 10502144, "typeName" : "REPLICA_SET" } ], }