/ /

Backup e restauração

Regiões de implantação

Página inicial do Docs

Regiões de implantação

Criar uma região de sistema por ID

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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PUT /admin/backup/backupDeployments/{DEPLOYMENT-ID}

Parâmetros da solicitação

Parâmetros do caminho da solicitação

parâmetro de caminho	Tipo	necessidade	Descrição
{DEPLOYMENT-ID}	string	Obrigatório	Identificador único que referencia esta região de sistema nas configurações.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
pretty	booleano	Opcional	Flag indicating whether the response body is in a prettyprint format.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de 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: `status`: HTTP response code `content`: Corpo de resposta esperado	`false`

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
`assignmentEnabled`	booleano	Opcional	Sinalizador que indica se você pode atribuir regiões de sistema aos recursos de backup.
bqProxyEndpoint	string	Obrigatório	Ops Manager instance that serves Queryable Backup requests. Value is in the following format: `domain:port`. For example, `localhost:8080`.
deploymentDescription	string	Obrigatório	string que descreve a finalidade da região de implantação.
ponto final da ingestão	string	Necessário	Ops Manager instance to which the Backup Agent writes snapshot or oplog data. Value is a valid URL such as `http://www.mongodb.com`. Supports both HTTP and HTTPS.
restoreEndpoint	string	Obrigatório	Instância MongoDB Ops Manager que atende a solicitações de restauração.

Resposta

Nome	Tipo	Descrição
`assignmentEnabled`	booleano	Sinalizador que indica se você pode atribuir regiões de sistema aos recursos de backup.
`bqProxyEndpoint`	string	Ops Manager instance that serves Queryable Backup requests. Value is in the following format: `domain:port`. For example, `localhost:8080`.
`deploymentDescription`	string	string que descreve a finalidade da região de implantação.
`id`	string	Identificador único que referencia esta região de sistema nas configurações.
`ingestionEndpoint`	string	Ops Manager instance to which the Backup Agent writes snapshot or oplog data. Value is a valid URL such as `http://www.mongodb.com`. Supports both HTTP and HTTPS.
`links`	array de objetos	Um ou mais links para sub-recursos 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.
`restoreEndpoint`	string	Instância MongoDB Ops Manager que atende a solicitações de restauração.

Exemplo de solicitação

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PUT
     "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/AU_NJ?pretty=true" \
     --data '
       {
         "ingestionEndpoint": "https://api-backup.mongodb.com",
         "restoreEndpoint": "https://api-backup.mongodb.com",
         "bqProxyEndpoint": "queryable-backup.mongodb.com:27217",
         "deploymentDescription": "Australia and New Zealand",
         "assignmentEnabled": 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

{
  "assignmentEnabled" : true,
  "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
  "deploymentDescription" : "Australia and New Zealand",
  "id" : "AU_NJ",
  "ingestionEndpoint" : "https://api-backup.mongodb.com",
  "links" : [ ],
  "restoreEndpoint" : "https://api-backup.mongodb.com"
}

Voltar

criar

Atribuir