Atualizar uma configuração de backup

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 Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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

PATCH /groups/{projectId}/backupConfigs/{clusterId}

Parâmetros da solicitação

Parâmetros do caminho da solicitação

parâmetro de caminho	Tipo	necessidade	Descrição
projectId	string	Obrigatório	Sequência exclusiva de caracteres de 24 dígitos hexadecimais que identifica o projeto que contém o cluster com a configuração de backup que você deseja alterar.
clusterId	string	Obrigatório	String exclusiva de 24 dígitos hexadecimais que identifica o cluster cuja configuração de backup você deseja alterar.

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:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
authMechanismName	string	Condicional	Mecanismo de autenticação necessário para se conectar ao banco de dados de origem de sincronização. O Cloud Manager exige esse parâmetro se o cloud armazenamento de sincronização usar autenticação. O Cloud Manager aceita: `MONGODB_CR` (Isto abrange SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
excludedNamespaces	array de strings	Condicional	O Cloud Manager aceita esse parâmetro para tarefas de backup que executam o MongoDB `FCV` 4.0 ou anterior. O Cloud Manager ignora esse parâmetro ao fazer backup de bancos de dados MongoDB que executam o FCV 4.2 ou posterior. Lista de nomes de banco de dados e coleção para omitir do backup. Cada string representa um namespace. Os namespaces usam o formato de {database} ou {database}.{collection}. Este parâmetro deve atender às seguintes condições: O Cloud Manager aceita esse parâmetro ou includeNamespaces , não ambos. O Cloud Manager requer a nova lista completa de namespaces excluídos, incluindo os já encontrados na array. Se a sua nova lista remover quaisquer namespaces da array existente, defina o parâmetro syncSource . A remoção de um namespace excluído requer uma ressincronização completa. Sem o parâmetro syncSource , a solicitação falha. Se sua nova lista apenas for adicionada à array existente, não defina syncSource.
includeNamespaces	array de strings	Condicional	O Cloud Manager aceita esse parâmetro para tarefas de backup que executam o MongoDB `FCV` 4.0 ou anterior. O Cloud Manager ignora esse parâmetro ao fazer backup de bancos de dados MongoDB que executam o FCV 4.2 ou posterior. Lista de nomes de banco de dados e coleção para incluir no backup. Cada string representa um namespace. Os namespaces usam o formato de {database} ou {database}.{collection}. Este parâmetro deve atender às seguintes condições: O Cloud Manager aceita esse parâmetro ou excludedNamespaces, não ambos. O Cloud Manager requer a nova lista completa de namespace incluídos, incluindo os já encontrados na array. Se a nova lista adicionar quaisquer namespaces da array existente, defina o parâmetro syncSource . A adição de um namespace incluído requer uma ressincronização completa. Sem o parâmetro syncSource , a solicitação falha. Se a nova lista remover apenas namespaces da array existente, não defina syncSource.
Senha	string	Condicional	Senha a ser usada para se conectar ao banco de banco de dados de origem de sincronização . O Cloud Manager exige esse parâmetro quando as instâncias do armazenamento de sincronização `mongod` exigem que os clientes autentiquem.
primaryMember	string	Opcional	Membro do cluster que um usuário designa como o membro preferencial do conjunto de réplicas para criar snapshots. Você pode definir o membro preferencial usando o console. Visualize os membros do conjunto de réplicas disponíveis que podem agir como um membro preferencial usando o endpoint de configuração Obter um backup.
provisionada	booleano	Condicional	Sinalizador que indica se o Cloud Manager provisionou os recursos necessários para armazenar um backup.
sslEnabled	booleano	Opcional	Sinalizador que indica se o TLS está habilitado para o banco de dados de origem de sincronização.
statusName	string	Opcional	Status atual (ou desejado) da configuração de backup. Cloud Manager aceita: Inativo Provisionamento INICIADO PARADO encerrando
storageEngineName	string	Opcional	storage engine usado para o backup. Cloud Manager aceita: MEMORY_MAPPED WIRED_TIGER
syncSource	string	Condicional	Instância `mongod` da qual obter dados de backup. O Cloud Manager aceita um nome de host específico ou um dos seguintes: PRIMARY e SECUNDÁRIO. Cloud Manager exige este parâmetro se "storageEngineName" : "WIRAD_TIGER".
nome de usuário	string	Condicional	Nome do usuário a ser usado para se conectar ao banco de dados de origem de sincronização. O Cloud Manager exige esse parâmetro quando as instâncias do armazenamento de sincronização `mongod` exigem que os clientes autentiquem. Envie esse parâmetro ao Cloud Manager ao atualizar a configuração de backup de um conjunto de réplicas ou cluster fragmentado que o Cloud Manager não managed.

Resposta

Nome	Tipo	Descrição
authMechanismName	string	Nome do mecanismo de autenticação a ser usado ao conectar-se ao banco de dados de origem de sincronização. O Cloud Manager retorna esse parâmetro se o armazenamento de sincronização usar autenticação.
clusterId	string	Identificador único do cluster ao qual esta configuração de backup se aplica.
excludedNamespaces	array de strings	Lista de nomes de bancos de dados e nomes de collections para omitir do backup. Cada string é um namespace na forma de {database} ou {database}.{collection}.
includeNamespaces	array de strings	Lista de nomes de bancos de dados e nomes de collections a serem incluídos no backup. Cada string é um namespace na forma de {database} ou {database}.{collection}.
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.
primaryMember	string	Membro do cluster que um usuário designa como o membro preferencial do conjunto de réplicas para criar snapshots. Você pode definir o membro preferencial usando o console. Visualize os membros do conjunto de réplicas disponíveis que podem agir como um membro preferencial usando o endpoint de configuração Obter um backup.
projectId	string	Identificador único do projeto que possui esta configuração de backup.
provisionada	booleano	Sinalizador que indica se o Cloud Manager provisionou os recursos necessários para armazenar um backup. Cloud Manager retorna esse parâmetro quando a quantidade de dados a serem armazenados em backup excede um determinado limite.
sslEnabled	booleano	Sinalizador que indica se o TLS está habilitado para o banco de dados de origem de sincronização.
statusName	string	Status atual (ou desejado) da configuração de backup.
storageEngineName	string	storage engine usado para o backup.

Exemplo de solicitação

1 curl --user "{publicKey}:{privateKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5      --data '
6        {
7          "statusName": "STARTED",
8          "storageEngineName": "WIRED_TIGER",
9          "syncSource": "primary"
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 solicitação define o membro preferencial.

1 curl --user "{publicKey}:{privateKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5      --data '
6        {
7          "preferredMember":"<HOSTNAME>:<PORT>"
8        }'

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   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9   "rel" : "self"
10   }, {
11     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18     "rel" : "http://mms.mongodb.com/snapshotSchedule"
19   } ],
20   "sslEnabled" : false,
21   "statusName" : "STARTED",
22   "storageEngineName" : "WIRED_TIGER"
23 }

Importante

Use default selection sempre que possível. Essa opção garante a disponibilidade do backup.

A seguinte resposta inclui membro preferencial.

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9   "rel" : "self"
10   }, {
11     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18     "rel" : "http://mms.mongodb.com/snapshotSchedule"
19   } ],
20   "sslEnabled" : false,
21   "statusName" : "STARTED",
22   "storageEngineName" : "WIRED_TIGER",
23   "preferredMember":"{HOSTNAME}:{PORT}"
24 }

Voltar

Obtenha uma configuração de backup de um projeto

Cronograma de snapshots

1	curl --user "{publicKey}:{privateKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5	--data '
6	{
7	"statusName": "STARTED",
8	"storageEngineName": "WIRED_TIGER",
9	"syncSource": "primary"
10	}'

1	{
2	"authMechanismName" : "NONE",
3	"clusterId" : "{clusterId}",
4	"encryptionEnabled" : false,
5	"excludedNamespaces" : [ ],
6	"groupId" : "{projectId}",
7	"links" : [ {
8	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9	"rel" : "self"
10	}, {
11	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12	"rel" : "http://mms.mongodb.com/cluster"
13	}, {
14	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15	"rel" : "http://mms.mongodb.com/group"
16	}, {
17	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/ {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18	"rel" : "http://mms.mongodb.com/snapshotSchedule"
19	} ],
20	"sslEnabled" : false,
21	"statusName" : "STARTED",
22	"storageEngineName" : "WIRED_TIGER"
23	}