MongoDB.local SF, Jan 15: See the speaker lineup & ship your AI vision faster. Use WEB50 to save 50%
Find out more >
Docs 菜单
Docs 主页
/ /
自定义资源
Docs 主页
/
管理
/
Atlas Kubernetes Operator
/
自定义资源
Docs 主页
/
管理
/
Atlas Kubernetes Operator
/
自定义资源

AtlasDeployment 自定义资源

迁移到 Flex 集群

重要

迁移到 Flex 集群

  • Atlas已弃用 M2 和 M5 集群以及无服务器实例。Atlas会自动将所有 M2 和 M5 集群迁移到 Flex 集群。对于无服务器实例， Atlas会根据您的使用情况决定将实例迁移到免费集群、Flex 集群还是专用集群，然后自动迁移您的无服务器实例。要查看Atlas会将您的实例迁移到哪些层级，请参阅Atlas用户界面中的“所有集群”页面。要学习；了解更多信息，请参阅Atlas文档中的 Flex 迁移指南。

  • 将对spec.serverlessSpec的引用替换为spec.FlexSpec的配置。

  • Atlas Kubernetes Operator拒绝定义新AtlasDeployment个spec.serverlessSpec的自定义资源。您只能使用 spec.serverlessSpec 来管理现有无服务器实例。

Atlas Kubernetes Operator 2.0 的重大更改

重要

Atlas Kubernetes Operator 2.0 破坏性变更 (breaking change)所需的操作

  • 在 Atlas Kubernetes Operator 2.0 中，deploymentSpec 取代了advancedDeploymentSpec AtlasDeployment自定义资源中的 。您必须按如下方式更新AtlasDeployment自定义资源：

    • 如果使用advancedDeploymentSpec ，请将其重命名为deploymentSpec 。 您无需更改任何格式。

    • 如果您在Atlas Kubernetes Operator 之前使用deploymentSpec2.0 ，请重写AtlasDeployment 自定义资源以匹配 示例中使用的格式。

  • Atlas Kubernetes Operator使用自定义资源配置文件来管理Atlas配置。 从Atlas Kubernetes Operator 2.0开始，您在Kubernetes中删除的自定义资源将不再在Atlas中删除。 相反， Atlas Kubernetes Operator停止管理这些资源。 示例，如果您在Kubernetes中删除AtlasProject自定义资源， Atlas Kubernetes Operator将不再自动从Atlas中删除相应的项目，从而防止意外删除。 要学习；了解详情，包括如何将此行为恢复为Atlas Kubernetes Operator 2之前使用的默认行为。 0 、 请参阅新默认值： Atlas Kubernetes Operator 2中的删除保护。 0 。

关于 AtlasDeployment 自定义资源

AtlasDeployment 自定义资源在Atlas中配置MongoDB 集群或 Flex集群。 当您创建 AtlasDeployment 自定义资源时， Atlas Kubernetes Operator会尝试在Atlas中创建或更新集群或 Flex集群。

Atlas Kubernetes Operator 根据您在AtlasDeployment自定义资源中指定的值执行以下操作之一：

注意

不要为 spec.serverlessSpec 下的字段指定值因为无服务器实例已弃用。相反，请在spec.FlexSpec下指定字段。要学习；了解更多信息，请参阅迁移到 Flex 集群。

创建免费套餐Atlas集群需要不到 15 秒。

创建或更新 Flex集群或专用集群最多可能需要 10 分钟。Atlas Kubernetes Operator监控更新进程。

您可以运行以下命令来检查状态：

kubectl get atlasdeployment -o yaml

以下示例显示了正在配置的集群的状态部分： 

status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "False"
    type: ClusterReady
    reason: ClusterCreating
    message: Cluster is provisioning

当集群或无服务器实例准备就绪时，ClusterReady 状态将更改为 True。

示例

状态示例

以下示例显示了ClusterReady状态为True的AtlasDeployment资源：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: US-Zone
        numShards: 3
        regionConfigs:
          - regionName: CENTRAL_US
            providerName: GCP
            backingProviderName: GCP
            priority: 7
            electableSpecs:
              instanceSize: M10
              nodeCount: 3
status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: Ready
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: ClusterReady
  connectionStrings:
    standard: mongodb://test-cluster-shard-00-00.kpc8f.mongodb.net:27017,test-cluster-shard-00-01.kpc8f.mongodb.net:27017,test-cluster-shard-00-02.kpc8f.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-1gm1pv-shard-0
    standardSrv: mongodb+srv://test-cluster.kpc8f.mongodb.net
  mongoDBVersion: 6.0
  mongoURIUpdated: "2024-03-12T12:21:41Z"
  observedGeneration: 1
  stateName: IDLE

配置示例

以下示例显示了为自动伸缩多区域集群配置的AtlasDeployment自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  deploymentSpec:
    clusterType: REPLICASET
    name: service-name
    tags:
    - key: "environment"
      value: "production"
    backupEnabled: true
    replicationSpecs:
      - numShards: 1
        regionConfigs:
         - regionName: EASTERN_US
           providerName: GCP
           autoScaling:
             diskGB:
               enabled: true
             compute:
               enabled: true
               scaleDownEnabled: true
               minInstanceSize: M30
               maxInstanceSize: M40
           analyticsSpecs:
             instanceSize: M30
             nodeCount: 1
           electableSpecs:
             instanceSize: M30
             nodeCount: 3
           priority: 7
           readOnlySpecs:
             instanceSize: M30
             nodeCount: 1

其他选项示例

以下示例显示了配置有一些附加选项的AtlasDeployment自定义资源规范。

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
         - electableSpecs:
             instanceSize: M10
             nodeCount: 3
           providerName: AWS
           regionName: US_EAST_1
           priority: 7
  processArgs:
    javascriptEnabled: false

Flex 集群示例

过渡到 Flex 集群的注意事项

  • 在 1 月 2026之前，为了在一段时间内保持向后兼容性， Atlas允许您通过无服务器实例和 Flex 集群 API管理迁移的集群，包括在使用Atlas Kubernetes Operator时。

  • 您可以在创建和托管无服务器实例以及 M2 和 M5 集群的同一 AtlasDeployment 中创建和管理Flex 集群。

  • 您无法在Atlas中创建 新的 M2/M5 集群和无服务器实例。尝试这样做会创建一个 Flex集群。

  • 即使现有的无服务器实例自 2 月初 2025起已弃用，您仍可在Atlas Kubernetes Operator中使用现有的无服务器实例。

  • 对于现有的无服务器实例，您可以选择将对 AtlasDeployment 中的 spec.serverlessSpec 的引用替换为 spec.FlexSpec 的配置。或者，您可以继续使用相同的规范。即使Atlas在 2025 3 月自动将这些现有集群迁移到 Flex 集群，通过 AtlasDeployment 自定义资源中的 spec.serverlessSpec 管理部署仍将继续有效。

  • 对于现有的 M2 和 M5 集群，您可以选择将对 AtlasDeployment 自定义资源中的 spec.deploymentSpec 的引用替换为 spec.flexSpec 的配置。或者，您可以继续使用相同的规范。即使Atlas于 2025 5 月自动将这些现有的 M2 和 M5 集群迁移到 Flex 集群，通过 AtlasDeployment 自定义资源中的 spec.deploymentSpec 管理部署仍将继续有效。

  • 对于现有无服务器实例，如果在协调期间收到与私有端点相关的错误，则必须升级到Atlas Kubernetes Operator 2.7.1，或将 serverlessSpec 配置替换为 AtlasDeployment 自定义资源中的 flexSpec 配置。

  • 对于 M2 和 M5 集群，为避免自动迁移后可能出现的协调错误，请对 CRD 配置进行以下更改：

    或者，将AtlasDeployment中对 spec.deploymentSpec 的引用替换为 spec.flexSpec 的配置。

  • 在 2026 1 月之前，您必须从Atlas Kubernetes Operator自定义资源中删除所有剩余的 M2/M5 和无服务器实例配置，因为 API 的向后兼容性将于 2026 1 月结束，届时旧 API 将被删除，并且仅 API与 Flex 集群相关的设置将保留。

  • 较新版本的Atlas Kubernetes Operator将停止支持现有的 M2/M5 集群和无服务器实例。旧版本的Atlas Kubernetes Operator将继续支持这些实例类型，直到 1 月 2026。

要学习；了解更多信息，请参阅本指南中的迁移到 Flex 集群以及Atlas文档中的 Flex 迁移指南。

以下示例显示了为 Flex集群配置的 AtlasDeployment 自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  flexSpec:
    name: flex-cluster
    tags:
      - key: "environment"
        value: "production"
    providerSettings:
      backingProviderName: AWS
      regionName: US_EAST_1

无服务器实例示例

注意

不要为 spec.serverlessSpec 下的字段指定值因为无服务器实例已弃用。相反，请在spec.FlexSpec下指定字段。要学习；了解更多信息，请参阅迁移到 Flex 集群。

以下示例显示了为无服务器实例配置的 AtlasDeployment 自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  serverlessSpec:
    name: serverless-instance
    tags:
    - key: "environment"
      value: "production"
    providerSettings:
      providerName: AWS
      regionName: US_EAST_1

多区域集群示例

集群可以跨区域和云服务提供商。 要了解更多信息，请参阅注意事项。

注意

Atlas集群 API 资源使用v1.5 Atlas API版本发送请求，而 Atlas Kubernetes Operator apiVersion字段使用v1 。 在本例中， v1指的是 Kubernetes API的版本。

以下示例显示了为多区域集群配置的AtlasDeployment自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
        priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1

多个云服务提供商示例

以下示例显示了配置为跨多个云服务提供商的AtlasDeployment自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - regionConfigs:
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1
          priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: AZURE
          regionName: US_EAST_2
          priority: 6
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: GCP
          regionName: CENTRAL_US
          priority: 5

Atlas Search索引示例

以下示例显示了配置为集合 listingsAndReviews 和 grades 创建Atlas Search索引的 AtlasDeployment 自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchIndexes:
    - DBName: sample_training
      collectionName: grades
      name: test-vector-search-index
      type: vectorSearch
      vectorSearch:
        fields:
        - numDimensions: 1000
          path: student_id
          similarity: euclidean
          type: vector
    - DBName: sample_airbnb
      collectionName: listingsAndReviews
      name: my-index
      search:
        mappings:
          dynamic: true
        searchConfigurationRef:
          name: atlassearchindexconfig-sample
          namespace: mongodb-atlas-system
      type: search
    terminationProtectionEnabled: false
  projectRef:
    name: my-project
    namespace: mongodb-atlas-system

Atlas Search节点示例

以下示例显示了配置用于创建Atlas Search节点的 AtlasDeployment 自定义资源规范：

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchNodes:
    - instanceSize: S20_HIGHCPU_NVME
      nodeCount: 2

参数

Atlas 部署

AtlasDeployment 是 atlasdeployments API的模式

Name
类型
说明
必需

apiVersion

字符串

atlas.mongodb.com/v1

true

kind

字符串

AtlasDeployment

true

metadata

对象

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。

true

spec

对象

AtlasDeploymentSpec 定义了 AtlasDeployment 的目标省。只应定义 DeploymentSpec、AdvancedDeploymentSpec 和 ServerlessSpec 之一。验证：

  • (has(self.``externalProjectRef``)&& !has(self.``projectRef``))|| (!has(self.``externalProjectRef``)&& has(self.``projectRef``)):只能通过 externalProjectRef 或 projectRef 定义一个项目引用

  • (has(self.``externalProjectRef``)&& has(self.``connectionSecret``))|| !has(self.``externalProjectRef``):引用外部项目时必须定义本地连接密钥

  • !has(self.``serverlessSpec``)|| (oldSelf.``hasValue``()&& oldSelf.value().``serverlessSpec``!= null): 无法添加 serverlessSpec —无服务器实例已弃用

false

status

对象

AtlasDeploymentStatus 定义了 AtlasDeployment 的观察到的状态。

false

AtlasDeployment.spec

AtlasDeploymentSpec 定义 AtlasDeployment 的目标省/市/自治区。只应定义 DeploymentSpec、AdvancedDeploymentSpec 和 ServerlessSpec 之一。

Name
类型
说明
必需

backupRef

对象

参考 AtlasDeployment 的备份安排。

false

connectionSecret

对象

包含Atlas API 私钥和公钥的密钥名称。

false

deploymentSpec

对象

高级 (v1.5)部署API https://www.mongodb.com/zh-cn/docs/atlas/reference/api/clusters/

false

externalProjectRef

对象

externalProjectRef 包含父Atlas项目ID。与“projectRef”字段互斥。

false

flexSpec

对象

Flex集群API 的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Flex-Clusters

false

processArgs

对象

ProcessArgs 允许修改高级配置选项。

false

projectRef

对象

projectRef 是对父 AtlasProject资源的引用。与“externalProjectRef”字段互斥。

false

serverlessSpec

对象

无服务器部署API 的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api/serverless-instances/DEPRECATED：无服务器实例已弃用。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。

false

upgradeToDedicated

布尔

upgradeToDedicated，当设立为 true 时，会触发从 Flex 集群到专用集群的迁移。用户 MUST 提供新的专用集群配置。如果集群已经是专用的，则忽略此标志。

false

AtlasDeployment.spec.backupRef

对 AtlasDeployment 的备份安排的参考。

Name
类型
说明
必需

name

字符串

Kubernetes资源名称

true

namespace

字符串

Kubernetes资源的命名空间

false

AtlasDeployment.spec.connectionSecret

包含Atlas API私钥和公钥的密钥名称。

Name
类型
说明
必需

name

字符串

所引用资源的名称更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

true

AtlasDeployment.spec.deploymentSpec

高级 (v1.5)部署 API https://www.mongodb.com/zh-cn/docs/atlas/reference/api/clusters/

Name
类型
说明
必需

name

字符串

Atlas中显示的高级部署的名称。Atlas创建部署后，您无法更改其名称。只能包含 ASCII 字母、数字和连字符。验证：

  • self == oldSelf：名称在创建部署后无法修改

true

backupEnabled

布尔

指示部署是否使用云备份进行备份的标志。仅适用于 M10``+ 部署。

false

biConnector

对象

在此部署上为Atlas配置 BI Connector。MongoDB Connector for Business Intelligence for Atlas （BI Connector）仅适用于 M10 和更大的部署。

false

clusterType

枚举

要创建的部署的类型。如果部署了replicationSpecs 或部署了全局部署，则该参数为必填项。枚举：REPLICASET、SHARDED、GEOSHARDED

false

configServerManagementMode

枚举

用于创建或更新分片集群的配置服务器管理模式。枚举：ATLAS_MANAGED、FIXED_TO_DEDICATED

false

customZoneMapping

[]对象

包含将区域映射到地理区域的Atlas全球集群参数的列表。

false

diskSizeGB

整型

托管根卷的容量（以 GB 为单位）。增加此数字可增加容量，最大可能值为 4096（即 4 TB）。此值必须是正整数。如果配置了 replicationSpecs，则该参数为必填项。最小值：0 最大值：4096

false

encryptionAtRestProvider

枚举

提供静态加密的云服务提供商。枚举：AWS、GCP、AZURE、NONE

false

labels

[]对象

用于标签和分类部署的键值对集合。每个键和值的最大长度为 255 个字符。DEPRECATED：集群 labels 已弃用，将在未来发布中删除。我们强烈建议您改用资源标签。

false

managedNamespaces

[]对象

列表，其中包含在要创建的指定Atlas全球集群中创建托管命名空间的信息。

false

mongoDBMajorVersion

字符串

MongoDB 集群的主要版本。设置为二进制主要版本。

false

mongoDBVersion

字符串

集群运行的 MongoDB 版本。

false

paused

布尔

指示部署是否应暂停的标志。

false

pitEnabled

布尔

指示部署使用连续云备份的标志。

false

replicationSpecs

[]对象

部署区域的配置。

false

rootCertType

字符串

MongoDB Atlas 集群使用的根证书颁发机构。

false

searchIndexes

[]对象

SearchIndex 个对象的数组，其中包含描述搜索索引的字段。

false

searchNodes

[]对象

集群搜索节点的设置。目前，最多可以定义一个搜索节点配置。

false

tags

[]对象

用于资源标签的键值对。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 true，MongoDB 云将不会删除集群。如果设立为 false，MongoDB 云将删除集群。默认：false

false

versionReleaseSystem

字符串

集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

false

AtlasDeployment.spec.deploymentSpec.biConnector

在此部署上配置BI Connector for Atlas 。MongoDB Connector for Business Intelligence for Atlas (BI Connector) 仅适用于 M10 和更大的部署。

Name
类型
说明
必需

enabled

布尔

指示 Business Intelligence Connector for Atlas 在部署上是否为 enabled 的标志。

false

readPreference

字符串

BI Connector for Atlas读取数据的源。每个 BI Connector for Atlas读取偏好（read preference）都包含 readPreference 和 readPreferenceTags 选项的不同组合。

false

AtlasDeployment.spec.deploymentSpec.customZoneMapping

Name
类型
说明
必需

location

字符串

表示映射到Atlas全球集群中区域的 location 的代码。MongoDB Atlas表示此 location 为 ISO 3166-2 location 和细分代码（如果可能）。

true

zone

字符串

人类可读标签，用于标识Atlas全球集群中的 zone。此 zone 映射到位置代码。

true

AtlasDeployment.spec.deploymentSpec.labels

LabelSpec 包含用于标签和分类 集群/DBUser 的键值对

Name
类型
说明
必需

key

字符串

用于标签和分类该组件的键。

true

value

字符串

设立为用于标签和分类该组件的键的值。

true

AtlasDeployment.spec.deploymentSpec.managedNamespaces

ManagedNamespace 表示有关托管命名空间配置的信息。

Name
类型
说明
必需

collection

字符串

用于管理此 Atlas全球集群 的 collection 的人类可读标签。

true

db

字符串

用于管理此全局集群的数据库的人工可读标签。

true

customShardKey

字符串

用于将集合划分为分片的数据库参数。全局集群需要复合分片键。此复合分片键将位置参数和用户选择的自定义键组合在一起。

false

isCustomShardKeyHashed

布尔

指示是否有人对指定集合的自定义分片键进行了哈希的标志。如果将此值设立为 false，MongoDB 云将使用范围分片。

false

isShardKeyUnique

布尔

指示是否有人对自定义分片键哈希的标志。如果该参数返回 false，则该集群使用范围 分片。

false

numInitialChunks

整型

使用哈希分片键对空集合进行分片时，最初创建的最小数据块数。最大值为 8192。

false

presplitHashedZones

布尔

该标志指示 MongoDB 云是否应为空或不存在的集合创建和分发初始数据块。MongoDB 云根据为集合定义的区域和区域范围来分发数据。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs

Name
类型
说明
必需

numShards

整型

正整数，用于指定要在每个指定区域中部署的分片数量。如果将此值设立为 1 且 clusterType 为 SHARDED，则 MongoDB Cloud 会部署单分片的分片集群。不要为生产环境创建具有单个分片的分片集群。单分片的分片的集群无法提供与多分片配置相同的优势

false

regionConfigs

[]对象

为给定区域设立的节点的硬件规格。每个 regionConfigs对象都描述了该区域在选举中的优先级以及 MongoDB Cloud 部署到该地区的 MongoDB 节点的数量和类型。每个 regionConfigs对象必须有一个 analyticsSpecs对象、electableSpecs对象或 readOnlySpecs对象。租户集群仅需要 electableSpecs。专用集群可以指定任何这些规范，但必须在 replicationSpec 中至少有一个 electableSpecs对象。每个硬件规范必须使用相同的 instanceSize。

false

zoneName

字符串

人类可读标签，用于标识Atlas全球集群中的区域。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs

Name
类型
说明
必需

analyticsSpecs

对象

该区域中部署的分析节点的硬件规格。

false

autoScaling

对象

确定此集群如何处理资源扩展的选项。

false

backingProviderName

枚举

为多租户部署预配托管的云服务提供商。此设置仅在以下情况下有效： "providerName" : "TENANT" and "providerSetting.``instanceSizeName``"：M2 或 M5。否则，它应等于“providerName”值。枚举：AWS、GCP、AZURE

false

electableSpecs

对象

该地区中部署的节点的硬件规格。

false

priority

整型

进行主节点 (primary node in the replica set)选举时，该区域优先。如果您的 regionConfigs 仅具有 readOnlySpecs、analyticsSpecs 或两者，请将此值设立为 0。如果您有多个 regionConfigs 对象（您的集群是多区域或多云），则它们的优先级必须按降序排列。最高的 priority 为 7

false

providerName

枚举

Enum: AWS, GCP, AZURE, TENANT, SERVERLESS

false

readOnlySpecs

对象

该区域中部署的只读节点的硬件规格。

false

regionName

字符串

MongoDB部署的物理位置。您选择的区域可能会影响客户端访问数据库的网络延迟。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.analyticsSpecs

该区域中部署的分析节点的硬件规格。

Name
类型
说明
必需

diskIOPS

整型

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。格式：int64

false

ebsVolumeType

枚举

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。枚举：STANDARD、PROVISIONED

false

instanceSize

字符串

此区域中实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。您选择的实例大小会应用于实例大小内的所有数据承载托管。

false

nodeCount

整型

MongoDB Cloud 要部署到该地区的给定类型的节点数。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling

确定此集群如何处理资源扩展的选项。

Name
类型
说明
必需

compute

对象

设置集合，用于配置部署如何扩展其部署层级以及部署是否可以扩展。

false

diskGB

对象

指示是否启用磁盘自动伸缩的标志。默认为 true。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute

设置集合，用于配置部署如何扩展其部署层级以及部署是否可以扩展。

Name
类型
说明
必需

enabled

布尔

指示是否启用部署层级自动伸缩的标志。默认为 false。

false

maxInstanceSize

字符串

部署可自动扩展的最大实例大小（例如 M40）。Atlas"autoScaling.compute.enabled"：true。

false

minInstanceSize

字符串

部署可以自动扩展到的最小实例大小（例如 M10）。Atlas需要此参数，条件是 "autoScaling.compute.``scaleDownEnabled``"：true。

false

scaleDownEnabled

布尔

指示部署层级是否可以扩展的标志。Atlas"autoScaling.compute.enabled"：true。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB

指示是否启用磁盘自动伸缩的标志。默认为 true。

Name
类型
说明
必需

enabled

布尔

指示此集群是否启用磁盘自动伸缩的标志。 所选集群层允许的最大内存和oplog大小会限制存储的自动伸缩。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs

该地区中部署的节点的硬件规格。

Name
类型
说明
必需

diskIOPS

整型

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。格式：int64

false

ebsVolumeType

枚举

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。枚举：STANDARD、PROVISIONED

false

instanceSize

字符串

此区域中实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。您选择的实例大小会应用于实例大小内的所有数据承载托管。

false

nodeCount

整型

MongoDB Cloud 要部署到该地区的给定类型的节点数。

false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.readOnlySpecs

该区域中部署的只读节点的硬件规格。

Name
类型
说明
必需

diskIOPS

整型

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。格式：int64

false

ebsVolumeType

枚举

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。枚举：STANDARD、PROVISIONED

false

instanceSize

字符串

此区域中实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。您选择的实例大小会应用于实例大小内的所有数据承载托管。

false

nodeCount

整型

MongoDB Cloud 要部署到该地区的给定类型的节点数。

false

AtlasDeployment.spec.deploymentSpec.searchIndexes

SearchIndex 是用于配置 Atlas Search 索引一部分的 CRD。

Name
类型
说明
必需

DBName

字符串

人类可读标签，用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库。

true

collectionName

字符串

可读标签，用于标识包含一个或多个 Atlas Search 索引的集合。

true

name

字符串

标识此索引的人类可读标签。 对于部署必须是唯一的。

true

type

枚举

索引的类型。枚举： 搜索, vectorSearch

true

search

对象

Atlas search索引配置。

false

vectorSearch

对象

Atlas 向量搜索索引配置。

false

AtlasDeployment.spec.deploymentSpec.searchIndexes。搜索

Atlas搜索索引配置。

Name
类型
说明
必需

mappings

对象

集合的字段的索引规范。

true

searchConfigurationRef

对象

对 AtlasSearchIndexConfig 自定义资源的引用。

true

synonyms

[]对象

将单词映射到该索引中对应 synonyms 的规则集。

false

AtlasDeployment.spec.deploymentSpec.searchIndexes。 搜索.mappings

集合的字段的索引规范。

Name
类型
说明
必需

dynamic

JSON

指示索引是使用静态、默认动态还是可配置的 dynamic 映射。设置为true启用具有默认类型设立的dynamic 映射，或定义对象以指定为 dynamic 映射配置的类型集的名称。如果您指定可配置的 dynamic 映射，则必须在 ``typeSets`` 字段中定义引用的类型集。设置为 false 以仅使用通过 mappings.字段 的静态映射。

false

fields

JSON

Atlas Search索引的一个或多个字段规范。如果省略 mapping.dynamic 或设立为 false，则为必填项。

false

AtlasDeployment.spec.deploymentSpec.searchIndexes。 搜索

对 AtlasSearchIndexConfig 自定义资源的引用。

Name
类型
说明
必需

name

字符串

Kubernetes资源名称

true

namespace

字符串

Kubernetes资源的命名空间

false

AtlasDeployment.spec.deploymentSpec.searchIndexes。 搜索.synonyms

Synonym 表示 Atlas Search 索引的“同义词”类型。

Name
类型
说明
必需

analyzer

枚举

选择应用要搜索的同义词的特定预定义方法。枚举：lucene.standard，lucene.simple,lucene.whitespace,lucene.keyword,lucene.arabic,lucene.armenian,lucene.basque,lucene.bengali,lucene.brazilian,lucene.bulgarian,lucene.catalan,lucene.chinese,lucene.cjk,lucene.czech,lucene.danish,lucene.dutch,lucene.english,lucene.finnish,lucene.french,lucene.galician,lucene.german,lucene.greek,lucene.hindi,lucene.hungarian,lucene.indonesian,lucene.irish,lucene.italian,lucene.japanese,lucene.korean,lucene.kuromoji,lucene.latvian,lucene.lithuanian,lucene.morfologik,lucene.nori，lucene.norwegian,lucene.persian,lucene.portuguese,lucene.romanian,lucene. Russian,lucene.smartcn,lucene.sorani,lucene.spanish,lucene.swedish,lucene.thai,lucene.turkish,lucene.ukrainian

true

name

字符串

标识同义词定义的人类可读标签。在同一索引定义中，每个 name 必须是唯一的。

true

source

对象

存储一个或多个单词到一个或多个同义词的映射关系的数据设立。

true

AtlasDeployment.spec.deploymentSpec.searchIndexes。 搜索.synonyms.source

存储一个或多个单词到一个或多个同义词的映射关系的数据设立。

Name
类型
说明
必需

collection

字符串

人类可读标签，用于标识存储单词及其适用同义词的 MongoDB collection。

true

AtlasDeployment.spec.deploymentSpec.searchIndexes.vectorSearch

Atlas 向量搜索索引配置。

Name
类型
说明
必需

fields

JSON

JSON 对象的数组。请参阅示例 https://dochub.mongodb.org/core/avs-vector-type

true

AtlasDeployment.spec.deploymentSpec.searchNodes

Name
类型
说明
必需

instanceSize

枚举

搜索节点实例大小的硬件规格。枚举：S20_HIGHCPU_NVME、S30_HIGHCPU_NVME、S40_HIGHCPU_NVME、S50_HIGHCPU_NVME、S60_HIGHCPU_NVME、S70_HIGHCPU_NVME、S80_HIGHCPU_NVME、S30_LOWCPU_NVME、S40_LOWCPU_NVME、S50_LOWCPU_NVME、S60_LOWCPU_NVME、S80_LOWCPU_NVME、S90_LOWCPU_NVME、S100_LOWCPU_NVME、S110_LOWCPU_NVME

false

nodeCount

整型

集群中的搜索节点数。最小值：2 最大值：32

false

AtlasDeployment.spec.deploymentSpec.标签

TagSpec 包含用于此部署上的资源标签的键值对。

Name
类型
说明
必需

key

字符串

定义标签设立的常量。

true

value

字符串

属于该标签设立的变量。

true

AtlasDeployment.spec.externalProjectRef

externalProjectRef 保存父Atlas群组 ID（group ID）。与 "projectRef"字段互斥。

Name
类型
说明
必需

id

字符串

ID 是Atlas项目ID。

true

AtlasDeployment.spec.FlexSpec

Flex集群API的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Flex-Clusters

Name
类型
说明
必需

name

字符串

用于标识实例的人类可读标签。

true

providerSettings

对象

用于配置预配的 MongoDB 弹性集群的云提供商设置群组。

true

tags

[]对象

包含长度在 1 到 255 个字符之间的键值对的列表，用于对实例进行标签和分类。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 true，MongoDB 云将不会删除集群。如果设立为 false，MongoDB 云将删除集群。默认：false

false

AtlasDeployment.spec.FlexSpec.providerSettings

配置预配的 MongoDB 弹性集群的云提供商设置群组。

Name
类型
说明
必需

backingProviderName

枚举

MongoDB Atlas预配弹性集群的云服务提供商。验证：

  • self == oldSelf：创建集群后无法修改提供商

Enum: AWS, GCP, AZURE

true

regionName

字符串

人类可读标签，用于标识 MongoDB Flex集群的位置。您选择的区域可能会影响客户端访问数据库的网络延迟。验证：

  • self == oldSelf：创建集群后无法修改区域名称

true

AtlasDeployment.spec.FlexSpec.标签

TagSpec 包含用于此部署上的资源标签的键值对。

Name
类型
说明
必需

key

字符串

定义标签设立的常量。

true

value

字符串

属于该标签设立的变量。

true

AtlasDeployment.spec.processArgs

ProcessArgs 允许修改高级配置选项。

Name
类型
说明
必需

defaultReadConcern

字符串

字符串，表示为此集群设立的读操作从 MongoDB 请求的默认确认级别。

false

defaultWriteConcern

字符串

String，表示为此集群设立的写入操作从 MongoDB 请求的默认确认级别。

false

failIndexKeyTooLong

布尔

标志，用于指示在插入或更新所有索引项都超过 1024 字节的文档时是否使操作失败并返回错误。如果将其设立为 false，mongod会写入超过此限制的文档，但不会对其索引。

false

javascriptEnabled

布尔

指示集群是否允许执行在服务器端进行的 JavaScript 操作的标志。

false

minimumEnabledTlsProtocol

字符串

字符串，表示集群接受的传入连接的最低 TLS 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS协议版本。

false

noTableScan

布尔

该标志指示集群是否禁用执行需要集合扫描才能返回结果的查询。

false

oplogMinRetentionHours

字符串

集群oplog的最小保留窗口以小时为单位。null 值表示集群使用 MongoDB 云 计算的默认最小oplog window。

false

oplogSizeMB

整型

指示集群oplog存储限制的数字，以兆字节为单位。null 值表示集群使用Atlas计算的默认oplog大小。格式：int64

false

sampleRefreshIntervalBIConnector

整型

数字，表示收集模式信息时要示例的每个数据库的文档数量。格式：int64

false

sampleSizeBIConnector

整型

数字，表示 mongosqld 进程重新示例数据以创建其关系模式的时间间隔（以秒为单位）。格式：int64

false

AtlasDeployment.spec.projectRef

projectRef 是对父 AtlasProject资源的引用。与 "externalProjectRef"字段互斥。

Name
类型
说明
必需

name

字符串

Kubernetes资源名称

true

namespace

字符串

Kubernetes资源的命名空间

false

AtlasDeployment.spec.serverlessSpec

无服务器部署API的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api/serverless-instances/已弃用：无服务器实例已弃用。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。

Name
类型
说明
必需

name

字符串

Atlas中显示的无服务器部署的名称。Atlas创建部署后，您无法更改其名称。只能包含 ASCII 字母、数字和连字符。

true

providerSettings

对象

运行 MongoDB 的已预配托管的配置。可用选项特定于云服务提供商。

true

backupOptions

对象

serverlessBackupOptions

false

privateEndpoints

[]对象

包含无服务器实例的私有端点配置的列表。DEPRECATED：无服务器私有端点已弃用。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。

false

tags

[]对象

用于资源标签的键值对。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 true，MongoDB 云将不会删除集群。如果设立为 false，MongoDB 云将删除集群。默认：false

false

AtlasDeployment.spec.serverlessSpec.providerSettings

预配的托管上运行的 MongoDB 的配置。可用选项特定于云服务提供商。

Name
类型
说明
必需

providerName

枚举

Atlas在其上预配托管的云服务提供商。枚举：AWS、GCP、AZURE、TENANT、SERVERLESS

true

autoScaling

对象

部署可扩展的实例大小范围。DEPRECATED：该字段的值没有任何作用。

false

backingProviderName

枚举

为多租户部署预配托管的云服务提供商。此设置仅在 "providerSetting.``providerName``"："TENANT" 和 "providerSetting.``instanceSizeName``"：M2 或 M5。枚举：AWS、GCP、AZURE

false

diskIOPS

整型

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。DEPRECATED：该字段的值没有任何作用。格式：int64

false

diskTypeName

字符串

磁盘类型（如果选择Azure作为云服务提供商）。DEPRECATED：该字段的值没有任何作用。

false

encryptEBSVolume

布尔

指示Amazon EBS加密功能是否会针对卷内的静态数据以及在卷与部署之间移动的数据对托管的根卷进行加密的标志。DEPRECATED：该字段的值没有任何作用。

false

instanceSizeName

字符串

Atlas提供不同的部署层级，每个部署层级都有默认的存储容量和 RAM 大小。您选择的部署将用于部署层级中的所有数据承载托管。DEPRECATED：该字段的值没有任何作用。

false

regionName

字符串

MongoDB部署的物理位置。您选择的区域可能会影响客户端访问数据库的网络延迟。

false

volumeType

枚举

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。DEPRECATED：该字段的值没有任何作用。枚举：STANDARD、PROVISIONED

false

AtlasDeployment.spec.serverlessSpec.providerSettings.autoScaling

部署可扩展的实例大小范围。已弃用：此字段的值不起作用。

Name
类型
说明
必需

autoIndexingEnabled

布尔

指示是否启用Performance Advisor的模式的标志。默认为 false。DEPRECATED：不再支持此标志。

false

compute

对象

设置集合，用于配置部署如何扩展其部署层级以及部署是否可以扩展。

false

diskGBEnabled

布尔

指示是否启用磁盘自动伸缩的标志。默认为 true。

false

AtlasDeployment.spec.serverlessSpec.providerSettings.autoScaling.compute

设置集合，用于配置部署如何扩展其部署层级以及部署是否可以扩展。

Name
类型
说明
必需

enabled

布尔

指示是否启用部署层级自动伸缩的标志。默认为 false。

false

maxInstanceSize

字符串

部署可自动扩展的最大实例大小（例如 M40）。Atlas"autoScaling.compute.enabled"：true。

false

minInstanceSize

字符串

部署可以自动扩展到的最小实例大小（例如 M10）。Atlas需要此参数，条件是 "autoScaling.compute.``scaleDownEnabled``"：true。

false

scaleDownEnabled

布尔

指示部署层级是否可以扩展的标志。Atlas"autoScaling.compute.enabled"：true。

false

AtlasDeployment.spec.serverlessSpec.backupOptions

serverlessBackupOptions

Name
类型
说明
必需

serverlessContinuousBackupEnabled

布尔

ServerlessContinuousBackupEnabled 指示集群是否使用连续云备份。DEPRECATED：无服务器实例已弃用，不再支持连续备份。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。默认：true

false

AtlasDeployment.spec.serverlessSpec.privateEndpoints

ServerlessPrivateEndpoint 为无服务器实例配置私有端点。已弃用：无服务器私有端点已弃用。请参阅 https://dochub.mongodb.org/core/atlas-flex-migration 了解详细信息。

Name
类型
说明
必需

cloudProviderEndpointID

字符串

CloudProviderEndpointID 是云提供商终结点的标识符。

false

name

字符串

名称是无服务器 PrivateLink 服务的 name。应该是唯一的。

false

privateEndpointIpAddress

字符串

PrivateEndpointIPAddress 是有人添加到此私有端点服务的 Azure VNet 中私有端点的 IPv4地址。

false

AtlasDeployment.spec.serverlessSpec.标签

TagSpec 包含用于此部署上的资源标签的键值对。

Name
类型
说明
必需

key

字符串

定义标签设立的常量。

true

value

字符串

属于该标签设立的变量。

true

AtlasDeployment.status

AtlasDeploymentStatus 定义了观察到的 AtlasDeployment 省/市/自治区。

Name
类型
说明
必需

conditions

[]对象

条件是显示Atlas自定义资源当前省/市/自治区的列表

true

connectionStrings

对象

ConnectionStrings 是应用程序用于连接到此集群的**一组**连接字符串。

false

customZoneMapping

对象

列表，其中包含用于将区域映射到区域的键值对。这些对将 ISO 3166-1a2位置代码（尽可能包含 ISO 3166-2 细分代码）映射到唯一的 24-十六进制字符串，该字符串标识自定义区域。

false

managedNamespaces

[]对象

包含Atlas全球集群命名空间的列表。MongoDB Atlas托管此集群。

false

mongoDBVersion

字符串

MongoDBVersion 是集群运行的 MongoDB 版本，格式为 。格式。

false

mongoURIUpdated

字符串

MongoURIUpdated 是上次更新连接字符串时采用 ISO 8601 日期和时间格式（以 UTC 表示）的时间戳。如果更新任何其他值，连接字符串也会更改。

false

observedGeneration

整型

ObservedGeneration 表示 Atlas 操作符 感知的资源规范的生成。Atlas Operator 将此字段更新为“元数据.Generation ”的值一旦开始资源协调。格式：int64

false

replicaSets

[]对象

说明 MongoDB 云如何在指定的 MongoDB数据库上复制数据的详细信息。该数组中每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个表示节点配置的对象。

false

searchIndexes

[]对象

SearchIndexes 包含为项目配置的搜索索引状态列表。

false

serverlessPrivateEndpoints

[]对象

ServerlessPrivateEndpoints 包含为无服务器部署配置的私有端点列表。

false

stateName

字符串

StateName 是集群的当前省/市/自治区。可能的省有：IDLE、CREATING、UPDATING、DELETING、DELETED、REPAIRING

false

AtlasDeployment.status.conditions

条件描述了Atlas自定义资源在某一点的省/市/自治区。

Name
类型
说明
必需

status

字符串

条件的状态； True、False、未知之一。

true

type

字符串

Atlas自定义资源条件的类型。

true

lastTransitionTime

字符串

上次条件从一种状态转换为另一种状态的时间。以 ISO 8601 格式表示。格式：日期-时间

false

message

字符串

提供有关转换的详细信息的 message。

false

reason

字符串

条件的最后一次转换的 reason。

false

AtlasDeployment.status.connectionStrings

ConnectionStrings 是应用程序用于连接到此集群的一设立连接字符串。

Name
类型
说明
必需

private

字符串

Network-peering-endpoint-aware mongodb:// 配置为连接到此集群的每个接口 VPC 端点的连接字符串。仅当您创建了与此集群的网络对等连接时，Atlas才会返回此参数。

false

privateEndpoint

[]对象

私有端点连接字符串。每个对象都描述了可用于通过私有端点连接到此集群的连接字符串。仅当您将私有端点部署到部署此集群节点的所有区域时，Atlas才会返回此参数。

false

privateSrv

字符串

Network-peering-endpoint-aware mongodb+srv:// 配置为连接到此集群的每个接口 VPC 端点的连接字符串。仅当您创建了与此集群的网络对等连接时，Atlas才会返回此参数。如果您的驱动程序支持，请使用此 URI 格式。如果没有，则使用 connectionStrings.private。

false

standard

字符串

Public mongodb:// 此集群的连接字符串。

false

standardSrv

字符串

公共 mongodb+srv:// 此集群的连接字符串。

false

AtlasDeployment.status.connectionStrings.privateEndpoint

PrivateEndpoint 连接字符串。每个对象都描述了可用于通过私有端点连接到此集群的连接字符串。仅当您将私有端点部署到部署此集群节点的所有区域时，Atlas才会返回此参数。

Name
类型
说明
必需

connectionString

字符串

Private-endpoint-aware mongodb:// 此私有端点连接字符串。

false

endpoints

[]对象

私有端点，当您使用 connectionStrings.``privateEndpoint``[n].``connectionString`` 或 connectionStrings.``privateEndpoint``[n].``srvConnectionString`` 时，通过该端点连接到Atlas 。

false

srvConnectionString

字符串

Private-endpoint-aware mongodb+srv:// 此私有端点的连接字符串。

false

srvShardOptimizedConnectionString

字符串

针对使用 mongodb+srv://协议通过私有端点连接到 MongoDB 云的分片集群进行了优化的私有端点感知连接字符串。

false

type

字符串

使用Atlas返回的连接字符串连接到的 MongoDB 进程的类型：• MONGOD 表示副本集，或 • MONGOS 分片集群

false

AtlasDeployment.status.connectionStrings.privateEndpoint.终结点

连接Atlas的终结点

Name
类型
说明
必需

endpointId

字符串

私有端点的唯一标识符。

false

ip

字符串

在Azure VNet 中创建的私有端点网络接口的私有 IP解决。

false

providerName

字符串

部署私有端点的云提供商。Atlas返回 AWS 或 AZURE。

false

region

字符串

部署私有端点的区域。

false

AtlasDeployment.status.customZoneMapping

列表，其中包含用于将区域映射到区域的键值对。这些对将 ISO 3166-1a2位置代码（尽可能包含 ISO 3166-2 细分代码）映射到标识自定义区域的唯一 24-十六进制字符串。

Name
类型
说明
必需

customZoneMapping

map[string]string

列表，其中包含用于将区域映射到区域的键值对。这些对将 ISO 3166-1a2位置代码（尽可能包含 ISO 3166-2 细分代码）映射到唯一的 24-十六进制字符串，该字符串标识自定义区域。

false

zoneMappingErrMessage

字符串

自定义区域映射失败的错误消息。

false

zoneMappingState

字符串

自定义区域映射的状态。

false

AtlasDeployment.status.managedNamespaces

Name
类型
说明
必需

collection

字符串

用于管理此 Atlas全球集群 的 collection 的人类可读标签。

true

db

字符串

用于管理此全局集群的数据库的人工可读标签。

true

customShardKey

字符串

用于将集合划分为分片的数据库参数。全局集群需要复合分片键。此复合分片键将位置参数和用户选择的自定义键组合在一起。

false

errMessage

字符串

托管命名空间失败的错误消息。

false

isCustomShardKeyHashed

布尔

指示是否有人对指定集合的自定义分片键进行了哈希的标志。如果将此值设立为 false，MongoDB Atlas将使用范围分片。

false

isShardKeyUnique

布尔

指示是否有人对自定义分片键哈希的标志。如果该参数返回 false，则该集群使用范围 分片。

false

numInitialChunks

整型

指定使用哈希分片键对空集合进行分片时最初创建的最小数据块数。

false

presplitHashedZones

布尔

该标志指示 MongoDB 云是否应为空或不存在的集合创建和分发初始数据块。MongoDB Atlas根据集合的定义区域和区域范围来分发数据。

false

status

字符串

托管命名空间的状态。

false

AtlasDeployment.status.replicaSets

Name
类型
说明
必需

id

字符串

唯一的 24-十六进制数字string，用于标识集群分片的复制对象。

true

zoneName

字符串

人类可读标签，描述此分片在Atlas全球集群中所属的区域。

false

AtlasDeployment.status.searchIndexes

Name
类型
说明
必需

ID

字符串

标识此Atlas Search索引的唯一 24-十六进制数字字符串。

true

message

字符串

有关搜索索引状态的详细信息。

true

name

字符串

用于标识该索引的人类可读标签。

true

status

字符串

搜索索引的条件。

true

AtlasDeployment.status.serverlessPrivateEndpoints

Name
类型
说明
必需

_id

字符串

ID 是无服务器 PrivateLink 服务的标识符。

false

cloudProviderEndpointId

字符串

CloudProviderEndpointID 是云提供商终结点的标识符。

false

endpointServiceName

字符串

EndpointServiceName 是 AWS 中 PrivateLink 终结点服务的名称。创建终结点服务时返回 null。

false

errorMessage

字符串

ErrorMessage 是无服务器 PrivateLink 服务创建或连接失败时的错误消息。

false

name

字符串

名称是无服务器 PrivateLink 服务的 name。应该是唯一的。

false

privateEndpointIpAddress

字符串

PrivateEndpointIPAddress 是有人添加到此私有端点服务的 Azure VNet 中私有端点的 IPv4地址。

false

privateLinkServiceResourceId

字符串

PrivateLinkServiceResourceID 是根目录相对路径，用于标识 MongoDB 云 托管的 Azure Private Link 服务。MongoDB 云在创建终结点服务时返回 null。

false

providerName

字符串

ProviderName 是人类可读标签，用于标识云提供商。值包括 AWS 或 AZURE。

false

status

字符串

AWS无服务器 PrivateLink 连接的状态。

false

后退

Atlas 项目

来年

AtlasDatabaseUser

在此页面上