Obtener información de sincronización flexible

Obtener /grupos/{ID de grupo}/aplicaciones/{ID de aplicación}/servicio/{ID de servicio}/config

Recupere datos de sincronización para una aplicación específica de Atlas App Services al usar Flexible Sync.

Parámetros de ruta

Respuestas

  • 200 aplicación/json

    Recuperado exitosamente.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • clusterId string

      El ID de servicio para el clúster vinculado.

    • nombre del clúster string

      El nombre del clúster vinculado

    • tipo de clúster string

      El tipo de servicio del clúster vinculado ("atlas" por defecto)

      Los valores son atlas o serverless.

    • sincronización flexible Objeto
      Ocultar atributos flexible_sync Mostrar atributos flexible_sync Objeto
      • Estado string Requerido

        El estado del servicio de sincronización ("enabled", "disabled" o vacío si la sincronización no está configurada).

      • nombre_de_la_base_de_datos string

        El nombre de una base de datos en el clúster sincronizado donde App Services almacena datos en modo de desarrollo. App Services genera automáticamente un esquema para cada tipo sincronizado y asigna cada tipo de objeto a una colección dentro de la base de datos.

      • nombres de campos consultables array[string]

        Una matriz de nombres de campos consultables en cualquier colección.

      • indexed_queryable_fields_names array[string]

        Una lista de nombres de campos para usar como campo indexado consultable. Aunque esta propiedad es un arreglo, Sincronización actualmente soporta solo un campo indexado consultable. Por lo tanto, este arreglo puede contener como máximo un elemento.

        El campo consultable indexado debe estar presente en el esquema y ser del mismo tipo de campo elegible en todas las colecciones que sincronices. El nombre del campo indexado consultable también debe aparecer en queryable_fields_names ya que este es un campo consultable global.

      • nombres de campos consultables de colección Objeto

        Una matriz de nombres de campos consultables en la colección especificada.

        Ocultar el atributo collection_queryable_fields_names Mostrar el atributo collection_queryable_fields_names Objeto
        • * Objeto Propiedades adicionales
          Ocultar * atributo Mostrar atributo * Objeto
          • * string Propiedades adicionales

            El nombre del campo consultable.

      • permisos Objeto

        Obsoleto

      • última_deshabilitación string

        La última vez que se deshabilitó la sincronización, representada por la cantidad de segundos desde la época de UNIX.

      • días máximos sin conexión del cliente entero

        La cantidad de días que el cliente puede estar fuera de línea antes de que sea necesario reiniciarlo.

      • el modo de recuperación está deshabilitado booleano

        Especifica si el modo de restablecimiento del cliente está deshabilitado. De forma predeterminada, el modo de restablecimiento del cliente está habilitado y este valor es false.

      • asymmetric_tables array[string]

        Una matriz de nombres de colecciones que se definen como asimétricas con la ingesta de datos, donde los clientes pueden escribir datos pero no leerlos.

    • nombre del grupo string

      El nombre del Proyecto Atlas de la aplicación.

    • nombre_org string

      El nombre de la organización Atlas de la aplicación.

    • readPreference string

      Los valores son primary, primaryPreferred, secondary, secondaryPreferred o nearest.

    • Protocolo de cable habilitado booleano

      Si es verdadero, los clientes pueden conectarse a la aplicación a través del protocolo MongoDB Wire.

OBTENER /grupos/{groupId}/aplicaciones/{appId}/servicio/{serviceId}/config
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/service/{serviceId}/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "clusterId": "string",
  "clusterName": "string",
  "clusterType": "atlas",
  "flexible_sync": {
    "state": "string",
    "database_name": "string",
    "queryable_fields_names": [
      "string"
    ],
    "indexed_queryable_fields_names": [
      "string"
    ],
    "collection_queryable_fields_names": {
      "additionalProperty1": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "additionalProperty2": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "permissions": {},
    "last_disabled": "string",
    "client_max_offline_days": 42,
    "is_recovery_mode_disabled": true,
    "asymmetric_tables": [
      "string"
    ]
  },
  "groupName": "string",
  "orgName": "string",
  "readPreference": "primary",
  "wireProtocolEnabled": true
}