Atribuir região de implantação a um shard

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

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

PATCH /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 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
`deploymentConfigs`	Array de objetos	Obrigatório	Objetos de especificação para os membros do cluster para os quais atribuir regiões de sistema.
`deploymentConfigs` `.rsId`	string	Obrigatório	Etiqueta do conjunto de réplicas que identifica o shard.
`deploymentConfigs` `.deploymentId`	string	Obrigatório	Identificador único que faz referência à região de implantação a ser atribuída ao shard.
`multiRegionBackupEnabled`	booleano	Obrigatório	Sinalizador que indica seo multirregional está habilitado para o cluster.

Resposta

Nome	Tipo	Descrição
`authMechanismName`	string	Mecanismo de autenticação necessário para se conectar ao banco de banco de dados de origem de sincronização. O MongoDB Ops Manager exige este parâmetro se o armazenamento de sincronização usar autenticação. O MongoDB Ops Manager retorna um dos seguintes: `MONGODB_CR` (Isto abrange SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-CR.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
`clusterId`	string	24exclusiva -string de dígitos hexadecimais que identifica o cluster configurado para backup.
`encryptionEnabled`	booleano	Sinalizador que indica se a criptografia está habilitada para a configuração de backup.
`excludedNamespaces`	array de strings	Lista de nomes de bancos de banco de dados e nomes de collections omitidos do backup. Cada string especifica um namespace do formulário `{database}` ou `{database}.{collection}`.
`groupId`	string	String única de 24 dígitos hexadecimais que identifica o projeto que possui esta configuração de backup.
`includedNamespaces`	array de strings	Lista de nomes de bancos de banco de dados e nomes de collection incluídos no backup. Cada string especifica um namespace do formulário `{database}` ou `{database}.{collection}`. Qualquer namespace não listado nesta array não deve ser copiado.
`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.
`multiRegionBackupEnabled`	booleano	Sinalizador que indica se o backup de multirregional está habilitado para o cluster.
`multiRegionMisconfigured`	booleano	Sinalizador que indica se o multirregional, se ativado, está no estado `Misconfigured` . O valor pode ser um dos seguintes: `true` - o status é `Misconfigured` e o MongoDB Ops Manager não tirará nenhum novo snapshot, embora o MongoDB Ops Manager continue seguindo os oplog sem interrupção para os membros do cluster com regiões atribuídas. Você deve selecionar uma região de implantação para os novos membros do cluster para que o MongoDB Ops Manager continue a tirar novos snapshots para todos os membros do cluster. `false` - o status é `Active`.
`preferredMember`	string	Membro do cluster designado manualmente como o membro preferencial para backup. Aparece somente para solicitações de membro quando o membro preferencial é definido com a UI ou API.
`sslEnabled`	booleano	Sinalizador que indica se o TLS está habilitado para o reconhecimento de data center de origem de sincronização.
`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`

Exemplo de solicitação

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/?pretty=true"
     --data '
       {
         "multiRegionBackupEnabled" : true,
         "deploymentConfigs": [
           {"rsId":"myShard_2", "deploymentId":"NY_NJ"},
         ]
       }'

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

{
  "authMechanismName" : "NONE",
  "clusterId" : "{CLUSTER-ID}",
  "encryptionEnabled" : false,
  "excludedNamespaces" : [ ],
  "groupId" : "{PROJECT-ID}",
  "links" : [ ],
  "multiRegionBackupEnabled" : true,
  "multiRegionMisconfigured" : false,
  "sslEnabled" : false,
  "statusName" : "STARTED",
  "storageEngineName" : "WIRED_TIGER"
}

Voltar

Criar por ID

Excluir