Criar uma região de implantação

Nesta página

Resource

Parâmetros da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

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.

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

Resource

POST /admin/backup/backupDeployments

Parâmetros 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:

Nome	Descrição
`status`	Código de resposta HTTP
`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 implantação a recursos de backup.
`bqProxyEndpoint`	string	Obrigatório	Instância MongoDB Ops Manager que atende a solicitações de queryable backup . O valor está no seguinte formato: `domain:port`. Por exemplo, `localhost:8080`.
`deploymentDescription`	string	Obrigatório	string que descreve a finalidade da região de implantação.
`id`	string	Necessário	Identificador único que referencia esta região de sistema nas configurações.
`ingestionEndpoint`	string	Necessário	Instância MongoDB Ops Manager na qual o agente de backup grava dados de snapshot ou oplog . O valor é uma URL válida como `http://www.mongodb.com`. Suporta HTTP e 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	Instância MongoDB Ops Manager que atende a solicitações de queryable backup . O valor está no seguinte formato: `domain:port`. Por exemplo, `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	Instância MongoDB Ops Manager na qual o agente de backup grava dados de snapshot ou oplog . O valor é uma URL válida como `http://www.mongodb.com`. Suporta HTTP e HTTPS.
`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.
`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 POST "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=true"
     --data '
       {
         "id": "AU_NZ",
         "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_NZ",
  "ingestionEndpoint" : "https://api-backup.mongodb.com",
  "links" : [ ],
  "restoreEndpoint" : "https://api-backup.mongodb.com"
}

Voltar

Obter uma região de sistema

Criar uma região de sistema por ID