Devolver el estado de la conexión entre organizaciones

Devuelve el estado de la conexión entre la organización Cloud Manager especificada y la organización MongoDB Atlas de destino.

Roles necesarios

Tu clave API debe tener el rol Organization Owner para llamar correctamente a este recurso.

Solicitud

URL base: https://cloud.mongodb.com/api/public/v1.0

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

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
orgId	string	Requerido	string única de 24 dígitos hexadecimales que identifica la organización fuente que contiene los proyectos que se migrarán a MongoDB Atlas.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
Estado	string	Estado de la conexión que existe entre esta organización y el clúster de destino en la organización de MongoDB Atlas. La respuesta devuelve `"SYNCED"` o `"NOT_SYNCED"`.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request GET 'https://cloud.mongodb.com/api/public/v1.0/orgs/{orgId}/liveExport/migrationLink/status?pretty=true'

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

{
  "status": "SYNCED"
}