Docs 菜单
Docs 主页
/ /

Cluster 自定义资源

一个集群,由MongoDB Kubernetes Atlas Operator托管。

Name
类型
说明
必需

apiVersion

字符串

atlas.生成.mongodb.com/v1

true

kind

字符串

集群

true

metadata

对象

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

true

spec

对象

支持以下版本的集群规范:

  • v20250312

spec最多可以指定一个版本化的 。更多信息: https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status 验证:

  • (has(self.v20250312.``groupId``) && has(self.``connectionSecretRef``)) || (!has(self.v20250312.``groupId``)):如果设立了spec.v20250312.``groupId``,则必须设立spec.``connectionSecretRef``。

false

status

对象

false

支持以下版本的集群规范:

  • v20250312

最多可以指定一个版本化规范。更多信息:https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
类型
说明
必需

connectionSecretRef

对象

SENSITIVE FIELD 引用包含用于设置与Atlas的连接的凭证的密钥。

false

v20250312

对象

版本 v20250312 的集群资源规范。验证:

  • (has(self.``groupId``) && !has(self.``groupRef``)) || (!has(self.``groupId``) && has(self.``groupRef``)):groupIdgroupRef 是互斥的;只能设立其中之一

false

敏感领域

引用包含用于设置与Atlas的连接的凭证的密钥。

Name
类型
说明
必需

name

字符串

包含Atlas凭证的密钥名称。

false

版本 v20250312 的集群资源规范。

Name
类型
说明
必需

entry

对象

集群资源规范的 entry 字段。可以设立这些字段以创建和更新集群。

false

groupId

字符串

用于标识项目的唯一 24-十六进制数字字符串。使用 /groups 端点检索经过身份验证的用户访问权限检索的所有项目。

注意

注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的终结点使用“群组”一词。

验证:

  • self == oldSelfgroupId 创建后无法修改

false

groupRef

对象

对“群组”资源的引用。 "$.status.v20250312.id" 的值将用于设立"groupId"。与“groupId”属性互斥。

false

集群资源规范的条目字段。可以设立这些字段以创建和更新集群。

Name
类型
说明
必需

acceptDataRisksAndForceReplicaSetReconfig

字符串

如果由于区域中断而需要重新配置以重新获得主节点 (primary node in the replica set),请将此字段与拓扑结构重新配置一起提交,以请求新的区域抗中断拓扑结构。如果复制的写入(甚至多数提交的写入)尚未复制到新的主节点 (primary node in the replica set)节点,则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。 MongoDB Atlas文档包含更多信息。要继续执行存在该风险的操作,请将 acceptDataRisksAndForceReplicaSetReconfig设立为当前日期。此参数以 UTC 中的 ISO 8601 时间戳格式表示其值。

false

advancedConfiguration

对象

配置高级配置详细信息子集的设置组。

false

backupEnabled

布尔

指示集群是否可以执行备份的标志。如果设立为true ,则集群可以执行备份。对于true NVMe 集群,必须将此值设立为 。备份对专用集群使用云备份,对租户集群使用共享集群备份。如果设立为false ,则集群不使用备份。

false

biConnector

对象

为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

false

clusterType

字符串

组成该集群的节点的配置。

false

configServerManagementMode

字符串

用于创建或更新分片集群的配置服务器管理模式。当配置为 ATLAS_MANAGED 时, Atlas可能会自动切换集群的配置服务器类型,以获得最佳性能并节省成本。当配置为 FIXED_TO_DEDICATED 时,集群将始终使用专用的配置服务器。

false

configServerType

字符串

描述分片集群的配置服务器类型。

false

diskWarmingMode

字符串

磁盘预热模式选择

false

encryptionAtRestProvider

字符串

管理客户密钥以便为集群提供额外的静态加密层的云服务提供商。要启用客户密钥管理以进行静态加密,集群replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高,并且 "backupEnabled" : false 或完全省略。

false

globalClusterSelfManagedSharding

布尔

设置该字段,用于在创建新的全球集群时配置分片管理模式。 当设置为 false 时,管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片,旨在提供无缝部署体验。 当设置为真时,管理模式设置为自管理分片。此模式将分片的管理权交给您,旨在提供先进、灵活的部署体验。 一旦集群部署完毕,此设置就无法更改。

false

labels

[]对象

长度介于 1 到 255 个字符之间的键值对集合,用于对集群进行标签和分类。 MongoDB Cloud 控制台不显示您的标签。集群 labels 已弃用,并将在未来发布中删除。我们强烈建议您改用资源标签。

false

mongoDBEmployeeAccessGrant

对象

MongoDB 授予员工的集群访问权限级别和过期时间。

false

mongoDBMajorVersion

字符串

MongoDB 集群的主要版本。设置为二进制主要版本。创建时:从可用的 MongoDB 版本中进行选择,或者不指定,使用 MongoDB Cloud 平台中当前建议的默认。推荐的版本是最近的长期支持版本。不保证默认是整个发布周期中最新发布的版本。有关特定项目中可用的版本,请参阅链接的文档或使用 project LTS versions endpointAPI 端点。更新时:一次只能将版本增加 1 个主要版本。如果集群固定为比当前 MongoDB 版本低一个主要版本的 MongoDB特征兼容性版本,则 MongoDB 版本可以降级到之前的主要版本。

false

name

字符串

用于标识集群的人类可读标签。

false

paused

布尔

指示集群是否已暂停的标志。

false

pitEnabled

布尔

指示集群是否使用连续云备份的标志。

false

redactClientLogData

布尔

启用或禁用日志校订。此设置将mongodmongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。将redactClientLogData 与静态加密和TLS /SSL (传输加密)结合使用,以帮助合规监管要求。注意:在集群上更改此设置将在集群更新后触发滚动重启。

false

replicaSetScalingStrategy

字符串

设置此字段可为集群配置副本集扩展模式。默认下, Atlas 的扩展规模低于 WORKLOAD_TYPE。此模式允许Atlas并行扩展分析节点与操作节点。配置为 SEQUENTIAL 时, Atlas会按顺序扩展所有节点。此模式适用于稳定状态的工作负载和执行对延迟敏感的从节点(secondary node from replica set)读取的应用程序。配置为 NODE_TYPE 时, Atlas会与只读节点和分析节点并行扩展可选举节点。此模式适用于需要频繁且及时地进行集群层扩展的大型动态工作负载。这是最快的扩展策略,但在执行大量从节点(secondary node from replica set)读取时,可能会影响工作负载的延迟。

false

replicationSpecs

[]对象

用于配置集群区域的设置列表。该数组每个分片有一个对象,表示每个分片中的节点配置。对于副本集,只有一个对象表示节点配置。

false

retainBackups

布尔

指示集群是否保留备份的标志。

false

rootCertType

字符串

MongoDB Atlas 集群使用的根证书颁发机构。 MongoDB Cloud 支持 Internet Security Research Group。

false

tags

[]对象

包含长度介于 1 到 255 个字符之间的键值对的列表,用于对集群进行标记和分类。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 trueMongoDB Cloud 不会删除集群。如果设立为 falseMongoDB Cloud 将删除集群。

false

useAwsTimeBasedSnapshotCopyForFastInitialSync

布尔

指示在快速Atlas跨区域初始同步期间是否使用 AWS 基于时间的快照副本而不是较慢的标准快照副本的标志。此标志仅与包含 AWS 节点的集群相关。

false

versionReleaseSystem

字符串

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

false

配置高级配置详细信息子集的设置组。

Name
类型
说明
必需

customOpensslCipherConfigTls12

[]string

TLS 1.2 的自定义 OpenSSL 密码套件列表。此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

false

customOpensslCipherConfigTls13

[]string

TLS 1.3 的自定义 OpenSSL 密码套件列表。此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

false

minimumEnabledTlsProtocol

字符串

集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS协议版本。

false

tlsCipherConfigMode

字符串

TLS 密码套件配置模式。默认模式使用默认密码套件。自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

false

为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

Name
类型
说明
必需

enabled

布尔

指示 MongoDB Connector for Business Intelligence 是否在指定集群上为 enabled 的标志。

false

readPreference

字符串

MongoDB Cloud 上的 MongoDB Connector for Business Intelligence 指定的数据源节点。 MongoDB Cloud 上的 MongoDB Connector for Business Intelligence 会根据您的读取偏好从主节点 (primary node in the replica set)、从节点(secondary node from replica set)或分析节点读取数据。默认为 ANALYTICS节点,如果没有 ANALYTICS 节点,则默认为 SECONDARY

false

应用于此MongoDB Cloud 组件的人类可读标签。

Name
类型
说明
必需

key

字符串

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

false

value

字符串

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

false

MongoDB 员工被授予集群访问权限级别和过期时间。

Name
类型
说明
必需

expirationTime

字符串

员工访问权限权限授予的到期日期。此参数以 UTC 中的 ISO 8601 时间戳格式表示其值。

true

grantType

字符串

授予 MongoDB 员工的访问权限级别。

true

links

[]对象

API 子资源、相关 API 资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

false

Name
类型
说明
必需

href

字符串

统一资源定位符 (URL),它指向与此响应有某种关系的另一个 API资源。此 URL 通常以 https://cloud.mongodb.com/api/atlas 开头。

false

rel

字符串

统一资源定位符 (URL),用于定义此资源与另一个 API资源之间的语义关系。此 URL 通常以 https://cloud.mongodb.com/api/atlas 开头。

false

解释MongoDB Cloud 如何在指定MongoDB 数据库上复制数据的详细信息。

Name
类型
说明
必需

regionConfigs

[]对象

为给定地区设立的节点的硬件规格。每个regionConfigs 对象在replicationSpec 中必须是针对地区和云提供商的唯一对象。每个regionConfigs 对象都描述了该区域在选举中的优先级以及MongoDB MongoDBCloud 部署到该地区的 节点的数量和类型。每个regionConfigs 对象必须有一个analyticsSpecs 对象、electableSpecs 对象或readOnlySpecs 对象。租户集群仅需要electableSpecs 。专用集群可以指定任何规范,但 中必须至少有一个electableSpecs replicationSpecreplicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize对象。示例:如果设立了:M30 replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize,如果有可选举节点,设立:M30 replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize;如果有只读节点,请设置:M30

false

zoneId

字符串

唯一的 24-十六进制数字字符串,用于标识全局集群中的区域。此值可用于配置全局集群备份策略。

false

zoneName

字符串

人类可读标签,描述此分片在Atlas全球集群中所属的区域。仅当 clusterType : GEOSHARDED 而非 selfManagedSharding : true 时才提供此值。

false

MongoDB Cloud 在其上预配主机的云服务提供商。

Name
类型
说明
必需

analyticsAutoScaling

对象

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

false

analyticsSpecs

对象

该地区中只读节点的当前硬件规格。

false

autoScaling

对象

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

false

backingProviderName

字符串

MongoDB Cloud 在其上预配多租户集群的云服务提供商。当 providerNameTENANTelectableSpecs.instanceSizeM0M2M5 时,资源返回此参数。请注意,使用 M2M5instanceSize 将创建一个 Flex集群。对 M2M5instanceSize 的支持将于 2026 1 月停止。我们建议今后对此类配置使用“创建 Flex 集群”API

false

electableSpecs

对象

该地区中部署的所有可选举节点的硬件规格。可选举节点可以成为主节点 (primary node in the replica set),并且可以启用本地读取。如果不指定此选项,MongoDB Cloud 则不会向该地区部署可选举节点。

false

priority

整型

进行主节点 (primary node in the replica set)选举时,该地区优先。如果您的regionConfigs 仅具有readOnlySpecsanalyticsSpecs 或两者,请将此值设立为 。如果您有多个 对象(您的集群是多区域或多云),则它们的优先级必须按降序排列。最高的0 regionConfigspriority7 。示例:如果有三个地区,则它们的优先级将分别为 76 和 。如果您再添加两个区域来支持可选举节点,则这些区域的优先级将分别为543

false

providerName

字符串

MongoDB Cloud 在其上预配主机的云服务提供商。将专用集群设置为 AWSGCPAZURETENANT

false

readOnlySpecs

对象

该地区中只读节点的当前硬件规格。

false

regionName

字符串

MongoDB集群节点的物理位置。您选择的地区可能会影响客户端访问数据库的网络延迟。仅在单区域集群的响应中返回地区名称。当 MongoDB Cloud 部署专用集群时,它会检查该提供商和地区是否存在 VPCVPC 连接。如果没有,MongoDB Cloud 会将其创建为部署的一部分。它为 VPC 分配无类别域间路由 (CIDR)区块。要将新的 VPC 对等连接限制在一个无类别域间路由 (CIDR)区块和地区,请先创建连接。连接开始后部署集群。 GCP 集群和多区域集群需要为每个地区建立一个 VPC 对等连接。 MongoDB 节点只能使用与这些节点位于同一地区的对等连接来与对等互连的 VPC 进行通信。

false

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

Name
类型
说明
必需

compute

对象

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

false

diskGB

对象

用于启用磁盘自动伸缩的设置。

false

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

Name
类型
说明
必需

enabled

布尔

指示是否启用实例大小响应式自动伸缩的标志。

  • 设置为 true 可启用实例大小响应式自动伸缩。如果启用,则必须指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize 的值。

  • 设置为 false 可禁用实例大小响应式自动伸缩。

false

maxInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

minInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

scaleDownEnabled

布尔

指示是否可以通过响应式自动伸缩扩展实例大小的标志。 MongoDB 如果 replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabledtrue,则 Cloud 需要此参数。如果启用此选项,请指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize 的值。

false

用于启用磁盘自动伸缩的设置。

Name
类型
说明
必需

enabled

布尔

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

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

Name
类型
说明
必需

compute

对象

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

false

diskGB

对象

用于启用磁盘自动伸缩的设置。

false

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

Name
类型
说明
必需

enabled

布尔

指示是否启用实例大小响应式自动伸缩的标志。

  • 设置为 true 可启用实例大小响应式自动伸缩。如果启用,则必须指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize 的值。

  • 设置为 false 可禁用实例大小响应式自动伸缩。

false

maxInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

minInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

scaleDownEnabled

布尔

指示是否可以通过响应式自动伸缩扩展实例大小的标志。 MongoDB 如果 replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabledtrue,则 Cloud 需要此参数。如果启用此选项,请指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize 的值。

false

用于启用磁盘自动伸缩的设置。

Name
类型
说明
必需

enabled

布尔

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

false

该地区中部署的所有可选举节点的硬件规格。 可选举节点可以成为主节点 (primary node in the replica set)节点,并且可以启用本地读取。 如果不指定此选项, MongoDB Cloud 不会向该地区部署可选举节点。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

effectiveInstanceSize

字符串

真实的租户实例大小。其目的是支持已弃用的提供商类型和/或实例大小的向后兼容性。

false

instanceSize

字符串

M0/M2/M5层级集群中实例的硬件规格。

false

nodeCount

整型

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

用于标记和分类MongoDB Cloud组织、项目或集群的键值对。示例,environment : production

Name
类型
说明
必需

key

字符串

定义标签集的常量。 例如, environment : production标签中的environment

true

value

字符串

属于该标签集的变量。 例如, environment : production标签中的production

true

对“群组”资源的引用。 "$.status.v20250312.id" 的值将用于设立"groupId"。与“groupId”属性互斥。

Name
类型
说明
必需

name

字符串

“群组”资源的名称。

false

最近观察到的指定资源版本的集群只读状态。此数据可能不是最新的,由系统填充。更多信息:https://git.k8 s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
类型
说明
必需

conditions

[]对象

表示资源当前状态的最新可用观察结果。

false

v20250312

对象

上次观察到的版本 v20250312 的集群资源的Atlas状态。

false

Name
类型
说明
必需

status

字符串

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

true

type

字符串

条件类型。

true

lastTransitionTime

字符串

上次条件从一种状态转换为另一种状态的时间。格式:日期-时间

false

message

字符串

人类可读的 message,表示有关转换的详细信息。

false

observedGeneration

整型

observedGeneration 代表 。设立条件所依据的元数据.Generation。

false

reason

字符串

条件的最后一次转换的 reason

false

上次观察到的版本 v20250312 的集群资源的Atlas状态。

Name
类型
说明
必需

advancedConfiguration

对象

配置高级配置详细信息子集的设置组。

false

configServerManagementMode

字符串

用于创建或更新分片集群的配置服务器管理模式。当配置为 ATLAS_MANAGED 时, Atlas可能会自动切换集群的配置服务器类型,以获得最佳性能并节省成本。当配置为 FIXED_TO_DEDICATED 时,集群将始终使用专用的配置服务器。

false

configServerType

字符串

描述分片集群的配置服务器类型。

false

connectionStrings

对象

MongoDB数据库的统一资源定位符集合。

false

createDate

字符串

MongoDB Cloud 创建此集群的日期和时间。此参数在 UTC 中以 ISO 8601 格式表示其值。

false

effectiveReplicationSpecs

[]对象

表示实际集群状态的设置列表。这是只读的,并且始终在响应中返回。它反映了当前的集群配置,由于系统托管的更改,该配置可能与 replicationSpecs 不同。

false

featureCompatibilityVersion

字符串

集群的特征兼容性版本。无论是否固定 FCV,它都会始终出现。

false

featureCompatibilityVersionExpirationDate

字符串

功能兼容性版本到期日期。仅在固定 FCV 时才会显示。此参数以 UTC 中的 ISO 8601 时间戳格式表示其值。

false

globalClusterSelfManagedSharding

布尔

设置该字段,用于在创建新的全球集群时配置分片管理模式。 当设置为 false 时,管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片,旨在提供无缝部署体验。 当设置为真时,管理模式设置为自管理分片。此模式将分片的管理权交给您,旨在提供先进、灵活的部署体验。 一旦集群部署完毕,此设置就无法更改。

false

groupId

字符串

唯一的 24 位十六进制字符串,用于标识项目。

false

id

字符串

唯一的 24 位十六进制数字字符串,用于标识集群。

false

internalClusterRole

字符串

集群角色的内部分类。可能的值:NONE(常规用户集群)、SYSTEM_CLUSTER(用于备份的系统集群)、INTERNAL_SHADOW_CLUSTER(用于测试的内部使用卷影集集群)。

false

mongoDBEmployeeAccessGrant

对象

MongoDB 授予员工的集群访问权限级别和过期时间。

false

mongoDBVersion

字符串

集群运行的 MongoDB 版本。

false

redactClientLogData

布尔

启用或禁用日志校订。此设置将mongodmongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。将redactClientLogData 与静态加密和TLS /SSL (传输加密)结合使用,以帮助合规监管要求。注意:在集群上更改此设置将在集群更新后触发滚动重启。

false

replicaSetScalingStrategy

字符串

设置此字段可为集群配置副本集扩展模式。默认下, Atlas 的扩展规模低于 WORKLOAD_TYPE。此模式允许Atlas并行扩展分析节点与操作节点。配置为 SEQUENTIAL 时, Atlas会按顺序扩展所有节点。此模式适用于稳定状态的工作负载和执行对延迟敏感的从节点(secondary node from replica set)读取的应用程序。配置为 NODE_TYPE 时, Atlas会与只读节点和分析节点并行扩展可选举节点。此模式适用于需要频繁且及时地进行集群层扩展的大型动态工作负载。这是最快的扩展策略,但在执行大量从节点(secondary node from replica set)读取时,可能会影响工作负载的延迟。

false

retainBackups

布尔

指示集群是否保留备份的标志。

false

stateName

字符串

人类可读标签,指示Atlas控制平面在此集群上进行的任何当前活动。除 CREATINGDELETING 状态外,即使处于指示正在进行活动的状态,集群也应始终可用并具有主节点。

  • IDLE: Atlas没有对此集群进行任何更改,可以假定通过 UIAPI 请求的所有更改都已应用。

  • CREATING:首次预配的集群会返回状态 CREATING,直到准备好连接。在尝试连接之前,确保已配置 IP 访问列表和 DB 用户。

  • UPDATING:正在执行通过 UIAPIAutoScaling 或其他计划活动请求的更改。

  • DELETING:集群正在删除进程,即将被删除。

  • REPAIRING: Atlas控制平面正在使集群中的一个或多个节点恢复服务。其他节点应继续正常提供服务。

false

配置高级配置详细信息子集的设置组。

Name
类型
说明
必需

customOpensslCipherConfigTls12

[]string

TLS 1.2 的自定义 OpenSSL 密码套件列表。此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

false

customOpensslCipherConfigTls13

[]string

TLS 1.3 的自定义 OpenSSL 密码套件列表。此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

false

minimumEnabledTlsProtocol

字符串

集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS协议版本。

false

tlsCipherConfigMode

字符串

TLS 密码套件配置模式。默认模式使用默认密码套件。自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

false

指向 MongoDB 数据库的统一资源定位符集合。

Name
类型
说明
必需

awsPrivateLink

map[string]string

私有端点感知连接字符串,使用具有Amazon Web Services (AWS) PrivateLinkAWS 托管集群。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串,用于通过键指定的接口端点连接到 MongoDB Cloud。

false

awsPrivateLinkSrv

map[string]string

私有端点感知连接字符串,使用具有Amazon Web Services (AWS) PrivateLinkAWS 托管集群。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串,用于通过键指定的接口端点连接到Atlas 。如果集群使用优化的连接字符串,则 awsPrivateLinkSrv 包含优化的连接字符串。如果集群具有非优化(传统)连接字符串,则即使也存在优化连接字符串,awsPrivateLinkSrv 也包含非优化连接字符串。

false

private

字符串

您配置为连接到此集群的每个接口虚拟私有云 (VPC) 端点的网络对等互连字符串。此连接字符串使用 mongodb+srv://协议。一旦有人创建与此集群的网络对等连接,资源就会返回此参数。此协议指示应用程序在域名系统 (DNS) 中查找托管种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符 (URI) 格式,则在节点发生变化时,您无需附加种子列表或更改 URI。如果您的驾驶员支持,请使用此 URI 格式。如果没有,请使用 connectionStrings.private。对于Amazon Web Services (AWS) 集群,仅当您启用自定义 DNS 时,此资源才会返回此参数。

false

privateEndpoint

[]对象

可用于通过私有端点连接到此集群的私有端点感知连接字符串列表。仅当您将私有端点部署到部署此集群节点的所有区域时,此参数才会返回。

false

privateSrv

字符串

VPC您配置为连接到此集群的每个接口虚拟私有云 () 端点的网络对等互连字符串。此连接字符串使用mongodb+srv:// 协议。当有人创建与此集群的网络对等连接时,资源会返回此参数。此协议指示应用程序在域名系统 ()DNS 中查找托管种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符URI () 格式,则在节点发生变化时,您无需附加种子列表或更改统一资源标识符 ()。如果您的驾驶员支持,请使用此统一资源标识符URI URI() 格式。如果没有,请使用connectionStrings.private 。对于Amazon Web Services ()AWS 集群,仅当启用自定义 DNS 时,此参数才会返回。

false

standard

字符串

可用于连接到此集群的公共连接字符串。该连接字符串使用 mongodb://协议。

false

standardSrv

字符串

可用于连接到此集群的公共连接字符串。该连接字符串使用 mongodb+srv://协议。

false

私有端点感知连接字符串,可用于通过私有端点连接到此集群。

Name
类型
说明
必需

connectionString

字符串

私有端点感知连接字符串,使用 mongodb://协议通过私有端点连接到 MongoDB Cloud。

false

endpoints

[]对象

包含私有 endpoints 的列表,当您使用 connectionStrings.privateEndpoint[n].connectionStringconnectionStrings.privateEndpoint[n].srvConnectionString 时,您通过该私有 连接到 MongoDB Cloud。

false

srvConnectionString

字符串

私有端点感知连接字符串,使用 mongodb+srv://协议通过私有端点连接到 MongoDB Cloud。 mongodb+srv协议指示驾驶员在域名系统 (DNS) 中查找主机的种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符 (URI) 格式,则在节点发生变化时,您无需附加种子列表或更改统一资源标识符 (URI)。如果您的应用程序支持,请使用此统一资源标识符 (URI) 格式。如果没有,请使用 connectionStrings.privateEndpoint[n].connectionString

false

srvShardOptimizedConnectionString

字符串

针对使用 mongodb+srv://协议通过私有端点连接到 MongoDB Cloud的分片的片集群进行了优化的私有端点感知连接字符串。如果连接字符串使用此统一资源标识符 (URI) 格式,则在节点发生变化时,您无需更改统一资源标识符 (URI)。如果您的应用程序和Atlas 集群支持,请使用此统一资源标识符 (URI) 格式。如果没有,请使用并查阅 connectionStrings.privateEndpoint[n].srvConnectionString 的文档。

false

type

字符串

MongoDB 应用程序连接到的进程type。将 MONGOD 用于副本集,将 MONGOS 用于分片的集群。

false

为此集群部署的私有端点的详细信息。

Name
类型
说明
必需

endpointId

字符串

云提供商用于标识私有端点的唯一字符串。

false

providerName

字符串

MongoDB Cloud 在其中部署私有端点的云提供商。

false

region

字符串

部署私有端点的区域。

false

解释MongoDB Cloud 如何在指定MongoDB 数据库上复制数据的详细信息。

Name
类型
说明
必需

id

字符串

唯一的 24-十六进制数字字符串,用于标识集群分片的复制对象。如果在请求中包含现有的分片复制配置,则必须指定此参数。如果向现有集群添加新分片,则可以指定此参数。该请求会删除您从请求中排除的集群中的任何现有分片。这对应于 UI 中显示的分片 ID

false

regionConfigs

[]对象

为给定地区设立的节点的硬件规格。每个regionConfigs 对象在replicationSpec 中必须是针对地区和云提供商的唯一对象。每个regionConfigs 对象都描述了该区域在选举中的优先级以及MongoDB MongoDBCloud 部署到该地区的 节点的数量和类型。每个regionConfigs 对象必须有一个analyticsSpecs 对象、electableSpecs 对象或readOnlySpecs 对象。租户集群仅需要electableSpecs 。专用集群可以指定任何规范,但 中必须至少有一个electableSpecs replicationSpecreplicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize对象。示例:如果设立了:M30 replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize,如果有可选举节点,设立:M30 replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize;如果有只读节点,请设置:M30

false

zoneId

字符串

唯一的 24-十六进制数字字符串,用于标识全局集群中的区域。此值可用于配置全局集群备份策略。

false

zoneName

字符串

人类可读标签,描述此分片在Atlas全球集群中所属的区域。仅当 clusterType : GEOSHARDED 而非 selfManagedSharding : true 时才提供此值。

false

MongoDB Cloud 在其上预配主机的云服务提供商。

Name
类型
说明
必需

analyticsAutoScaling

对象

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

false

analyticsSpecs

对象

该地区中只读节点的当前硬件规格。

false

autoScaling

对象

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

false

backingProviderName

字符串

MongoDB Cloud 在其上预配多租户集群的云服务提供商。当 providerNameTENANTelectableSpecs.instanceSizeM0M2M5 时,资源返回此参数。请注意,使用 M2M5instanceSize 将创建一个 Flex集群。对 M2M5instanceSize 的支持将于 2026 1 月停止。我们建议今后对此类配置使用“创建 Flex 集群”API

false

effectiveAnalyticsSpecs

对象

该地区中只读节点的当前硬件规格。

false

effectiveElectableSpecs

对象

该地区中只读节点的当前硬件规格。

false

effectiveReadOnlySpecs

对象

该地区中只读节点的当前硬件规格。

false

electableSpecs

对象

该地区中部署的所有可选举节点的硬件规格。可选举节点可以成为主节点 (primary node in the replica set),并且可以启用本地读取。如果不指定此选项,MongoDB Cloud 则不会向该地区部署可选举节点。

false

priority

整型

进行主节点 (primary node in the replica set)选举时,该地区优先。如果您的regionConfigs 仅具有readOnlySpecsanalyticsSpecs 或两者,请将此值设立为 。如果您有多个 对象(您的集群是多区域或多云),则它们的优先级必须按降序排列。最高的0 regionConfigspriority7 。示例:如果有三个地区,则它们的优先级将分别为 76 和 。如果您再添加两个区域来支持可选举节点,则这些区域的优先级将分别为543

false

providerName

字符串

MongoDB Cloud 在其上预配主机的云服务提供商。将专用集群设置为 AWSGCPAZURETENANT

false

readOnlySpecs

对象

该地区中只读节点的当前硬件规格。

false

regionName

字符串

MongoDB集群节点的物理位置。您选择的地区可能会影响客户端访问数据库的网络延迟。仅在单区域集群的响应中返回地区名称。当 MongoDB Cloud 部署专用集群时,它会检查该提供商和地区是否存在 VPCVPC 连接。如果没有,MongoDB Cloud 会将其创建为部署的一部分。它为 VPC 分配无类别域间路由 (CIDR)区块。要将新的 VPC 对等连接限制在一个无类别域间路由 (CIDR)区块和地区,请先创建连接。连接开始后部署集群。 GCP 集群和多区域集群需要为每个地区建立一个 VPC 对等连接。 MongoDB 节点只能使用与这些节点位于同一地区的对等连接来与对等互连的 VPC 进行通信。

false

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

Name
类型
说明
必需

compute

对象

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

false

diskGB

对象

用于启用磁盘自动伸缩的设置。

false

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

Name
类型
说明
必需

enabled

布尔

指示是否启用实例大小响应式自动伸缩的标志。

  • 设置为 true 可启用实例大小响应式自动伸缩。如果启用,则必须指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize 的值。

  • 设置为 false 可禁用实例大小响应式自动伸缩。

false

maxInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

minInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

scaleDownEnabled

布尔

指示是否可以通过响应式自动伸缩扩展实例大小的标志。 MongoDB 如果 replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabledtrue,则 Cloud 需要此参数。如果启用此选项,请指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize 的值。

false

用于启用磁盘自动伸缩的设置。

Name
类型
说明
必需

enabled

布尔

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

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

Name
类型
说明
必需

compute

对象

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

false

diskGB

对象

用于启用磁盘自动伸缩的设置。

false

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

Name
类型
说明
必需

enabled

布尔

指示是否启用实例大小响应式自动伸缩的标志。

  • 设置为 true 可启用实例大小响应式自动伸缩。如果启用,则必须指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize 的值。

  • 设置为 false 可禁用实例大小响应式自动伸缩。

false

maxInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

minInstanceSize

字符串

集群可自动扩展的实例大小边界。

false

scaleDownEnabled

布尔

指示是否可以通过响应式自动伸缩扩展实例大小的标志。 MongoDB 如果 replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabledtrue,则 Cloud 需要此参数。如果启用此选项,请指定 replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize 的值。

false

用于启用磁盘自动伸缩的设置。

Name
类型
说明
必需

enabled

布尔

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

该地区中部署的所有可选举节点的硬件规格。 可选举节点可以成为主节点 (primary node in the replica set)节点,并且可以启用本地读取。 如果不指定此选项, MongoDB Cloud 不会向该地区部署可选举节点。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

effectiveInstanceSize

字符串

真实的租户实例大小。其目的是支持已弃用的提供商类型和/或实例大小的向后兼容性。

false

instanceSize

字符串

M0/M2/M5层级集群中实例的硬件规格。

false

nodeCount

整型

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

false

该地区中只读节点的当前硬件规格。

Name
类型
说明
必需

diskIOPS

整型

附加到 Azure 预配集群的存储所需的目标吞吐量。如果出现以下情况,请更改此参数:

  • 设立replicationSpecs[n].regionConfigs[m].providerName : Azure

  • 设立replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSizeM40 或更高,不包括 Mxx_NVME 层级。

每秒最大输入/输出操作数 (IOPS) 取决于所选的 .instanceSize.diskSizeGB。此参数默认为集群层的标准 IOPS 值。更改此值会影响集群费用。

false

diskSizeGB

数字

实例数据卷的存储容量,以 GB 为单位。增加此数字可增加容量。对于所有分片和节点类型,该值必须相等。此值在 M0/M2/M5 集群上不可配置。如果设立了replicationSpecs,则 MongoDB Cloud 需要此参数。如果指定的磁盘大小低于最小值 (10 GB),则此参数默认为最小磁盘大小值。存储费用的计算取决于您选择的默认值还是自定义值。磁盘存储的最大值不能超过所选集群最大值 RAM 的 50 倍。如果需要更多存储空间,请考虑将集群升级到更高层级。

false

ebsVolumeType

字符串

要附加到 AWS 预配集群的存储类型。

  • STANDARD 卷类型不能超过所选卷大小的默认每秒输入/输出操作数 (IOPS) 速率。

  • PROVISIONED 卷类型必须在所选卷大小允许的 IOPS范围内。对于 NVMe 集群,必须将此值设立为 (PROVISIONED)。

false

instanceSize

字符串

此分片此地区内实例大小的硬件规格。每个实例大小都有默认的存储和内存容量。单个分片片中的可选举节点和只读节点(称为“基本节点”)必须使用相同的实例大小。分析节点可以独立于分片内的基本节点扩展。基本节点和分析节点都可以独立于其他分片中的对应节点扩展。

false

nodeCount

整型

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

false

MongoDB 员工被授予集群访问权限级别和过期时间。

Name
类型
说明
必需

expirationTime

字符串

员工访问权限权限授予的到期日期。此参数以 UTC 中的 ISO 8601 时间戳格式表示其值。

true

grantType

字符串

授予 MongoDB 员工的访问权限级别。

true

links

[]对象

API 子资源、相关 API 资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

false

Name
类型
说明
必需

href

字符串

统一资源定位符 (URL),它指向与此响应有某种关系的另一个 API资源。此 URL 通常以 https://cloud.mongodb.com/api/atlas 开头。

false

rel

字符串

统一资源定位符 (URL),用于定义此资源与另一个 API资源之间的语义关系。此 URL 通常以 https://cloud.mongodb.com/api/atlas 开头。

false

后退

GROUP

在此页面上