Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Backup e restauração
/
Regiões de implantação

Obter uma região de sistema

Nesta página

  • Resource
  • Parâmetros da solicitação
  • Parâmetros do caminho 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

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 prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na consulta.

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 implantação a 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 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

Próximo

criar