com.tencentcloudapi.mongodb.v20190725.models

Class CreateDBInstanceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.CreateDBInstanceRequest

public class CreateDBInstanceRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateDBInstanceRequest()
CreateDBInstanceRequest(CreateDBInstanceRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getAutoRenewFlag() Get 自动续费标记。 - 0：不自动续费。 - 1：自动续费。
Long	getAutoVoucher() Get 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。
String[]	getAvailabilityZoneList() Get 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。
Long	getClone() Get 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。
String	getClusterType() Get 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。
String	getFather() Get 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。
Long	getGoodsNum() Get 实例数量, 最小值1，最大值为10。
String	getHiddenZone() Get Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。
String	getInstanceName() Get 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
String	getMachineCode() Get 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。
Long	getMemory() Get 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
Long	getMongosCpu() Get Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。
Long	getMongosMemory() Get Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
Long	getMongosNodeNum() Get Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。
String	getMongoVersion() Get 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。
Long	getNodeNum() Get - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
String	getParamTemplateId() Get 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。
String	getPassword() Get 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。
Long	getPeriod() Get 指定购买实例的购买时长。取值可选：[1,2,3,4,5,6,7,8,9,10,11,12,24,36]；单位：月。
Long	getProjectId() Get 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。
String[]	getReadonlyNodeAvailabilityZoneList() Get 指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。
Long	getReadonlyNodeNum() Get 只读节点数量，取值范围[0,5]。
Long	getReplicateSetNum() Get - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
String	getRestoreTime() Get 克隆实例回档时间，当Clone取值为5或6时为必填。- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。- 回档时间范围：仅能回档7天内时间点的数据。
String[]	getSecurityGroup() Get 安全组 ID。
String	getSubnetId() Get 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。
TagInfo[]	getTags() Get 实例标签信息。
Long	getVolume() Get 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
String	getVpcId() Get 私有网络ID。如果不设置该参数，则默认选择基础网络。
String	getZone() Get 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。
void	setAutoRenewFlag(Long AutoRenewFlag) Set 自动续费标记。 - 0：不自动续费。 - 1：自动续费。
void	setAutoVoucher(Long AutoVoucher) Set 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。
void	setAvailabilityZoneList(String[] AvailabilityZoneList) Set 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。
void	setClone(Long Clone) Set 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。
void	setClusterType(String ClusterType) Set 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。
void	setFather(String Father) Set 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。
void	setGoodsNum(Long GoodsNum) Set 实例数量, 最小值1，最大值为10。
void	setHiddenZone(String HiddenZone) Set Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。
void	setInstanceName(String InstanceName) Set 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
void	setMachineCode(String MachineCode) Set 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。
void	setMemory(Long Memory) Set 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
void	setMongosCpu(Long MongosCpu) Set Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。
void	setMongosMemory(Long MongosMemory) Set Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
void	setMongosNodeNum(Long MongosNodeNum) Set Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。
void	setMongoVersion(String MongoVersion) Set 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。
void	setNodeNum(Long NodeNum) Set - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
void	setParamTemplateId(String ParamTemplateId) Set 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。
void	setPassword(String Password) Set 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。
void	setPeriod(Long Period) Set 指定购买实例的购买时长。取值可选：[1,2,3,4,5,6,7,8,9,10,11,12,24,36]；单位：月。
void	setProjectId(Long ProjectId) Set 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。
void	setReadonlyNodeAvailabilityZoneList(String[] ReadonlyNodeAvailabilityZoneList) Set 指只读节点所属可用区数组。跨可用区部署实例，参数**ReadonlyNodeNum**不为**0**时，必须配置该参数。
void	setReadonlyNodeNum(Long ReadonlyNodeNum) Set 只读节点数量，取值范围[0,5]。
void	setReplicateSetNum(Long ReplicateSetNum) Set - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
void	setRestoreTime(String RestoreTime) Set 克隆实例回档时间，当Clone取值为5或6时为必填。- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。- 回档时间范围：仅能回档7天内时间点的数据。
void	setSecurityGroup(String[] SecurityGroup) Set 安全组 ID。
void	setSubnetId(String SubnetId) Set 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。
void	setTags(TagInfo[] Tags) Set 实例标签信息。
void	setVolume(Long Volume) Set 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
void	setVpcId(String VpcId) Set 私有网络ID。如果不设置该参数，则默认选择基础网络。
void	setZone(String Zone) Set 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateDBInstanceRequest

public CreateDBInstanceRequest()

CreateDBInstanceRequest

public CreateDBInstanceRequest(CreateDBInstanceRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getNodeNum

public Long getNodeNum()

Get - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Returns:

NodeNum - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

setNodeNum

public void setNodeNum(Long NodeNum)

Set - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Parameters:

NodeNum - - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

getMemory

public Long getMemory()

Get 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Returns:

Memory 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

setMemory

public void setMemory(Long Memory)

Set 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Parameters:

Memory - 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

getVolume

public Long getVolume()

Get 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Returns:

Volume 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

setVolume

public void setVolume(Long Volume)

Set 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

Parameters:

Volume - 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。

getMongoVersion

public String getMongoVersion()

Get 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。

Returns:

MongoVersion 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。

setMongoVersion

public void setMongoVersion(String MongoVersion)

Set 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。

Parameters:

MongoVersion - 指版本信息。具体支持的版本信息 ，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - 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存储引擎版本。

getGoodsNum

public Long getGoodsNum()

Get 实例数量, 最小值1，最大值为10。

Returns:

GoodsNum 实例数量, 最小值1，最大值为10。

setGoodsNum

public void setGoodsNum(Long GoodsNum)

Set 实例数量, 最小值1，最大值为10。

Parameters:

GoodsNum - 实例数量, 最小值1，最大值为10。

getZone

public String getZone()

Get 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。

Returns:

Zone 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。

setZone

public void setZone(String Zone)

Set 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。

Parameters:

Zone - 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。

getPeriod

public Long getPeriod()

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

Returns:

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

setPeriod

public void setPeriod(Long Period)

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

Parameters:

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

getMachineCode

public String getMachineCode()

Get 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。

Returns:

MachineCode 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。

setMachineCode

public void setMachineCode(String MachineCode)

Set 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。

Parameters:

MachineCode - 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。

getClusterType

public String getClusterType()

Get 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。

Returns:

ClusterType 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。

setClusterType

public void setClusterType(String ClusterType)

Set 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。

Parameters:

ClusterType - 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。

getReplicateSetNum

public Long getReplicateSetNum()

Get - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。

Returns:

ReplicateSetNum - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。

setReplicateSetNum

public void setReplicateSetNum(Long ReplicateSetNum)

Set - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。

Parameters:

ReplicateSetNum - - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。

getProjectId

public Long getProjectId()

Get 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。

Returns:

ProjectId 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。

setProjectId

public void setProjectId(Long ProjectId)

Set 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。

Parameters:

ProjectId - 项目ID。 - 若不设置该参数，则为默认项目。 - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面，可获取项目ID。

getVpcId

public String getVpcId()

Get 私有网络ID。如果不设置该参数，则默认选择基础网络。

Returns:

VpcId 私有网络ID。如果不设置该参数，则默认选择基础网络。

setVpcId

public void setVpcId(String VpcId)

Set 私有网络ID。如果不设置该参数，则默认选择基础网络。

Parameters:

VpcId - 私有网络ID。如果不设置该参数，则默认选择基础网络。

getSubnetId

public String getSubnetId()

Get 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。

Returns:

SubnetId 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。

setSubnetId

public void setSubnetId(String SubnetId)

Set 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。

Parameters:

SubnetId - 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。

getPassword

public String getPassword()

Get 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。

Returns:

Password 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。

setPassword

public void setPassword(String Password)

Set 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。

Parameters:

Password - 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。

getTags

public TagInfo[] getTags()

Get 实例标签信息。

Returns:

Tags 实例标签信息。

setTags

public void setTags(TagInfo[] Tags)

Set 实例标签信息。

Parameters:

Tags - 实例标签信息。

getAutoRenewFlag

public Long getAutoRenewFlag()

Get 自动续费标记。 - 0：不自动续费。 - 1：自动续费。

Returns:

AutoRenewFlag 自动续费标记。 - 0：不自动续费。 - 1：自动续费。

setAutoRenewFlag

public void setAutoRenewFlag(Long AutoRenewFlag)

Set 自动续费标记。 - 0：不自动续费。 - 1：自动续费。

Parameters:

AutoRenewFlag - 自动续费标记。 - 0：不自动续费。 - 1：自动续费。

getAutoVoucher

public Long getAutoVoucher()

Get 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。

Returns:

AutoVoucher 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。

setAutoVoucher

public void setAutoVoucher(Long AutoVoucher)

Set 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。

Parameters:

AutoVoucher - 是否自动选择代金券。 - 1：是。 - 0：否。默认为0。

getClone

public Long getClone()

Get 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。

Returns:

Clone 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。

setClone

public void setClone(Long Clone)

Set 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。

Parameters:

Clone - 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：整实例克隆，注意：克隆实例时，RestoreTime为必填项。

getFather

public String getFather()

Get 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。

Returns:

Father 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。

setFather

public void setFather(String Father)

Set 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。

Parameters:

Father - 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。

getSecurityGroup

public String[] getSecurityGroup()

Get 安全组 ID。

Returns:

SecurityGroup 安全组 ID。

setSecurityGroup

public void setSecurityGroup(String[] SecurityGroup)

Set 安全组 ID。

Parameters:

SecurityGroup - 安全组 ID。

getRestoreTime

public String getRestoreTime()

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

Returns:

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

setRestoreTime

public void setRestoreTime(String RestoreTime)

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

Parameters:

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

getInstanceName

public String getInstanceName()

Get 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。

Returns:

InstanceName 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。

setInstanceName

public void setInstanceName(String InstanceName)

Set 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。

Parameters:

InstanceName - 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。

getAvailabilityZoneList

public String[] getAvailabilityZoneList()

Get 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。

Returns:

AvailabilityZoneList 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。

setAvailabilityZoneList

public void setAvailabilityZoneList(String[] AvailabilityZoneList)

Set 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。

Parameters:

AvailabilityZoneList - 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 - 不支持4.2及以上版本。 - 不支持只读灾备实例。 - 不能选择基础网络。

getMongosCpu

public Long getMongosCpu()

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

Returns:

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

setMongosCpu

public void setMongosCpu(Long MongosCpu)

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

Parameters:

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

getMongosMemory

public Long getMongosMemory()

Get Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。

Returns:

MongosMemory Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。

setMongosMemory

public void setMongosMemory(Long MongosMemory)

Set Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。

Parameters:

MongosMemory - Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。

getMongosNodeNum

public Long getMongosNodeNum()

Get Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。

Returns:

MongosNodeNum Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。

setMongosNodeNum

public void setMongosNodeNum(Long MongosNodeNum)

Set Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。

Parameters:

MongosNodeNum - Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。

getReadonlyNodeNum

public Long getReadonlyNodeNum()

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

Returns:

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

setReadonlyNodeNum

public void setReadonlyNodeNum(Long ReadonlyNodeNum)

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

Parameters:

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

getReadonlyNodeAvailabilityZoneList

public String[] getReadonlyNodeAvailabilityZoneList()

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

Returns:

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

setReadonlyNodeAvailabilityZoneList

public void setReadonlyNodeAvailabilityZoneList(String[] ReadonlyNodeAvailabilityZoneList)

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

Parameters:

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

getHiddenZone

public String getHiddenZone()

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

Returns:

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

setHiddenZone

public void setHiddenZone(String HiddenZone)

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

Parameters:

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

getParamTemplateId

public String getParamTemplateId()

Get 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。

Returns:

ParamTemplateId 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。

setParamTemplateId

public void setParamTemplateId(String ParamTemplateId)

Set 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。

Parameters:

ParamTemplateId - 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本及实例类型。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel