Flexible Sync の情報を取得する

GET /groups/{groupId}/apps/{appId}/service/{serviceId}/config

Flexible Sync を使用するときに、特定の Atlas App Services アプリの同期データを検索します。

path パラメータ

応答

  • 200 application/ JSON

    正常に取得されました。

    応答属性の非表示 応答属性の表示 オブジェクト
    • clusterId string

      連結クラスターのサービス ID。

    • clusterName string

      連結クラスターの名前

    • clusterType string

      連結クラスターのサービスタイプ(デフォルトでは「Atlas」)

      値は atlas または serverless です。

    • Flexible_sync オブジェクト
      Flexible_sync 属性を非表示にする Flexible_sync 属性の表示 オブジェクト
      • 状態 string 必須

        同期サービスの状態(同期が構成されていない場合は、"enabled""disabled"、または空)。

      • database_name string

        App Services が開発モード でデータを保存する同期されたクラスター内のデータベースの名前。App Services は、同期された各型のスキーマを自動的に生成し、各オブジェクト型をデータベース内のコレクションにマッピングします。

      • queryable_fields_names array[string]

        任意のコレクションのクエリ可能なフィールド名の配列。

      • Indexed_queryable_fields_names array[string]

        インデックス付きクエリ可能なフィールドとして使用するフィールド名のリスト。このプロパティは配列ですが、Sync は現在、インデックス付きクエリ可能なフィールド の1 つのみをサポートしています。したがって、この配列には最大 1 つの要素を含めることができます。

        インデックス付きクエリ可能なフィールドはスキーマ内に存在し、同期するすべてのコレクションで同じ適格なフィールド型である必要があります。このはグローバルなクエリ可能なフィールドであるため、インデックス付きクエリ可能なフィールド名は queryable_fields_names にも表示される必要があります。

      • collection_queryable_fields_names オブジェクト

        指定されたコレクションのクエリ可能なフィールド名の配列。

        collection_queryable_fields_names 属性を非表示にする collection_queryable_fields_names 属性を表示 オブジェクト
        • * オブジェクト additionalProperties
          * 属性を非表示 * 属性を表示 オブジェクト
          • * string additionalProperties

            クエリ可能なフィールドの名前。

      • 権限 オブジェクト

        非推奨

      • last_disabled string

        同期 が最後に無効になった時刻は、UNIX エポックからの秒数により表示されます。

      • client_max_OFFline_days integer

        クライアントリセットが必要になるまでにクライアントがオフラインになることができる日数。

      • is_recury_mode_disabled ブール値

        クライアントリセットモードを無効にするかどうかを指定します。デフォルトでは 、クライアントリセットモードが有効になっており、この値は false です。

      • asymmetric_tables array[string]

        Data Ingestで非対称として定義されているコレクションの名前の配列。クライアントはデータを書込むことができますが、読み取りはできません。

    • groupName string

      アプリの Atlas プロジェクトの名前。

    • orgName string

      アプリの Atlas 組織の名前。

    • readPreference string

      値は、primaryprimaryPreferredsecondarysecondaryPreferred、または nearest です。

    • wireProtocolEnabled ブール値

      true の場合、クライアントは 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
}