Class: TencentCloud::Mongodb::V20190725::CreateDBInstanceRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190725/models.rb

Overview

CreateDBInstance请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(nodenum = nil, memory = nil, volume = nil, mongoversion = nil, goodsnum = nil, zone = nil, period = nil, machinecode = nil, clustertype = nil, replicatesetnum = nil, projectid = nil, vpcid = nil, subnetid = nil, password = nil, tags = nil, autorenewflag = nil, autovoucher = nil, clone = nil, father = nil, securitygroup = nil, restoretime = nil, instancename = nil, availabilityzonelist = nil, mongoscpu = nil, mongosmemory = nil, mongosnodenum = nil, readonlynodenum = nil, readonlynodeavailabilityzonelist = nil, hiddenzone = nil, paramtemplateid = nil) ⇒ CreateDBInstanceRequest

Returns a new instance of CreateDBInstanceRequest.



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
# File 'lib/v20190725/models.rb', line 1073

def initialize(nodenum=nil, memory=nil, volume=nil, mongoversion=nil, goodsnum=nil, zone=nil, period=nil, machinecode=nil, clustertype=nil, replicatesetnum=nil, projectid=nil, vpcid=nil, subnetid=nil, password=nil, tags=nil, autorenewflag=nil, autovoucher=nil, clone=nil, father=nil, securitygroup=nil, restoretime=nil, instancename=nil, availabilityzonelist=nil, mongoscpu=nil, mongosmemory=nil, mongosnodenum=nil, readonlynodenum=nil, readonlynodeavailabilityzonelist=nil, hiddenzone=nil, paramtemplateid=nil)
  @NodeNum = nodenum
  @Memory = memory
  @Volume = volume
  @MongoVersion = mongoversion
  @GoodsNum = goodsnum
  @Zone = zone
  @Period = period
  @MachineCode = machinecode
  @ClusterType = clustertype
  @ReplicateSetNum = replicatesetnum
  @ProjectId = projectid
  @VpcId = vpcid
  @SubnetId = subnetid
  @Password = password
  @Tags = tags
  @AutoRenewFlag = autorenewflag
  @AutoVoucher = autovoucher
  @Clone = clone
  @Father = father
  @SecurityGroup = securitygroup
  @RestoreTime = restoretime
  @InstanceName = instancename
  @AvailabilityZoneList = availabilityzonelist
  @MongosCpu = mongoscpu
  @MongosMemory = mongosmemory
  @MongosNodeNum = mongosnodenum
  @ReadonlyNodeNum = readonlynodenum
  @ReadonlyNodeAvailabilityZoneList = readonlynodeavailabilityzonelist
  @HiddenZone = hiddenzone
  @ParamTemplateId = paramtemplateid
end

Instance Attribute Details

#AutoRenewFlagObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def AutoRenewFlag
  @AutoRenewFlag
end

#AutoVoucherObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def AutoVoucher
  @AutoVoucher
end

#AvailabilityZoneListObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def AvailabilityZoneList
  @AvailabilityZoneList
end

#CloneObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Clone
  @Clone
end

#ClusterTypeObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ClusterType
  @ClusterType
end

#FatherObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Father
  @Father
end

#GoodsNumObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def GoodsNum
  @GoodsNum
end

#HiddenZoneObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def HiddenZone
  @HiddenZone
end

#InstanceNameObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def InstanceName
  @InstanceName
end

#MachineCodeObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def MachineCode
  @MachineCode
end

#MemoryObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Memory
  @Memory
end

#MongosCpuObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def MongosCpu
  @MongosCpu
end

#MongosMemoryObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def MongosMemory
  @MongosMemory
end

#MongosNodeNumObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def MongosNodeNum
  @MongosNodeNum
end

#MongoVersionObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def MongoVersion
  @MongoVersion
end

#NodeNumObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def NodeNum
  @NodeNum
end

#ParamTemplateIdObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ParamTemplateId
  @ParamTemplateId
end

#PasswordObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Password
  @Password
end

#PeriodObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Period
  @Period
end

#ProjectIdObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ProjectId
  @ProjectId
end

#ReadonlyNodeAvailabilityZoneListObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ReadonlyNodeAvailabilityZoneList
  @ReadonlyNodeAvailabilityZoneList
end

#ReadonlyNodeNumObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ReadonlyNodeNum
  @ReadonlyNodeNum
end

#ReplicateSetNumObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def ReplicateSetNum
  @ReplicateSetNum
end

#RestoreTimeObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def RestoreTime
  @RestoreTime
end

#SecurityGroupObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def SecurityGroup
  @SecurityGroup
end

#SubnetIdObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def SubnetId
  @SubnetId
end

#TagsObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Tags
  @Tags
end

#VolumeObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Volume
  @Volume
end

#VpcIdObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def VpcId
  @VpcId
end

#ZoneObject

  • 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
  • MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
  • MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
  • MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
  • MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
  • MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
  • MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
  • 具体信息,请通过接口 DescribeSpecInfo 获取。
  • 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
  • HIO10G:通用高HIO万兆型。
  • HCD:云盘版类型。
  • REPLSET:副本集。
  • SHARD:分片集群。
  • 创建分片集群实例,指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
  • 若不设置该参数,则为默认项目。
  • MongoDB 控制台项目管理页面,可获取项目ID。
  • 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录私有网络控制台获取可使用的私有网络 ID。
  • 实例创建成功之后,支持更换私有网络。具体操作,请参见更换网络
  • 必须在已选的私有网络内指定一个子网。请登录私有网络控制台获取可使用的子网 ID。
  • 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见更换网络
  • 字符个数为[8,32]。
  • 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
  • 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。
  • 不能设置单一的字母或者数字。
  • 0:不自动续费。
  • 1:自动续费。
  • 1:是。
  • 0:否。默认为0。
  • 1:正式实例。
  • 3:只读实例。
  • 4:灾备实例。
  • 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
  • 当参数Clone为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
  • 请登录 MongoDB 控制台在实例列表复制父实例 ID。
  • 基础模式:前缀+自动升序编号(默认从1开始),lnstanceName仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
  • 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。InstanceName需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
  • 复合模式串:前缀1R:x+前缀2R:y+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。instanceName需填写复合模式串,例如:cmgoR:10_nodeR:12_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.
  • 多可用区部署实例,参数 Zone 指定实例主可用区信息;AvailabilityZoneList 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
  • 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
  • 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
  • 购买分片集群时,必须填写。
  • 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
  • 单可用区部署实例,其数量范围为[3,32]。
  • 多可用区部署实例,其数量范围为[6,32]。
  • 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
  • 参数模板 ID 可通过 DescribeDBInstanceParamTpl 接口获取。请选择与实例版本与架构所对应的参数模板 ID。

Parameters:

  • NodeNum:
    • 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 DescribeSpecInfo 获取。
  • Memory:

    实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 DescribeSpecInfo 获取。

  • Volume:

    实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 DescribeSpecInfo 获取。

  • MongoVersion:

    指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。

  • GoodsNum:

    实例数量, 最小值1,最大值为30。

  • Zone:

    可用区信息,输入格式如:ap-guangzhou-2。

  • Period:

    指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。

  • MachineCode:

    产品规格类型。

  • ClusterType:

    实例架构类型。

  • ReplicateSetNum:
    • 创建副本集实例,指副本集数量,该参数只能为1。
  • ProjectId:

    项目ID。

  • VpcId:

    私有网络 ID。

  • SubnetId:

    私有网络 VPC 的子网 ID。

  • Password:

    实例密码。设置要求如下:

  • Tags:

    实例标签信息。

  • AutoRenewFlag:

    自动续费标记。

  • AutoVoucher:

    是否自动选择代金券。

  • Clone:

    实例类型。

  • Father:

    父实例 ID。

  • SecurityGroup:

    安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。

  • RestoreTime:

    克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。

  • InstanceName:

    实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。

  • AvailabilityZoneList:

    若多可用区部署云数据库实例,指定多可用区列表。

  • MongosCpu:

    Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。

  • MongosMemory:

    Mongos 内存大小。

  • MongosNodeNum:

    Mongos 数量。购买分片集群时,必须填写。

  • ReadonlyNodeNum:

    只读节点数量,取值范围[0,5]。

  • ReadonlyNodeAvailabilityZoneList:

    指只读节点所属可用区数组。跨可用区部署实例,参数ReadonlyNodeNum不为0时,必须配置该参数。

  • HiddenZone:

    Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。

  • ParamTemplateId:

    参数模板 ID。



1071
1072
1073
# File 'lib/v20190725/models.rb', line 1071

def Zone
  @Zone
end

Instance Method Details

#deserialize(params) ⇒ Object



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'lib/v20190725/models.rb', line 1106

def deserialize(params)
  @NodeNum = params['NodeNum']
  @Memory = params['Memory']
  @Volume = params['Volume']
  @MongoVersion = params['MongoVersion']
  @GoodsNum = params['GoodsNum']
  @Zone = params['Zone']
  @Period = params['Period']
  @MachineCode = params['MachineCode']
  @ClusterType = params['ClusterType']
  @ReplicateSetNum = params['ReplicateSetNum']
  @ProjectId = params['ProjectId']
  @VpcId = params['VpcId']
  @SubnetId = params['SubnetId']
  @Password = params['Password']
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      taginfo_tmp = TagInfo.new
      taginfo_tmp.deserialize(i)
      @Tags << taginfo_tmp
    end
  end
  @AutoRenewFlag = params['AutoRenewFlag']
  @AutoVoucher = params['AutoVoucher']
  @Clone = params['Clone']
  @Father = params['Father']
  @SecurityGroup = params['SecurityGroup']
  @RestoreTime = params['RestoreTime']
  @InstanceName = params['InstanceName']
  @AvailabilityZoneList = params['AvailabilityZoneList']
  @MongosCpu = params['MongosCpu']
  @MongosMemory = params['MongosMemory']
  @MongosNodeNum = params['MongosNodeNum']
  @ReadonlyNodeNum = params['ReadonlyNodeNum']
  @ReadonlyNodeAvailabilityZoneList = params['ReadonlyNodeAvailabilityZoneList']
  @HiddenZone = params['HiddenZone']
  @ParamTemplateId = params['ParamTemplateId']
end