Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter todas as configurações de backup para um projeto

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

GET /groups/{PROJECT-ID}/backupConfigs
Nome
Tipo
necessidade
Descrição

ID do projeto

string

Obrigatório

String única de 24 dígitos hexadecimais que identifica o projeto ao qual a configuração de backup se aplica.

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.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na 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

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

Nome
Tipo
Descrição

groupId

string

String única de 24 dígitos hexadecimais que identifica o projeto que possui esta configuração de backup.

clusterId

string

Sequência exclusiva de 24 dígitos hexadecimais que identifica o cluster cuja configuração de backup você deseja encontrar.

statusName

string

Status atual (ou desejado) da configuração de backup. Os valores possíveis são:

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName

string

storage engine usado para o backup. Os valores possíveis são:

  • MEMORY_MAPPED

  • WIRED_TIGER

encryptionEnabled

booleano

Sinalizador que indica se a criptografia está habilitada para a configuração de backup. Você deve incluir o campo syncSource ao habilitar a criptografia para uma configuração de backup. Para backups existentes em um projeto, ativar a criptografia requer uma sincronização inicial para recriar os head databases dos backups.

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.

sslEnabled

booleano

Sinalizador que indica se o TLS está habilitado para o reconhecimento de data center de origem de sincronização.

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 <database> ou <database>.<collection>. Se este campo estiver presente, o campo includedNamespaces não poderá estar presente.

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 syncSource , pois a remoção de um namespace excluído exige uma ressincronização completa. Sem o campo syncSource , a solicitação falhará.

Se a nova lista for apenas adicionada à lista anterior, você não precisará definir syncSource.

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 <database> ou <database>.<collection>. Qualquer namespace não listado nesta array não será copiado. Se este campo estiver presente, o campo excludedNamespaces não poderá estar presente.

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 syncSource , pois a adição de um namespace incluído exige uma ressincronização completa. Sem o campo syncSource , a solicitação falhará.

Se a nova lista remover apenas namespaces da lista anterior, você não precisará definir syncSource.

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"
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-alive
HTTP/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}
{ "totalCount" : 3, "results" : [ { "groupId" : "{PROJECT-ID}", "clusterId" : "{CLUSTER-ID1}", "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER", "sslEnabled" : false, "excludedNamespaces" : [ ], "includedNamespaces" : [ ], "links" : [ ] }, { "groupId" : "{PROJECT-ID}", "clusterId" : "{CLUSTER-ID2}", "statusName" : "STARTED", "storageEngineName" : "MEMORY_MAPPED", "sslEnabled" : false, "excludedNamespaces" : [ ], "includedNamespaces" : [ ], "links" : [ ] }, { "groupId" : "{PROJECT-ID}", "clusterId" : "{CLUSTER-ID3}", "statusName" : "STOPPED", "storageEngineName" : "WIRED_TIGER", "sslEnabled" : false, "excludedNamespaces" : [ ], "includedNamespaces" : [ ], "links" : [ ] } ], "links" : [ ]}