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 /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 que indica se o corpo da resposta está em um formato pretty-print. |
|
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:
|
|
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 |
|---|---|---|
| array de strings | Lista de membros do cluster disponíveis para backup. Aparece apenas para solicitações de membros. |
| string | String exclusiva de 24 dígitos hexadecimais que identifica o cluster a ser configurado para backup. |
| booleano | Sinalizador que indica se a criptografia está habilitada para a configuração de backup. Você deve incluir o campo O Ops Manager usa cursor de backup e não usa mais banco de dados principal. Para obter mais informações, consulte o Serviço Backup Daemon. Para aprender mais sobre criptografia de backup, consulte Snapshots de backup criptografados. |
| 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 |
| string | String única de 24 dígitos hexadecimais que identifica o projeto que possui esta configuração de backup. |
| 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 |
| array de objetos | Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays |
| booleano | Sinalizador que indica se o backup de multirregional está habilitado para o cluster. |
| booleano | Sinalizador que indica se o backup de multirregional, se ativado, está no estado
|
| string | |
| booleano | Sinalizador que identifica se o TLS está habilitado para o reconhecimento de data center de origem de sincronização. |
| string | Status atual (ou desejado) da configuração de backup. Os valores possíveis são:
|
| 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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"Quando cada snapshot é iniciado, o Ops 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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "clusterId" : "{CLUSTER-ID}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{PROJECT-ID}", "includedNamespaces" : [ ], "links" : [ ], "multiRegionBackupEnabled" : false, "multiRegionMisconfigured" : false, "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER"}Quando cada snapshot é iniciado, o Ops 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.
{ "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"], "clusterId" : "{CLUSTER-ID}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{PROJECT-ID}", "includedNamespaces" : [ ], "links" : [ ], "multiRegionBackupEnabled" : true, "multiRegionMisconfigured" : false, "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER", "preferredMember" : "{HOSTNAME1}:{PORT1}" }