获取 Flexible Sync 信息

获取 /groups/{groupId}/apps/{appId}/service/{serviceId}/config

使用 Flexible Sync 时,检索特定 Atlas App Services App 的同步数据。

路径参数

响应

  • 200 application/json

    已成功检索。

    隐藏响应属性 显示响应属性 对象
    • clusterId 字符串

      关联集群的服务 ID。

    • 集群名称 字符串

      关联集群的名称

    • clusterType 字符串

      关联集群的服务类型(默认为“ Atlas ”)

      值为 atlasserverless

    • 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 整型

        在需要进行客户端重置之前,客户端可以离线的天数。

      • is_recovery_mode_disabled 布尔

        指定是否禁用客户端重置模式。默认下,启用客户端重置模式,该值为 false

      • asymmetric_tables array[string]

        定义为与数据导入不对称的集合名称的大量,客户端可以写入但不能读取数据。

    • groupName 字符串

      应用的Atlas项目的名称。

    • orgName 字符串

      应用程序的Atlas组织的名称。

    • readPreference 字符串

      取值为 primaryprimaryPreferredsecondarysecondaryPreferrednearest

    • 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
}