Criar uma tarefa de restauração para um cluster
Nesta página
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
| string | Identificador único do projeto que possui a tarefa. |
| string | Identificador único do cluster que a tarefa representa. |
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. |
| ||||||
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:
|
|
Parâmetros do corpo da solicitação
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
| objeto | Obrigatório | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .expires | string | Condicional | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC após o qual a URL não está mais disponível. Se você definir |
delivery .expirationHours | número | Condicional | Número de horas em que o URL de download é válido após a conclusão do trabalho de restauração. Se você definir |
delivery .maxDownloads | número | Obrigatório | Número de vezes que o URL de download pode ser usado. Deve ser |
delivery .methodName | string | Obrigatório | Significa pelo qual o Ops Manager fornece os dados. Defina como |
| string | Obrigatório | Identificador exclusivo do snapshot a ser restaurado. |
Observação
Condição
Se você definir "delivery.methodName" :
AUTOMATED_RESTORE"
, deverá definir delivery.targetGroupId
e delivery.targetClusterId
.
Crie uma restauração automatizada a partir de um snapshot.
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
| objeto | Obrigatório | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Obrigatório | Significa pelo qual o Ops Manager fornece os dados. Defina como A resposta mostra o IMPORTANTE: a restauração da entrega usando o SCP foi removida no MongoDB Ops Manager 4.0. |
delivery .targetClusterId | string | Obrigatório | Identificador exclusivo do cluster de destino. Use o Se o backup não estiver habilitado no cluster de destino, o endpoint Get All Snapshots retornará uma array |
delivery .targetGroupId | string | Obrigatório | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| string | Obrigatório | Identificador exclusivo do snapshot a ser restaurado. |
Crie uma restauração automatizada a partir de um carimbo de data/hora oplog .
As restaurações de oplog funcionam com conjuntos de réplicas usando qualquer versão do MongoDB ou clusters fragmentados usando FCV de 4.2 ou posterior.
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
| objeto | Obrigatório | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Obrigatório | Significa pelo qual o Ops Manager fornece os dados. Defina como A resposta mostra o IMPORTANTE: a restauração da entrega usando o SCP foi removida no MongoDB Ops Manager 4.0. |
delivery .targetClusterId | string | Obrigatório | Identificador único do cluster de destino. Use o Se o backup não estiver habilitado no cluster de destino, o endpoint Get All Snapshots retornará uma array |
delivery .targetGroupId | string | Obrigatório | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| string | Obrigatório | oplog carimbo de data/hora fornecido como Registro de data/hora no número de segundos decorridos desde a UNIX epoch. Quando emparelhados com Execute uma query em Se você fornecer essa configuração, esse endpoint restaurará todos os dados até e incluindo este carimbo de data/hora oplog no reconhecimento de data center especificado no objeto |
| string | Obrigatório | Ordinal incrementado de 32 bits que representa operações em um determinado segundo. Quando emparelhados com Se você fornecer essa configuração, esse endpoint restaurará todos os dados até e incluindo este carimbo de data/hora oplog no reconhecimento de data center especificado no objeto |
Crie uma restauração automatizada a partir de um ponto específico.
As Restaurações PIT funcionam com Conjuntos de Réplicas usando qualquer versão do MongoDB ou Clusters Fragmentados usando FCV de 4.2 ou posterior.
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
| objeto | Obrigatório | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Obrigatório | Significa pelo qual o Ops Manager fornece os dados. Defina como A resposta mostra o IMPORTANTE: a restauração da entrega usando o SCP foi removida no MongoDB Ops Manager 4.0. |
delivery .targetClusterId | string | Obrigatório | Identificador único do cluster de destino. Use o Se o backup não estiver habilitado no cluster de destino, o endpoint Get All Snapshots retornará uma array |
delivery .targetGroupId | string | Obrigatório | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| long | Obrigatório | carimbo de data/hora no número de milissegundos decorridos desde a UNIX epoch que representa o ponto no tempo para o qual seus dados serão restaurados. Esse carimbo de data/hora deve estar dentro das últimas 24 horas da hora atual. Se você fornecer essa configuração, esse endpoint restaurará todos os dados até esse momento específico no banco de dados especificado no objeto |
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 |
---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| 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. |
| 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 é uma tarefa de restauração de cluster. Esta matriz inclui apenas uma tarefa de restauração.
Nome | Tipo | Descrição | |||
---|---|---|---|---|---|
| string | Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado. | |||
| string | Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado. | |||
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a tarefa de restauração foi solicitada. | |||
| objeto | Método e detalhes de como os dados de snapshot restaurados são entregues. | |||
delivery .authBearer | string | Portador da autorização para solicitações para | |||
delivery .authHeader | string | Cabeçalho de autorização para solicitações para | |||
delivery .authValue | string | Valor para o portador para solicitações para | |||
delivery .expirationHours | número | Número de horas em que o URL de download é válido após a conclusão do trabalho de restauração. | |||
delivery .expires | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC após o qual a URL não está mais disponível. | |||
delivery .maxDownloads | número | Número de vezes que o URL de download pode ser usado. Deve ser | |||
delivery .methodName | string | Significa pelo qual os dados são entregues. Retorna | |||
delivery .statusName | string | Status atual do arquivo para download. Os valores aceitos são:
| |||
delivery .url | string | URL a partir da qual os dados de snapshot restaurados podem ser baixados. | |||
delivery .urlV2 | string | URL a partir da qual os dados de snapshot restaurados podem ser baixados com segurança. As solicitações para essa URL devem incluir
Por exemplo:
| |||
| string | Identificador exclusivo do grupo que possui o trabalho de restauração. | |||
| Array de objetos | Se o | |||
hashes .fileName | string | Nome do arquivo de snapshot que foi criptografado. | |||
hashes .hash | string | Hash do arquivo de snapshot. | |||
hashes .typeName | string | Algoritmo de hash usado para calcular o valor de hash. Se retornado, o valor é definido como | |||
| string | Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC. | |||
| string | Identificador único da tarefa de restauração. | |||
| Array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays | |||
| booleano | Sinalizador que indica se o snapshot era de um ponto no tempo. | |||
| string | Identificador exclusivo do snapshot a ser restaurado. | |||
| string | Status atual da tarefa. Os valores aceitos são:
| |||
| objeto | Carimbo de data/hora da entrada oplog em que o snapshot foi criado. | |||
timestamp .date | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da entrada de oplog mais recente no snapshot restaurado. | |||
timestamp .increment | string | Ordem de todas as operações concluídas na última entrada de oplog no snapshot restaurado. |
Nome | Tipo | Descrição |
---|---|---|
| string | Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado. |
| string | Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado. |
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a tarefa de restauração foi solicitada. |
| objeto | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Significa pelo qual os dados são entregues. Retorna |
delivery .targetClusterId | string | Identificador único do cluster de destino para executar o tarefa de restauração. |
delivery .targetGroupId | string | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| string | Identificador exclusivo do grupo que possui o trabalho de restauração. |
| string | Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC. |
| string | Identificador único da tarefa de restauração. |
| array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
| booleano | Sinalizador que indica se o snapshot era de um ponto no tempo. |
| string | Identificador exclusivo do snapshot a ser restaurado. |
| string | Status atual da tarefa. Os valores aceitos são:
|
| objeto | Carimbo de data/hora da entrada oplog em que o snapshot foi criado. |
timestamp .date | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da entrada de oplog mais recente no snapshot restaurado. |
timestamp .increment | string | Ordem de todas as operações concluídas na última entrada de oplog no snapshot restaurado. |
Nome | Tipo | Descrição |
---|---|---|
| string | Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado. |
| string | Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado. |
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a tarefa de restauração foi solicitada. |
| objeto | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Significa pelo qual os dados são entregues. Retorna |
delivery .targetClusterId | string | Identificador único do cluster de destino para executar o tarefa de restauração. |
delivery .targetGroupId | string | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| string | Identificador exclusivo do grupo que possui o trabalho de restauração. |
| string | Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC. |
| string | Identificador único da tarefa de restauração. |
| array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
| booleano | Sinalizador que indica se o snapshot era de um ponto no tempo. |
| string | Identificador exclusivo do snapshot a ser restaurado. |
| string | Status atual da tarefa. Os valores aceitos são:
|
| objeto | Carimbo de data/hora da entrada oplog em que o snapshot foi criado. |
timestamp .date | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da entrada de oplog mais recente no snapshot restaurado. |
timestamp .increment | string | Ordem de todas as operações concluídas na última entrada de oplog no snapshot restaurado. |
Nome | Tipo | Descrição |
---|---|---|
| string | Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado. |
| string | Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado. |
| string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a tarefa de restauração foi solicitada. |
| objeto | Método e detalhes de como os dados de snapshot restaurados são entregues. |
delivery .methodName | string | Significa pelo qual os dados são entregues. Retorna |
delivery .targetClusterId | string | Identificador único do cluster de destino para executar o tarefa de restauração. |
delivery .targetGroupId | string | Identificador único do projeto que contém o cluster de destino da tarefa de restauração. |
| string | Identificador exclusivo do grupo que possui o trabalho de restauração. |
| string | Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC. |
| string | Identificador único da tarefa de restauração. |
| array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
| booleano | Sinalizador que indica se o snapshot era de um ponto no tempo. |
| string | Identificador exclusivo do snapshot a ser restaurado. |
| string | Status atual da tarefa. Os valores aceitos são:
|
| objeto | Carimbo de data/hora da entrada oplog em que o snapshot foi criado. |
timestamp .date | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da entrada de oplog mais recente no snapshot restaurado. |
timestamp .increment | string | Ordem de todas as operações concluídas na última entrada de oplog no snapshot restaurado. |
Exemplo de solicitação
Crie um trabalho de restauração que transfira um snapshot compactado usando HTTP .
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "expirationHours" : "1", "maxDownloads" : "1", "methodName" : "HTTP" }, "snapshotId" : "{SNAPSHOT-ID}" }'
Crie uma restauração automatizada a partir de um snapshot.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "snapshotId": "{SNAPSHOT-ID}" }'
Crie uma restauração automatizada a partir de um carimbo de data/hora oplog .
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "oplogTs" : "1536610288", "oplogInc" : "1" }'
Crie uma restauração automatizada a partir de um ponto específico.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "pointInTimeUTCMillis" : "1536610288000" }'
Exemplos de respostas
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
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:00:00Z", "delivery": { "authBearer": "Bearer", "authHeader": "Authorization", "expirationHours": 1, "maxDownloads": 1, "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1, "url": "{DOWNLOAD-URL}", "urlV2": "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}" }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId" : "{BATCH-ID}", "clusterId" : "{CLUSTER-ID}", "created" : "2020-04-21T03:49:57Z", "delivery" : { "expirationHours" : 1, "expires" : "2020-04-21T04:49:57Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "READY", "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz" }, "encryptionEnabled" : false, "groupId" : "{PROJECT-ID}", "id" : "{JOB-ID}", "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}", "rel" : "self" } ], "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2020-04-18T15:14:25Z", "increment" : 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:01:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:02:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:03:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }