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

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

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

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 /groups/{PROJECT-ID}/backupConfigs

Parâmetros da solicitação

Parâmetros do caminho da solicitação

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.

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 `results` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como `false` para incluir configurações de daemon com o sinalizador `backupJobsEnabled` definido como `false`.	`true`

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
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. FCV `4.2` e, posteriormente, use cursores de backup em vez de head databases. Para obter mais informações, consulte Serviço Backup Daemon . Para obter mais informações sobre criptografia de backup para FCV 4.2 ou posterior, 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`.

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"

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   "totalCount" : 3,
3   "results" : [ {
4     "groupId" : "{PROJECT-ID}",
5     "clusterId" : "{CLUSTER-ID1}",
6     "statusName" : "STARTED",
7     "storageEngineName" : "WIRED_TIGER",
8     "sslEnabled" : false,
9     "excludedNamespaces" : [ ],
10     "includedNamespaces" : [ ],
11     "links" : [ ]
12   }, {
13     "groupId" : "{PROJECT-ID}",
14     "clusterId" : "{CLUSTER-ID2}",
15     "statusName" : "STARTED",
16     "storageEngineName" : "MEMORY_MAPPED",
17     "sslEnabled" : false,
18     "excludedNamespaces" : [ ],
19     "includedNamespaces" : [ ],
20     "links" : [ ]
21   }, {
22     "groupId" : "{PROJECT-ID}",
23     "clusterId" : "{CLUSTER-ID3}",
24     "statusName" : "STOPPED",
25     "storageEngineName" : "WIRED_TIGER",
26     "sslEnabled" : false,
27     "excludedNamespaces" : [ ],
28     "includedNamespaces" : [ ],
29     "links" : [ ]
30   } ],
31   "links" : [ ]
32 }

Voltar

Configurações de backup

Obtenha uma configuração de backup de um projeto

1	{
2	"totalCount" : 3,
3	"results" : [ {
4	"groupId" : "{PROJECT-ID}",
5	"clusterId" : "{CLUSTER-ID1}",
6	"statusName" : "STARTED",
7	"storageEngineName" : "WIRED_TIGER",
8	"sslEnabled" : false,
9	"excludedNamespaces" : [ ],
10	"includedNamespaces" : [ ],
11	"links" : [ ]
12	}, {
13	"groupId" : "{PROJECT-ID}",
14	"clusterId" : "{CLUSTER-ID2}",
15	"statusName" : "STARTED",
16	"storageEngineName" : "MEMORY_MAPPED",
17	"sslEnabled" : false,
18	"excludedNamespaces" : [ ],
19	"includedNamespaces" : [ ],
20	"links" : [ ]
21	}, {
22	"groupId" : "{PROJECT-ID}",
23	"clusterId" : "{CLUSTER-ID3}",
24	"statusName" : "STOPPED",
25	"storageEngineName" : "WIRED_TIGER",
26	"sslEnabled" : false,
27	"excludedNamespaces" : [ ],
28	"includedNamespaces" : [ ],
29	"links" : [ ]
30	} ],
31	"links" : [ ]
32	}