Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas CLI
/
参考
/
JSON 配置文件

Atlas Online Archive配置文件

在此页面上

  • Atlas Online Archive 设置
  • Atlas Online Archive 创建配置文件示例
  • Atlas Online Archive 更新配置 文件示例
  • Atlas Online Archive 创建命令示例
  • Atlas Online Archive 更新命令示例

您可以使用文件来指定使用 Atlas CLI 创建和更新 Atlas Online Archive 所需的设置。Atlas CLI 接受.jsonAtlas Online Archive配置文件。

使用以下资源：

  • 了解您可以在 中指定的 必需设置Atlas Online Archive

  • 查看和复制示例配置文件。

Atlas Online Archive 设置

您可以在配置文件中或在命令中指定以下设置来创建或更新Atlas Online Archive：

字段
类型
说明

groupId

字符串

项目的唯一标识符。 groupId与projectId相同。 对于现有群组， groupId和projectId保持不变。 资源和相应的端点使用术语一词。

archiveID

字符串

唯一的 24 位十六进制数字串，用于标识要更新的在线归档。

clusterName

字符串

人类可读标签，用于标识包含要为其创建或更新一个Atlas Online Archive的collection的集群。

collName

字符串

你的collection的名称。

criteria

对象

MongoDB MongoDB Cloud 存档数据的规则。

dbName

字符串

包含在线存档的集合的数据库的可读标签。

有关可用设置的详细说明和完整列表，请参阅 API 规范中的请求正文模式：

Atlas Online Archive 创建配置文件示例

{
    "name":"myCluster",
    "groupId": "32y6e74b3g91947azb20e3b8",
    "collName": "myCollection",
    "collectionType": "TIMESERIES",
    "criteria": {
      "type": "DATE"
    },
    "dataExpirationRule": {
      "expireAfterDays": 7
    },
    "dataProcessRegion": {
      "cloudProvider": "AWS",
      "region": "US_EAST_1"
    },
    "dbName": "myDB",
    "partitionFields": [
      {
        "fieldName": "exampleField",
        "order": 0
      }
    ],
    
    "paused": true,
    "schedule": {
      "type": "DEFAULT"
    }
  }

Atlas Online Archive 更新配置 文件示例

{
    "name":"myCluster",
    "groupId": "32y6e74b3g91947azb20e3b8",
    "archiveId":"32y6e74b3g32y6e74b3gyb45",
    "criteria": {
      "type": "DATE"
    },
    "dataExpirationRule": {
      "expireAfterDays": 7
    },
    "paused": true,
    "schedule": {
      "type": "DEFAULT"
    }
  }

Atlas Online Archive 创建命令示例

要创建Atlas Online Archive配置，请指定--file选项和文件路径。以下示例使用名为online-archive-create-config.json的配置文件创建Atlas Online Archive：

atlas clusters onlineArchive create --file online-archive-create-config.json --output json

Atlas Online Archive 更新命令示例

要更新Atlas Online Archive配置，请指定--file选项和文件路径。以下示例使用名为online-archive-update-config.json的配置文件更新Atlas Online Archive：

atlas clusters onlineArchive update --file online-archive-update-config.json --output json

后退

搜索节点

来年

警报