parâmetros de caminho

• groupId string Obrigatório

  Uma ID de projeto/grupo do Atlas.

• appId string Obrigatório

  O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.

• serviceId string Obrigatório

  O valor _id exclusivo de um serviço.

Respostas

• 200 aplicação/json

  Recuperado com sucesso.

  Ocultar atributos de resposta Mostrar atributos de resposta objeto

  • clusterId string

    A ID de serviço do cluster vinculado.

  • clusterName string

    O nome do cluster vinculado

  • clusterType string

    O tipo de serviço do cluster vinculado ("atlas" por padrão)

    Os valores são atlas ou serverless.

  • flexible_sync objeto
    Ocultar atributos flexible_sync Mostrar atributos flexible_sync objeto

    • state string Obrigatório

      O estado do serviço de sincronização ("enabled", "disabled" ou vazio se a Sincronização não estiver configurada).

    • nome do banco de dados string

      O nome de um banco de dados no cluster sincronizado em que o App Services armazena dados no modo de desenvolvimento. O App Services gera automaticamente um esquema para cada tipo sincronizado e mapeia cada tipo de objeto para uma collection no banco de dados.

    • queryable_fields_names array[string]

      Uma array de nomes de campo de query em qualquer coleção.

    • indexed_queryable_fields_names array[string]

      Uma lista de nomes de campo a serem usados como o campo de query indexado. Embora essa propriedade seja uma array, a Sync atualmente permite apenas um campo de query indexado. Portanto, essa array pode conter no máximo um elemento.

      O campo de query indexado deve estar presente no esquema e ser do mesmo tipo de campo elegível em todas as coleções que você sincronizar. O nome do campo de query indexado também deve aparecer no queryable_fields_names pois este é um campo de query global.

    • collection_queryable_fields_names objeto

      Uma array de nomes de campo de query na collection especificada.

      Ocultar atributo collection_queryable_fields_names Mostrar atributo collection_queryable_fields_names objeto

      • * objeto Propriedades adicionais
        Ocultar atributo * Mostrar atributo * objeto

        • * string Propriedades adicionais

          O nome do campo de query.

    • Permissões objeto

      Obsoleto(a)

    • last_disabled string

      A última vez que a sincronização foi desativada, representada pelo número de segundos desde o UNIX epoch.

    • client_max_offline_days inteiro

      O número de dias em que o cliente pode ficar offline antes que um reinício do cliente seja necessário.

    • is_recovery_mode_disabled booleano

      Especifica se o modo de reinício do cliente está desabilitado. Por padrão, o modo de reinício do cliente está habilitado e esse valor é false.

    • asymmetric_tables array[string]

      Uma array dos nomes das collections definidas como assimétricas com a ingestão de dados, nas quais os clientes podem gravar dados, mas não ler.

  • groupName string

    O nome do Projeto Atlas do aplicativo.

  • orgName string

    O nome da Organização Atlas do aplicativo.

  • readPreference string

    Os valores são primary, primaryPreferred, secondary, secondaryPreferred ou nearest.

  • wireProtocolEnabled booleano

    Se verdadeiro, os clientes podem se conectar ao aplicativo pelo protocolo de conexão do MongoDB.