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
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 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
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 Ops Manager exige este parâmetro se o armazenamento de sincronização usar autenticação. O Ops Manager aceita:
|
disableCertificateRevocationCheck | booleano | Opcional | Ao se conectar à implementação do MongoDB que você está fazendo backup, indica se o agente de backup deve usar a opção de string de conexão tlsDisableCertificateRe preferenceCheck. Não defina este parâmetro como |
encryptionEnabled | booleano | Opcional | Sinalizador que indica se a criptografia está habilitada para a configuração de backup. Você deve incluir o parâmetro 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. |
excludedNamespaces | array de strings | Condicional | Lista de nomes de banco de dados e coleção para omitir do backup. Cada string representa um namespace. Os namespaces usam um dos seguintes formatos:
O MongoDB Ops Manager ignora este parâmetro ao fazer backup de bancos de dados MongoDB executando a versão de compatibilidade do recurso 6.0 ou posterior. Este parâmetro deve atender às seguintes condições:
|
includeNamespaces | array de strings | Condicional | Lista de nomes de banco de dados e coleção para incluir no backup. Cada string representa um namespace. Os namespaces usam um dos seguintes formatos:
O MongoDB Ops Manager ignora este parâmetro ao fazer backup de bancos de dados MongoDB executando a versão de compatibilidade do recurso 6.0 ou posterior. Este parâmetro deve atender às seguintes condições:
|
Senha | string | Condicional | Senha a ser usada para se conectar ao banco de banco de dados de origem de sincronização . O MongoDB Ops Manager exige esse parâmetro quando as instâncias do armazenamento de sincronização |
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 Ops 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. O Ops Manager aceita:
|
storageEngineName | string | Opcional | storage engine usado para o backup. O Ops Manager aceita:
|
syncSource | string | Condicional | Instância O Ops 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 banco de dados de origem de sincronização. O MongoDB Ops Manager exige esse parâmetro quando as instâncias do armazenamento de sincronização Envie esse parâmetro para o Ops Manager ao atualizar a configuração de backup de um conjunto de réplicas ou cluster fragmentado que o Ops Manager não managed. |
snapshotStore | objeto | opcional | Objeto que especifica o armazenamento de snapshots para o qual fazer a transição. Esse objeto contém o tipo de armazenamento de snapshots e o ID do bucket S3 ( blockstore S3). Os snapshots existentes permanecem no armazenamento original até expirarem com base em sua política de retenção configurada. Você também pode fazer a transição entre armazenamentos de snapshots compatíveis com S3na página Trabalhos. |
snapshotStore.snapshotStoreType | string | condicional | string que identifica o tipo de armazenamento de snapshots . Atualmente, apenas um bucket S3 ( blockstore S3) é suportado. O valor deve ser |
snapshotStore.snapshotStoreId | string | condicional | String que identifica o blockstore S3 para o qual fazer a transição. Novos snapshot são armazenados neste blockstore S3 de destino. Os snapshot existentes permanecem no armazenar original até expirarem com base na sua política de retenção configurada. Se você fornecer o objeto |
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 Ops 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. |
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. |
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}. |
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 Ops Manager provisionou os recursos necessários para armazenar um backup. O Ops 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 da configuração de backup. |
storageEngineName | string | storage engine usado para o backup. |
snapshotStore | objeto | Objeto que especifica o armazenamento de snapshots para o qual fazer a transição. Esse objeto contém o tipo de armazenamento de snapshots e o ID do bucket S3 ( blockstore S3). Os snapshots existentes permanecem no armazenamento original até expirarem com base em sua política de retenção configurada. Você também pode fazer a transição entre armazenamentos de snapshots compatíveis com S3na página Trabalhos. |
snapshotStore.snapshotStoreType | string | string que identifica o tipo de armazenamento de snapshots . Atualmente, apenas um bucket S3 ( blockstore S3) é suportado. O valor deve ser |
snapshotStore.snapshotStoreId | string | String que identifica o blockstore S3 para o qual fazer a transição. Novos snapshot são armazenados neste blockstore S3 de destino. Os snapshot existentes permanecem no armazenar original até expirarem com base na sua política de retenção configurada. Se você fornecer o objeto |
Exemplo de solicitação
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ --data ' { "statusName": "STARTED", "storageEngineName": "WIRED_TIGER", "syncSource": "primary" }'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 define o membro preferencial.
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ --data ' { "preferredMember":"{HOSTNAME}:{PORT}" }'curl --user "{publicKey}:{privateKey}" \ --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include --request PATCH "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ --data ' { "snapshotStore": {"snapshotStoreId":"{snapshotStoreId}", "snapshotStoreType":"s3blockstore"} }'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
{ "authMechanismName" : "NONE", "clusterId" : "{clusterId}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{projectId}", "links" : [ { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", "rel" : "self" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", "rel" : "http://mms.mongodb.com/cluster" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", "rel" : "http://mms.mongodb.com/group" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule", "rel" : "http://mms.mongodb.com/snapshotSchedule" } ], "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 membro preferencial.
{ "authMechanismName" : "NONE", "clusterId" : "{clusterId}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{projectId}", "links" : [ { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", "rel" : "self" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", "rel" : "http://mms.mongodb.com/cluster" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", "rel" : "http://mms.mongodb.com/group" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule", "rel" : "http://mms.mongodb.com/snapshotSchedule" } ], "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER", "preferredMember":"{HOSTNAME}:{PORT}"}{ "authMechanismName" : "NONE", "clusterId" : "{clusterId}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{projectId}", "links" : [ { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", "rel" : "self" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", "rel" : "http://mms.mongodb.com/cluster" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", "rel" : "http://mms.mongodb.com/group" }, { "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule", "rel" : "http://mms.mongodb.com/snapshotSchedule" } ], "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER", "snapshotStore": { "snapshotStoreType": "s3blockstore", "snapshotStoreId": "your-snapshot-store-id" }}