Conectar uma organização com uma organização Atlas

Nesta página

Funções obrigatórias

Solicitar
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

Conecte a organização de origem do Ops Manager com uma organização de destino do MongoDB Atlas.

Funções obrigatórias

Sua chave de API deve ter a função Organization Owner para chamar esse recurso com êxito.

Solicitar

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /orgs/{orgId}/liveExport/migrationLink

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
orgId	string	Obrigatório	String exclusiva de 24 dígitos hexadecimais que identifica a organização de origem que contém seus projetos.

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
linkToken	string	Obrigatório	String que contém as informações necessárias para se conectar do MongoDB Cloud Manager ou do Ops Manager ao MongoDB Atlas durante uma migração live de um sistema do MongoDB Cloud Manager ou do Ops Manager para um cluster no MongoDB Atlas. Ao migrar dados de um MongoDB Cloud Manager ou do Ops Manager, você precisa fazer o seguinte: Gerar um link-token no MongoDB Atlas Insira-o nas configurações da organização do MongoDB Cloud Manager ou do Ops Manager. Você usa o mesmo link-token para migrar cada sistema em sua organização do MongoDB Cloud Manager ou do Ops Manager sequencialmente, um de cada vez. Você pode gerar vários link-token no MongoDB Atlas. Use um link-token para cada organização do MongoDB Cloud Manager ou Ops Manager.

Resposta

Nome	Tipo	Descrição
Status	string	Estado da conexão existente entre esta organização e o cluster de destino na organização MongoDB Atlas. A resposta retorna `"SYNCED"` ou `"NOT_SYNCED"`.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/atlas/v1.0/orgs/{orgId}/liveExport/migrationLink?pretty=true' \
     --data '{
         "linkToken": "string"
       }'

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 201 Created
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

{
  "status": "SYNCED"
}

Voltar

Migrar para o MongoDB Atlas

Remover conexão