/ /

Backup e restauração

Regiões de implantação

Página inicial do Docs

Regiões de implantação

Obter uma região de sistema

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

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

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Parâmetro	Tipo	necessidade	Descrição
ID DE Implantação	string	Obrigatório	Identificador único que faz referência à 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
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=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

1 {
2    "assignmentEnabled" : true,
3    "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
4    "deploymentDescription" : "Eastern US",
5    "id" : "NY_NJ",
6    "ingestionEndpoint" : "https://api-backup.mongodb.com",
7    "links" : [ ],
8    "restoreEndpoint" : "https://api-backup.mongodb.com"
9 }

Voltar

Obter todos

criar

1	{
2	"assignmentEnabled" : true,
3	"bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
4	"deploymentDescription" : "Eastern US",
5	"id" : "NY_NJ",
6	"ingestionEndpoint" : "https://api-backup.mongodb.com",
7	"links" : [ ],
8	"restoreEndpoint" : "https://api-backup.mongodb.com"
9	}