Flexible Sync 정보 가져오기

얻다 /groups/{groupId}/apps/{appId}/service/{serviceId}/config

Flexible Sync를 사용할 때 특정 Atlas App Services 앱에 대한 동기화 데이터를 조회합니다.

경로 매개변수

응답

  • 200 application/json

    성공적으로 조회되었습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • clusterId 문자열

      연결된 클러스터의 서비스 ID입니다.

    • clusterName 문자열

      연결된 클러스터 의 이름

    • clusterType 문자열

      연결된 클러스터 의 서비스 유형( 기본값 으로 ' Atlas ')

      값은 atlas 또는 serverless입니다.

    • flexible_sync 객체
      flexible_sync 속성 숨기기 flexible_sync 속성 표시 객체
      • 상태 문자열 필수 사항

        동기화 서비스의 상태 ("enabled", "disabled" 또는 동기화가 구성되지 않은 경우 비어 있음)입니다.

      • database_name 문자열

        App Services가 개발 모드에서 데이터를 저장하는 동기화된 클러스터의 데이터베이스 이름입니다. App Services는 동기화된 각 유형에 대한 스키마를 자동으로 생성하고 각 객체 유형을 데이터베이스 내의 컬렉션에 매핑합니다.

      • queryable_fields_names array[string]

        컬렉션 에 있는 쿼리 가능 필드 이름의 배열 .

      • indexed_queryable_fields_names array[string]

        인덱싱된 쿼리 가능 필드로 사용할 필드 이름 목록입니다. 이 속성 은 배열 이지만 Sync는 현재 인덱싱된 쿼리 가능 필드 하나만 지원합니다. 따라서 이 배열 최대 하나의 요소만 포함될 수 있습니다.

        인덱싱된 쿼리 가능 필드 스키마 에 존재해야 하며 동기화 모든 컬렉션 에서 동일한 적격 필드 유형이어야 합니다. 인덱싱된 쿼리 가능 필드 이름은 글로벌 쿼리 가능 필드 이므로 queryable_fields_names 에도 표시되어야 합니다.

      • collection_queryable_fields_names 객체

        지정된 컬렉션에 있는 쿼리 가능 필드 이름의 배열.

        collection_queryable_fields_names 속성 숨기기 collection_queryable_fields_names 속성 표시 객체
        • * 객체 additionalProperties
          * 속성 숨기기 * 속성 표시 객체
          • * 문자열 additionalProperties

            쿼리 가능 필드 의 이름입니다.

      • 권한 객체

        더 이상 사용되지 않습니다.

      • last_disabled 문자열

        마지막으로 동기화가 비활성화된 시간으로, UNIX 에포크 이후의 시간(초)으로 표시됩니다.

      • client_max_offline_days integer

        클라이언트 재설정 필요하기 전에 클라이언트 오프라인 상태일 수 있는 일수입니다.

      • is_recovery_mode_disabled 부울

        클라이언트 재설정 모드 비활성화할지 여부를 지정합니다. 기본값 으로 클라이언트 재설정 모드 활성화되어 있으며 이 값은 false입니다.

      • asymmetric_tables array[string]

        데이터 수집 통해 비대칭으로 정의된 컬렉션 이름의 배열, 클라이언트는 데이터를 쓰기 (write) 수는 있지만 읽을 수는 없습니다.

    • groupName 문자열

      앱의 Atlas 프로젝트 이름입니다.

    • orgName 문자열

      앱의 Atlas 조직 이름입니다.

    • 읽기 설정 문자열

      값은 primary, primaryPreferred, secondary, secondaryPreferred 또는 nearest입니다.

    • wireProtocolEnabled 부울

      참인 경우 클라이언트는 MongoDB 유선 프로토콜을 통해 앱에 연결할 수 있습니다.

GET /groups/{groupId}/apps/{appId}/service/{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"
응답 예시(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
}