Obtenha uma configuração de backup de um projeto
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Parâmetro | Tipo | necessidade | Descrição |
---|---|---|---|
ID do projeto | string | Obrigatório | Sequência exclusiva de 24 dígitos hexadecimais que identifica o projeto que contém o cluster com a configuração de backup que você deseja encontrar. |
ID DE CLUSTER | string | Obrigatório | Sequência exclusiva de 24 dígitos hexadecimais que identifica o cluster cuja configuração de backup você deseja encontrar. |
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:
| 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 |
---|---|---|
Membros disponíveis | array de strings | Lista de membros do cluster disponíveis para backup. Aparece apenas para solicitações de membros. |
clusterId | string | String exclusiva de 24 dígitos hexadecimais que identifica o cluster a ser configurado para backup. |
excludedNamespaces | array de strings | Lista de nomes de reconhecimento de data center e nomes de collection para omitir do backup. Cada string é um namespace na forma de Você deve enviar a nova lista completa de namespaces excluídos, incluindo aqueles que já foram listados. Se a nova lista remover qualquer namespace da lista anterior, você também deverá definir o campo Se a nova lista for apenas adicionada à lista anterior, você não precisará definir |
groupId | string | String única de 24 dígitos hexadecimais que identifica o projeto que possui esta configuração de backup. |
includeNamespaces | array de strings | Lista de nomes de reconhecimento de data center e nomes de collection a serem incluídos no backup. Cada string é um namespace na forma de Você deve enviar a nova lista completa de namespaces incluídos, inclusive os que já foram listados. Se a nova lista adicionar quaisquer namespaces à lista anterior, você também deverá definir o campo Se a nova lista remover apenas namespaces da lista anterior, você não precisará definir |
links | array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
primaryMember | string | |
sslEnabled | booleano | Sinalizador que identifica se o TLS está habilitado para o reconhecimento de data center de origem de sincronização. |
statusName | string | Status atual (ou desejado) da configuração de backup. Os valores possíveis são:
|
storageEngineName | string | storage engine usado para o backup. Os valores possíveis são:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"
Quando cada snapshot é iniciado, o Cloud Manager seleciona um membro do conjunto de réplicas para executar o snapshot. Esse membro selecionado automaticamente deve ter o menor impacto no desempenho no conjunto de réplicas. Você pode substituir a seleção padrão.
Importante
Use default selection sempre que possível. Essa opção garante a disponibilidade do backup.
A seguinte solicitação retorna os membros disponíveis.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"
Exemplo de resposta
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
1 { 2 "clusterId" : "{CLUSTER-ID}", 3 "excludedNamespaces" : [ ], 4 "groupId" : "{PROJECT-ID}", 5 "includedNamespaces" : [ ], 6 "links" : [ ], 7 "sslEnabled" : false, 8 "statusName" : "STARTED", 9 "storageEngineName" : "WIRED_TIGER" 10 }
Quando cada snapshot é iniciado, o Cloud Manager seleciona um membro do conjunto de réplicas para executar o snapshot. Esse membro selecionado automaticamente deve ter o menor impacto no desempenho no conjunto de réplicas. Você pode substituir a seleção padrão.
Importante
Use default selection sempre que possível. Essa opção garante a disponibilidade do backup.
A seguinte resposta inclui os membros disponíveis e o membro preferencial designado. Se um membro preferencial não estiver definido, ele será excluído da resposta.
1 { 2 "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"], 3 "clusterId" : "{CLUSTER-ID}", 4 "excludedNamespaces" : [ ], 5 "groupId" : "{PROJECT-ID}", 6 "includedNamespaces" : [ ], 7 "links" : [ ], 8 "sslEnabled" : false, 9 "statusName" : "STARTED", 10 "storageEngineName" : "WIRED_TIGER", 11 "preferredMember" : "{HOSTNAME1}:{PORT1}" 12 }