Página inicial do Docs

/ /

Migrar para o MongoDB Atlas

Página inicial do Docs

/ /

Recursos

Migrar para o MongoDB Atlas

Página inicial do Docs

Migrar para o MongoDB Atlas

Retornar o status da conexão entre organizações

Retorne o status da conexão entre a organização de origem especificada do Ops Manager e a 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

GET /orgs/{orgId}/liveExport/migrationLink/status

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 os projetos a serem migrados para o MongoDB Atlas.

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.	`false`
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: `status`: Código de resposta HTTP `content`: Corpo de resposta esperado	`false`

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
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 GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/liveExport/migrationLink/status?pretty=true'

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

{
  "status": "SYNCED"
}

Voltar

Remover conexão

Códigos de erro