创建云数据库实例（包年包月）
最近更新时间: 2024-10-18 10:38:26
1. 接口描述
接口请求域名： mongodb.api3.fincloud.tencent.cn。
本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-10-09 12:19:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateDBInstance |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-07-25 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| NodeNum | 是 | 否 | Uint64 | 每个副本集内节点个数，当前副本集节点数固定为3，分片从节点数可选，具体参照查询云数据库的售卖规格返回参数 |
| Memory | 是 | 否 | Uint64 | 实例内存大小，单位：GB |
| Volume | 是 | 否 | Uint64 | 实例硬盘大小，单位：GB |
| MongoVersion | 是 | 否 | String | 版本号，具体支持的售卖版本请参照查询云数据库的售卖规格（DescribeSpecInfo）返回结果。参数与版本对应关系是MONGO_3_WT：MongoDB 3.2 WiredTiger存储引擎版本，MONGO_3_ROCKS：MongoDB 3.2 RocksDB存储引擎版本，MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本 |
| GoodsNum | 是 | 否 | Uint64 | 实例数量, 最小值1，最大值为10 |
| Zone | 是 | 否 | String | 实例所属区域名称，格式如：ap-guangzhou-2 |
| ProjectId | 否 | 否 | Int64 | 项目ID，不设置为默认项目 |
| Period | 是 | 否 | Uint64 | 实例时长，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36] |
| MachineCode | 是 | 否 | String | 机器类型，HIO：高IO型；HIO10G：高IO万兆型 |
| VpcId | 否 | 否 | String | 私有网络 ID，如果不传则默认选择基础网络，请使用 查询私有网络列表 |
| SubnetId | 否 | 否 | String | 私有网络下的子网 ID，如果设置了 UniqVpcId，则 UniqSubnetId 必填，请使用 查询子网列表 |
| Password | 否 | 否 | String | 实例密码，不设置该参数则需要在创建完成后通过设置密码接口初始化实例密码。密码必须是8-16位字符，且至少包含字母、数字和字符 !@#%^*() 中的两种 |
| ClusterType | 是 | 否 | String | 实例类型，REPLSET-副本集，SHARD-分片集群 |
| ReplicateSetNum | 是 | 否 | Uint64 | 副本集个数，创建副本集实例时，该参数必须设置为1；创建分片实例时，具体参照查询云数据库的售卖规格返回参数 |
| Tags | 否 | 否 | Array of TagInfo | 实例标签信息 |
| AutoRenewFlag | 否 | 否 | Uint64 | 自动续费标记，可选值为：0 - 不自动续费；1 - 自动续费。默认为不自动续费 |
| AutoVoucher | 否 | 否 | Uint64 | 是否自动选择代金券，可选值为：1 - 是；0 - 否； 默认为0 |
| Clone | 否 | 否 | Int64 | 1:正式实例,2:临时实例,3:只读实例，4：灾备实例 |
| Father | 否 | 否 | String | 若是只读，灾备实例，Father必须填写，即主实例ID |
| SecurityGroup | 否 | 否 | Array of String | 安全组 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealId | String | 订单ID |
| InstanceIds | String | 创建的实例ID列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue.ReplicaSetNumError | |
| InvalidParameterValue.MongoVersionError | |
| InvalidParameterValue.RegionError | |
| InvalidParameterValue.SpecNotOnSale | |
| InvalidParameterValue.VpcIdOrSubnetIdNotFound | |
| InvalidParameterValue.ProjectNotFound | |
| InvalidParameterValue.MachineTypeError | |
| InvalidParameterValue.SecondaryNumError | |
| InvalidParameterValue.ZoneClosed | |
| InvalidParameterValue.ZoneError | |
| InvalidParameterValue.TagNotFound | |
| InvalidParameterValue.PasswordRuleFailed | |
| InvalidParameterValue.InvalidTradeOperation | |
| InvalidParameter.PermissionDenied |