tencentcloud-sdk-nodejs-mongodb 4.1.215 → 4.1.223
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -12,172 +12,129 @@ export interface DescribeSpecInfoRequest {
|
|
|
12
12
|
*/
|
|
13
13
|
export interface CreateDBInstanceRequest {
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
16
|
-
- 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
15
|
+
* <ul><li>创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li></ul>
|
|
17
16
|
*/
|
|
18
17
|
NodeNum: number;
|
|
19
18
|
/**
|
|
20
|
-
*
|
|
19
|
+
* <p>实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
|
|
21
20
|
*/
|
|
22
21
|
Memory: number;
|
|
23
22
|
/**
|
|
24
|
-
*
|
|
23
|
+
* <p>实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
|
|
25
24
|
*/
|
|
26
25
|
Volume: number;
|
|
27
26
|
/**
|
|
28
|
-
*
|
|
29
|
-
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
|
30
|
-
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
|
31
|
-
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
|
32
|
-
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
|
33
|
-
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
|
34
|
-
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
|
35
|
-
- MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
|
|
27
|
+
* <p>指版本信息。具体支持的版本信息 ,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p><ul><li>MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。</li><li>MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。</li><li>MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。</li><li>MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。</li><li>MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。</li><li>MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。</li><li>MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。</li></ul>
|
|
36
28
|
*/
|
|
37
29
|
MongoVersion: string;
|
|
38
30
|
/**
|
|
39
|
-
*
|
|
31
|
+
* <p>实例数量, 最小值1,最大值为30。</p>
|
|
40
32
|
*/
|
|
41
33
|
GoodsNum: number;
|
|
42
34
|
/**
|
|
43
|
-
*
|
|
44
|
-
- 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
45
|
-
- 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
|
|
35
|
+
* <p>可用区信息,输入格式如:ap-guangzhou-2。</p><ul><li>具体信息,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。</li></ul>
|
|
46
36
|
*/
|
|
47
37
|
Zone: string;
|
|
48
38
|
/**
|
|
49
|
-
*
|
|
39
|
+
* <p>指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。</p>
|
|
50
40
|
*/
|
|
51
41
|
Period: number;
|
|
52
42
|
/**
|
|
53
|
-
*
|
|
54
|
-
- HIO10G:通用高HIO万兆型。
|
|
55
|
-
- HCD:云盘版类型。
|
|
43
|
+
* <p>产品推荐规格类型:</p><ul><li>GE.LD.T1:本地盘(通用I型)。</li><li>GE.CD.T1:云盘(通用I型)。</li></ul><p>产品白名单规格类型:</p><ul><li>HIO10G:本地盘(高IO万兆型)。</li><li>HCD:云盘(云盘版)。</li></ul><p>注意:白名单规格类型为白名单控制,如若需要,请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</p>
|
|
56
44
|
*/
|
|
57
45
|
MachineCode: string;
|
|
58
46
|
/**
|
|
59
|
-
*
|
|
60
|
-
- REPLSET:副本集。
|
|
61
|
-
- SHARD:分片集群。
|
|
47
|
+
* <p>实例架构类型。</p><ul><li>REPLSET:副本集。</li><li>SHARD:分片集群。</li></ul>
|
|
62
48
|
*/
|
|
63
49
|
ClusterType: string;
|
|
64
50
|
/**
|
|
65
|
-
*
|
|
66
|
-
- 创建分片集群实例,指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
|
|
51
|
+
* <ul><li>创建副本集实例,指副本集数量,该参数只能为1。</li><li>创建分片集群实例,指分片的数量。请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。</li></ul>
|
|
67
52
|
*/
|
|
68
53
|
ReplicateSetNum: number;
|
|
69
54
|
/**
|
|
70
|
-
*
|
|
71
|
-
- 若不设置该参数,则为默认项目。
|
|
72
|
-
- 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面,可获取项目ID。
|
|
55
|
+
* <p>项目ID。</p><ul><li>若不设置该参数,则为默认项目。</li><li>在 <a href="https://console.cloud.tencent.com/project">MongoDB 控制台项目管理</a>页面,可获取项目ID。</li></ul>
|
|
73
56
|
*/
|
|
74
57
|
ProjectId?: number;
|
|
75
58
|
/**
|
|
76
|
-
*
|
|
77
|
-
- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
|
78
|
-
- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
|
59
|
+
* <p>私有网络 ID。</p><ul><li>仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的私有网络 ID。</li><li>实例创建成功之后,支持更换私有网络。具体操作,请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
|
|
79
60
|
*/
|
|
80
61
|
VpcId?: string;
|
|
81
62
|
/**
|
|
82
|
-
*
|
|
83
|
-
- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
|
84
|
-
- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
|
63
|
+
* <p>私有网络 VPC 的子网 ID。</p><ul><li>必须在已选的私有网络内指定一个子网。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的子网 ID。</li><li>实例创建成功之后,支持更换私有网络及子网。具体操作,请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
|
|
85
64
|
*/
|
|
86
65
|
SubnetId?: string;
|
|
87
66
|
/**
|
|
88
|
-
*
|
|
89
|
-
- 字符个数为[8,32]。
|
|
90
|
-
- 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
|
|
91
|
-
- 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“\*”、括号“()”、下划线“\_”。
|
|
92
|
-
- 不能设置单一的字母或者数字。
|
|
67
|
+
* <p>实例密码。设置要求如下:</p><ul><li>字符个数为[8,32]。</li><li>可输入[A,Z]、[a,z]、[0,9]范围内的字符。</li><li>可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。</li><li>不能设置单一的字母或者数字。</li></ul>
|
|
93
68
|
*/
|
|
94
69
|
Password?: string;
|
|
95
70
|
/**
|
|
96
|
-
*
|
|
71
|
+
* <p>实例标签信息。</p>
|
|
97
72
|
*/
|
|
98
73
|
Tags?: Array<TagInfo>;
|
|
99
74
|
/**
|
|
100
|
-
*
|
|
101
|
-
- 0:不自动续费。
|
|
102
|
-
- 1:自动续费。
|
|
75
|
+
* <p>自动续费标记。</p><ul><li>0:不自动续费。</li><li>1:自动续费。</li></ul>
|
|
103
76
|
*/
|
|
104
77
|
AutoRenewFlag?: number;
|
|
105
78
|
/**
|
|
106
|
-
*
|
|
107
|
-
- 1:是。
|
|
108
|
-
- 0:否。默认为0。
|
|
79
|
+
* <p>是否自动选择代金券。</p><ul><li>1:是。</li><li>0:否。默认为0。</li></ul>
|
|
109
80
|
*/
|
|
110
81
|
AutoVoucher?: number;
|
|
111
82
|
/**
|
|
112
|
-
*
|
|
113
|
-
- 1:正式实例。
|
|
114
|
-
- 3:只读实例。
|
|
115
|
-
- 4:灾备实例。
|
|
116
|
-
- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
|
83
|
+
* <p>实例类型。</p><ul><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li><li>5:克隆实例。注意:克隆实例 RestoreTime 为必填项。</li></ul>
|
|
117
84
|
*/
|
|
118
85
|
Clone?: number;
|
|
119
86
|
/**
|
|
120
|
-
*
|
|
121
|
-
- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
|
122
|
-
- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
|
87
|
+
* <p>父实例 ID。</p><ul><li>当参数<strong>Clone</strong>为3或者4时,即实例为只读或灾备实例时,该参数必须配置。</li><li>请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制父实例 ID。</li></ul>
|
|
123
88
|
*/
|
|
124
89
|
Father?: string;
|
|
125
90
|
/**
|
|
126
|
-
*
|
|
91
|
+
* <p>安全组 ID。 请登录<a href="https://console.cloud.tencent.com/vpc/security-group">安全组控制台</a>页面获取与数据库实例同地域的安全组 ID。</p>
|
|
127
92
|
*/
|
|
128
93
|
SecurityGroup?: Array<string>;
|
|
129
94
|
/**
|
|
130
|
-
*
|
|
95
|
+
* <p>克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。</p>
|
|
131
96
|
*/
|
|
132
97
|
RestoreTime?: string;
|
|
133
98
|
/**
|
|
134
|
-
*
|
|
135
|
-
- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
|
|
136
|
-
- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
|
|
137
|
-
- 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
|
|
99
|
+
* <p>实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。</p><ul><li>基础模式:前缀+自动升序编号(默认从1开始),<strong>lnstanceName</strong>仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。</li><li>自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。<strong>InstanceName</strong>需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。</li><li>复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。<strong>instanceName</strong>需填写复合模式串,例如:cmgo{R:10}_node{R:12}_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.</li></ul>
|
|
138
100
|
*/
|
|
139
101
|
InstanceName?: string;
|
|
140
102
|
/**
|
|
141
|
-
*
|
|
142
|
-
- 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
|
|
143
|
-
- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
|
|
144
|
-
- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
|
|
103
|
+
* <p>若多可用区部署云数据库实例,指定多可用区列表。</p><ul><li>多可用区部署实例,参数 <strong>Zone</strong> 指定实例主可用区信息;<strong>AvailabilityZoneList</strong> 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。</li><li>通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。</li><li>多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。</li></ul>
|
|
145
104
|
*/
|
|
146
105
|
AvailabilityZoneList?: Array<string>;
|
|
147
106
|
/**
|
|
148
|
-
* Mongos CPU 核数,支持1、2、4、8、16
|
|
107
|
+
* <p>Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。</p>
|
|
149
108
|
*/
|
|
150
109
|
MongosCpu?: number;
|
|
151
110
|
/**
|
|
152
|
-
* Mongos
|
|
153
|
-
- 购买分片集群时,必须填写。
|
|
154
|
-
- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
|
|
111
|
+
* <p>Mongos 内存大小。</p><ul><li>购买分片集群时,必须填写。</li><li>单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。</li></ul>
|
|
155
112
|
*/
|
|
156
113
|
MongosMemory?: number;
|
|
157
114
|
/**
|
|
158
|
-
* Mongos
|
|
159
|
-
- 单可用区部署实例,其数量范围为[3,32]。
|
|
160
|
-
- 多可用区部署实例,其数量范围为[6,32]。
|
|
115
|
+
* <p>Mongos 数量。购买分片集群时,必须填写。</p><ul><li>单可用区部署实例,其数量范围为[3,32]。</li><li>多可用区部署实例,其数量范围为[6,32]。</li></ul>
|
|
161
116
|
*/
|
|
162
117
|
MongosNodeNum?: number;
|
|
163
118
|
/**
|
|
164
|
-
*
|
|
119
|
+
* <p>只读节点数量,取值范围[0,5]。</p>
|
|
165
120
|
*/
|
|
166
121
|
ReadonlyNodeNum?: number;
|
|
167
122
|
/**
|
|
168
|
-
*
|
|
123
|
+
* <p>指只读节点所属可用区数组。跨可用区部署实例,参数<strong>ReadonlyNodeNum</strong>不为<strong>0</strong>时,必须配置该参数。</p>
|
|
169
124
|
*/
|
|
170
125
|
ReadonlyNodeAvailabilityZoneList?: Array<string>;
|
|
171
126
|
/**
|
|
172
|
-
* Hidden
|
|
127
|
+
* <p>Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。</p>
|
|
173
128
|
*/
|
|
174
129
|
HiddenZone?: string;
|
|
175
130
|
/**
|
|
176
|
-
*
|
|
177
|
-
- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
|
178
|
-
- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
|
131
|
+
* <p>参数模板 ID。</p><ul><li>参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。</li><li>参数模板 ID 可通过 <a href="https://cloud.tencent.com/document/product/240/109155">DescribeDBInstanceParamTpl </a>接口获取。请选择与实例版本与架构所对应的参数模板 ID。</li></ul>
|
|
179
132
|
*/
|
|
180
133
|
ParamTemplateId?: string;
|
|
134
|
+
/**
|
|
135
|
+
* <p>实例CPU核大小,单位:C。具体售卖的CPU规格,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取<br>注意:通用 I 型实例必须设置 CPU 大小。</p>
|
|
136
|
+
*/
|
|
137
|
+
CpuCore?: number;
|
|
181
138
|
}
|
|
182
139
|
/**
|
|
183
140
|
* CreateDBInstanceParamTpl返回参数结构体
|
|
@@ -1054,11 +1011,11 @@ export interface ModifyDBInstanceNetworkAddressRequest {
|
|
|
1054
1011
|
*/
|
|
1055
1012
|
export interface CreateDBInstanceHourResponse {
|
|
1056
1013
|
/**
|
|
1057
|
-
*
|
|
1014
|
+
* <p>订单ID。</p>
|
|
1058
1015
|
*/
|
|
1059
1016
|
DealId?: string;
|
|
1060
1017
|
/**
|
|
1061
|
-
*
|
|
1018
|
+
* <p>创建的实例ID列表。</p>
|
|
1062
1019
|
*/
|
|
1063
1020
|
InstanceIds?: Array<string>;
|
|
1064
1021
|
/**
|
|
@@ -1518,6 +1475,11 @@ export interface InquirePriceModifyDBInstanceSpecRequest {
|
|
|
1518
1475
|
**说明**:变更后的分片数量不能小于当前现有的数量。切勿同时发起调整节点数、调整分片数与调整节点规格的任务。
|
|
1519
1476
|
*/
|
|
1520
1477
|
ReplicateSetNum?: number;
|
|
1478
|
+
/**
|
|
1479
|
+
* 变更配置后实例CPU大小,单位:C。具体售卖的CPU规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
1480
|
+
注意:通用 I 型实例询价时必须传入与内存对应的 CPU 核数大小
|
|
1481
|
+
*/
|
|
1482
|
+
Cpu?: number;
|
|
1521
1483
|
}
|
|
1522
1484
|
/**
|
|
1523
1485
|
* 备份信息。
|
|
@@ -1749,62 +1711,54 @@ export interface CurrentOp {
|
|
|
1749
1711
|
*/
|
|
1750
1712
|
export interface ModifyDBInstanceSpecRequest {
|
|
1751
1713
|
/**
|
|
1752
|
-
*
|
|
1714
|
+
* <p>实例 ID。请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制实例 ID。</p>
|
|
1753
1715
|
*/
|
|
1754
1716
|
InstanceId: string;
|
|
1755
1717
|
/**
|
|
1756
|
-
*
|
|
1757
|
-
**注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
|
1718
|
+
* <p>实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。<br><strong>注意</strong>:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。</p>
|
|
1758
1719
|
*/
|
|
1759
1720
|
Memory?: number;
|
|
1760
1721
|
/**
|
|
1761
|
-
*
|
|
1762
|
-
- 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
|
1763
|
-
- 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
|
|
1722
|
+
* <p>实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p><ul><li>内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。</li><li>降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。</li></ul>
|
|
1764
1723
|
*/
|
|
1765
1724
|
Volume?: number;
|
|
1766
1725
|
/**
|
|
1767
|
-
* (已废弃) 请使用ResizeOplog
|
|
1768
|
-
|
|
1769
|
-
实例配置变更后 Oplog 的大小。
|
|
1770
|
-
- 单位:GB。
|
|
1771
|
-
- 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
|
|
1726
|
+
* <p>(已废弃) 请使用ResizeOplog独立接口完成。</p><p>实例配置变更后 Oplog 的大小。</p><ul><li>单位:GB。</li><li>默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。</li></ul>
|
|
1772
1727
|
* @deprecated
|
|
1773
1728
|
*/
|
|
1774
1729
|
OplogSize?: number;
|
|
1775
1730
|
/**
|
|
1776
|
-
*
|
|
1777
|
-
- 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。
|
|
1778
|
-
- 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。
|
|
1779
|
-
**说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。
|
|
1731
|
+
* <p>实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。</p><ul><li>副本集节点数:请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo </a>接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。</li><li>分片集群每个分片节点数:请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo </a>接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。<br><strong>说明</strong>:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。</li></ul>
|
|
1780
1732
|
*/
|
|
1781
1733
|
NodeNum?: number;
|
|
1782
1734
|
/**
|
|
1783
|
-
*
|
|
1784
|
-
- 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
|
|
1785
|
-
- 实例分片数量只允许增加不允许减少。
|
|
1735
|
+
* <p>实例变更后的分片数。</p><ul><li>请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 接口返回的参数<strong>MinReplicateSetNum</strong>与<strong>MaxReplicateSetNum</strong>获取实例分片数取值范围。</li><li>实例分片数量只允许增加不允许减少。</li></ul>
|
|
1786
1736
|
*/
|
|
1787
1737
|
ReplicateSetNum?: number;
|
|
1788
1738
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
- 0:调整完成时,立即执行变配任务。默认为0。
|
|
1791
|
-
- 1:在维护时间窗内,执行变配任务。
|
|
1792
|
-
**说明**:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。
|
|
1739
|
+
* <p>实例配置变更的切换时间。</p><ul><li>0:调整完成时,立即执行变配任务。默认为0。</li><li>1:在维护时间窗内,执行变配任务。<br><strong>说明</strong>:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。</li></ul>
|
|
1793
1740
|
*/
|
|
1794
1741
|
InMaintenance?: number;
|
|
1795
1742
|
/**
|
|
1796
|
-
*
|
|
1743
|
+
* <p>分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p>
|
|
1797
1744
|
*/
|
|
1798
1745
|
MongosMemory?: string;
|
|
1799
1746
|
/**
|
|
1800
|
-
*
|
|
1747
|
+
* <p>新增节点列表,节点类型及可用区信息。</p>
|
|
1801
1748
|
*/
|
|
1802
1749
|
AddNodeList?: Array<AddNodeList>;
|
|
1803
1750
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
**注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
|
|
1751
|
+
* <p>删除节点列表。<br><strong>注意</strong>:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。</p>
|
|
1806
1752
|
*/
|
|
1807
1753
|
RemoveNodeList?: Array<RemoveNodeList>;
|
|
1754
|
+
/**
|
|
1755
|
+
* <p>实例配置变更后的CPU大小。单位:C。该参数为空值时,默认取实例当前的 CPU 大小。当前所支持的CPU规格,请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p>
|
|
1756
|
+
*/
|
|
1757
|
+
Cpu?: number;
|
|
1758
|
+
/**
|
|
1759
|
+
* <p>实例配置变更后的产品规格类型。该参数为空值时,默认取实例当前的产品规格类型。<br>当前支持的产品规格类型如下:<br>产品推荐规格类型:</p><ul><li>GE.LD.T1:本地盘(通用I型)。</li><li>GE.CD.T1:云盘(通用I型)。</li></ul><p>产品白名单规格类型:</p><ul><li>HIO10G:本地盘(高IO万兆型)。</li><li>HCD:云盘(云盘版)。</li></ul><p>注意:</p><ol><li>白名单规格类型为白名单控制,如若需要,请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</li><li>通用 I 型不能变更到白名单规格类型</li></ol>
|
|
1760
|
+
*/
|
|
1761
|
+
MachineCode?: string;
|
|
1808
1762
|
}
|
|
1809
1763
|
/**
|
|
1810
1764
|
* DescribeLogDownloadTasks请求参数结构体
|
|
@@ -2132,11 +2086,11 @@ export interface DescribeAsyncRequestInfoResponse {
|
|
|
2132
2086
|
*/
|
|
2133
2087
|
export interface CreateDBInstanceResponse {
|
|
2134
2088
|
/**
|
|
2135
|
-
*
|
|
2089
|
+
* <p>订单ID</p>
|
|
2136
2090
|
*/
|
|
2137
2091
|
DealId?: string;
|
|
2138
2092
|
/**
|
|
2139
|
-
*
|
|
2093
|
+
* <p>创建的实例ID列表</p>
|
|
2140
2094
|
*/
|
|
2141
2095
|
InstanceIds?: Array<string>;
|
|
2142
2096
|
/**
|
|
@@ -2511,7 +2465,7 @@ export interface NodeTag {
|
|
|
2511
2465
|
*/
|
|
2512
2466
|
export interface InquirePriceCreateDBInstancesResponse {
|
|
2513
2467
|
/**
|
|
2514
|
-
*
|
|
2468
|
+
* <p>价格</p>
|
|
2515
2469
|
*/
|
|
2516
2470
|
Price?: DBInstancePrice;
|
|
2517
2471
|
/**
|
|
@@ -2765,158 +2719,117 @@ export interface InquirePriceModifyDBInstanceSpecResponse {
|
|
|
2765
2719
|
*/
|
|
2766
2720
|
export interface CreateDBInstanceHourRequest {
|
|
2767
2721
|
/**
|
|
2768
|
-
*
|
|
2722
|
+
* <p>实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
|
|
2769
2723
|
*/
|
|
2770
2724
|
Memory: number;
|
|
2771
2725
|
/**
|
|
2772
|
-
*
|
|
2726
|
+
* <p>实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
|
|
2773
2727
|
*/
|
|
2774
2728
|
Volume: number;
|
|
2775
2729
|
/**
|
|
2776
|
-
*
|
|
2777
|
-
- 创建分片集群实例,指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
|
|
2730
|
+
* <ul><li>创建副本集实例,指副本集数量,该参数只能为1。</li><li>创建分片集群实例,指分片的数量。请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。</li></ul>
|
|
2778
2731
|
*/
|
|
2779
2732
|
ReplicateSetNum: number;
|
|
2780
2733
|
/**
|
|
2781
|
-
*
|
|
2782
|
-
- 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
2734
|
+
* <ul><li>创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li></ul>
|
|
2783
2735
|
*/
|
|
2784
2736
|
NodeNum: number;
|
|
2785
2737
|
/**
|
|
2786
|
-
*
|
|
2787
|
-
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
|
2788
|
-
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
|
2789
|
-
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
|
2790
|
-
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
|
2791
|
-
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
|
2792
|
-
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
|
2793
|
-
- MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
|
|
2738
|
+
* <p>指版本信息。具体支持的版本信息 ,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p><ul><li>MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。</li><li>MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。</li><li>MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。</li><li>MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。</li><li>MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。</li><li>MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。</li><li>MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。</li></ul>
|
|
2794
2739
|
*/
|
|
2795
2740
|
MongoVersion: string;
|
|
2796
2741
|
/**
|
|
2797
|
-
*
|
|
2798
|
-
- HIO10G:通用高HIO万兆型。
|
|
2799
|
-
- HCD:云盘版类型。
|
|
2742
|
+
* <p>产品推荐规格类型:</p><ul><li>GE.LD.T1:本地盘(通用I型)。</li><li>GE.CD.T1:云盘(通用I型)。</li></ul><p>产品白名单规格类型:</p><ul><li>HIO10G:本地盘(高IO万兆型)。</li><li>HCD:云盘(云盘版)。</li></ul><p>注意:白名单规格类型为白名单控制,如若需要,请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</p>
|
|
2800
2743
|
*/
|
|
2801
2744
|
MachineCode: string;
|
|
2802
2745
|
/**
|
|
2803
|
-
*
|
|
2746
|
+
* <p>实例数量,最小值1,最大值为30。</p>
|
|
2804
2747
|
*/
|
|
2805
2748
|
GoodsNum: number;
|
|
2806
2749
|
/**
|
|
2807
|
-
*
|
|
2808
|
-
- 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
2809
|
-
- 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
|
|
2750
|
+
* <p>可用区信息,输入格式如:ap-guangzhou-2。</p><ul><li>具体信息,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。</li></ul>
|
|
2810
2751
|
*/
|
|
2811
2752
|
Zone: string;
|
|
2812
2753
|
/**
|
|
2813
|
-
*
|
|
2814
|
-
- REPLSET:副本集。
|
|
2815
|
-
- SHARD:分片集群。
|
|
2754
|
+
* <p>实例架构类型。</p><ul><li>REPLSET:副本集。</li><li>SHARD:分片集群。</li></ul>
|
|
2816
2755
|
*/
|
|
2817
2756
|
ClusterType: string;
|
|
2818
2757
|
/**
|
|
2819
|
-
*
|
|
2820
|
-
- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
|
2821
|
-
- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
|
2758
|
+
* <p>私有网络ID。</p><ul><li>仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的私有网络 ID。</li><li>实例创建成功之后,支持更换私有网络。具体操作,请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
|
|
2822
2759
|
*/
|
|
2823
2760
|
VpcId?: string;
|
|
2824
2761
|
/**
|
|
2825
|
-
*
|
|
2826
|
-
- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
|
2827
|
-
- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
|
2762
|
+
* <p>私有网络 VPC 的子网 ID。</p><ul><li>必须在已选的私有网络内指定一个子网。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的子网 ID。</li><li>实例创建成功之后,支持更换私有网络及子网。具体操作,请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
|
|
2828
2763
|
*/
|
|
2829
2764
|
SubnetId?: string;
|
|
2830
2765
|
/**
|
|
2831
|
-
*
|
|
2832
|
-
- 字符个数为[8,32]。
|
|
2833
|
-
- 可输入[A,Z]、[a,z]、[0,9]范围内的字符。
|
|
2834
|
-
- 可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“\*”、括号“()”、下划线“_”。
|
|
2835
|
-
- 不能设置单一的字母或者数字。
|
|
2766
|
+
* <p>实例密码。设置要求如下:</p><ul><li>字符个数为[8,32]。</li><li>可输入[A,Z]、[a,z]、[0,9]范围内的字符。</li><li>可输入的特殊字符包括:感叹号“!”,at“@”,警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。</li><li>不能设置单一的字母或者数字。</li></ul>
|
|
2836
2767
|
*/
|
|
2837
2768
|
Password?: string;
|
|
2838
2769
|
/**
|
|
2839
|
-
*
|
|
2840
|
-
- 若不设置该参数,则为默认项目。
|
|
2841
|
-
- 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面,可获取项目ID。
|
|
2770
|
+
* <p>项目ID。</p><ul><li>若不设置该参数,则为默认项目。</li><li>在 <a href="https://console.cloud.tencent.com/project">MongoDB 控制台项目管理</a>页面,可获取项目ID。</li></ul>
|
|
2842
2771
|
*/
|
|
2843
2772
|
ProjectId?: number;
|
|
2844
2773
|
/**
|
|
2845
|
-
*
|
|
2774
|
+
* <p>实例标签信息。</p>
|
|
2846
2775
|
*/
|
|
2847
2776
|
Tags?: Array<TagInfo>;
|
|
2848
2777
|
/**
|
|
2849
|
-
*
|
|
2850
|
-
- 1:正式实例。
|
|
2851
|
-
- 3:只读实例。
|
|
2852
|
-
- 4:灾备实例。
|
|
2853
|
-
- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
|
2778
|
+
* <p>实例类型。</p><ul><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li><li>5:克隆实例。注意:克隆实例 RestoreTime 为必填项。</li></ul>
|
|
2854
2779
|
*/
|
|
2855
2780
|
Clone?: number;
|
|
2856
2781
|
/**
|
|
2857
|
-
*
|
|
2858
|
-
- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
|
2859
|
-
- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
|
2782
|
+
* <p>父实例 ID。</p><ul><li>当参数<strong>Clone</strong>为3或者4时,即实例为只读或灾备实例时,该参数必须配置。</li><li>请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制父实例 ID。</li></ul>
|
|
2860
2783
|
*/
|
|
2861
2784
|
Father?: string;
|
|
2862
2785
|
/**
|
|
2863
|
-
*
|
|
2786
|
+
* <p>安全组 ID。 请登录<a href="https://console.cloud.tencent.com/vpc/security-group">安全组控制台</a>页面获取与数据库实例同地域的安全组 ID。</p>
|
|
2864
2787
|
*/
|
|
2865
2788
|
SecurityGroup?: Array<string>;
|
|
2866
2789
|
/**
|
|
2867
|
-
*
|
|
2868
|
-
- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
|
|
2869
|
-
- 回档时间范围:仅能回档7天内时间点的数据。
|
|
2790
|
+
* <p>克隆实例回档时间。</p><ul><li>若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。</li><li>回档时间范围:仅能回档7天内时间点的数据。</li></ul>
|
|
2870
2791
|
*/
|
|
2871
2792
|
RestoreTime?: string;
|
|
2872
2793
|
/**
|
|
2873
|
-
*
|
|
2874
|
-
- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
|
|
2875
|
-
- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
|
|
2876
|
-
- 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
|
|
2794
|
+
* <p>实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。</p><ul><li>基础模式:前缀+自动升序编号(默认从1开始),<strong>lnstanceName</strong>仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。</li><li>自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。<strong>InstanceName</strong>需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。</li><li>复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。<strong>instanceName</strong>需填写复合模式串,例如:cmgo{R:10}_node{R:12}_db,设置批量购买数量为5,则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.</li></ul>
|
|
2877
2795
|
*/
|
|
2878
2796
|
InstanceName?: string;
|
|
2879
2797
|
/**
|
|
2880
|
-
*
|
|
2881
|
-
- 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
|
|
2882
|
-
- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
|
|
2883
|
-
- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
|
|
2798
|
+
* <p>若多可用区部署云数据库实例,指定多可用区列表。</p><ul><li>多可用区部署实例,参数 <strong>Zone</strong> 指定实例主可用区信息;<strong>AvailabilityZoneList</strong> 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。</li><li>通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。</li><li>多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。</li></ul>
|
|
2884
2799
|
*/
|
|
2885
2800
|
AvailabilityZoneList?: Array<string>;
|
|
2886
2801
|
/**
|
|
2887
|
-
* Mongos CPU 核数,支持1、2、4、8、16
|
|
2802
|
+
* <p>Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。</p>
|
|
2888
2803
|
*/
|
|
2889
2804
|
MongosCpu?: number;
|
|
2890
2805
|
/**
|
|
2891
|
-
* Mongos
|
|
2892
|
-
- 购买分片集群时,必须填写。
|
|
2893
|
-
- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
|
|
2806
|
+
* <p>Mongos 内存大小。</p><ul><li>购买分片集群时,必须填写。</li><li>单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。</li></ul>
|
|
2894
2807
|
*/
|
|
2895
2808
|
MongosMemory?: number;
|
|
2896
2809
|
/**
|
|
2897
|
-
* Mongos
|
|
2898
|
-
- 单可用区部署实例,其数量范围为[3,32]。
|
|
2899
|
-
- 多可用区部署实例,其数量范围为[6,32]。
|
|
2810
|
+
* <p>Mongos 数量。购买分片集群时,必须填写。</p><ul><li>单可用区部署实例,其数量范围为[3,32]。</li><li>多可用区部署实例,其数量范围为[6,32]。</li></ul>
|
|
2900
2811
|
*/
|
|
2901
2812
|
MongosNodeNum?: number;
|
|
2902
2813
|
/**
|
|
2903
|
-
*
|
|
2814
|
+
* <p>只读节点数量,取值范围[0,5]。</p>
|
|
2904
2815
|
*/
|
|
2905
2816
|
ReadonlyNodeNum?: number;
|
|
2906
2817
|
/**
|
|
2907
|
-
*
|
|
2818
|
+
* <p>指只读节点所属可用区数组。跨可用区部署实例,参数<strong>ReadonlyNodeNum</strong>不为<strong>0</strong>时,必须配置该参数。</p>
|
|
2908
2819
|
*/
|
|
2909
2820
|
ReadonlyNodeAvailabilityZoneList?: Array<string>;
|
|
2910
2821
|
/**
|
|
2911
|
-
* Hidden
|
|
2822
|
+
* <p>Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。</p>
|
|
2912
2823
|
*/
|
|
2913
2824
|
HiddenZone?: string;
|
|
2914
2825
|
/**
|
|
2915
|
-
*
|
|
2916
|
-
- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
|
2917
|
-
- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
|
2826
|
+
* <p>参数模板 ID。</p><ul><li>参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。</li><li>参数模板 ID 可通过 <a href="https://cloud.tencent.com/document/product/240/109155">DescribeDBInstanceParamTpl </a>接口获取。请选择与实例版本与架构所对应的参数模板 ID。</li></ul>
|
|
2918
2827
|
*/
|
|
2919
2828
|
ParamTemplateId?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* <p>实例CPU核大小,单位:C。具体售卖的CPU规格,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。<br>注意:通用 I 型实例必须设置 CPU 大小。</p>
|
|
2831
|
+
*/
|
|
2832
|
+
CpuCore?: number;
|
|
2920
2833
|
}
|
|
2921
2834
|
/**
|
|
2922
2835
|
* 安全组规则
|
|
@@ -4303,93 +4216,81 @@ export interface KMSInfoDetail {
|
|
|
4303
4216
|
*/
|
|
4304
4217
|
export interface InquirePriceCreateDBInstancesRequest {
|
|
4305
4218
|
/**
|
|
4306
|
-
*
|
|
4219
|
+
* <p>实例所属区域及可用区信息。具体信息,请参见<a href="https://cloud.tencent.com/document/product/240/3637">地域和可用区</a>。</p>
|
|
4307
4220
|
*/
|
|
4308
4221
|
Zone: string;
|
|
4309
4222
|
/**
|
|
4310
|
-
*
|
|
4311
|
-
- 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
|
4223
|
+
* <ul><li>创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li></ul>
|
|
4312
4224
|
*/
|
|
4313
4225
|
NodeNum: number;
|
|
4314
4226
|
/**
|
|
4315
|
-
*
|
|
4316
|
-
- 单位:GB。
|
|
4317
|
-
- 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。
|
|
4227
|
+
* <p>实例内存大小。</p><ul><li>单位:GB。</li><li>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。</li></ul>
|
|
4318
4228
|
*/
|
|
4319
4229
|
Memory: number;
|
|
4320
4230
|
/**
|
|
4321
|
-
*
|
|
4322
|
-
- 单位:GB。
|
|
4323
|
-
- 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。
|
|
4231
|
+
* <p>实例硬盘大小。</p><ul><li>单位:GB。</li><li>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。</li></ul>
|
|
4324
4232
|
*/
|
|
4325
4233
|
Volume: number;
|
|
4326
4234
|
/**
|
|
4327
|
-
*
|
|
4328
|
-
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
|
4329
|
-
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
|
4330
|
-
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
|
4331
|
-
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
|
4332
|
-
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
|
4333
|
-
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
|
4334
|
-
- MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。
|
|
4235
|
+
* <p>实例版本信息。具体支持的版本,请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:</p><ul><li>MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。</li><li>MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。</li><li>MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。</li><li>MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。</li><li>MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。</li><li>MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。</li><li>MONGO_80_WT:MongoDB 8.0 WiredTiger存储引擎版本。</li></ul>
|
|
4335
4236
|
*/
|
|
4336
4237
|
MongoVersion: string;
|
|
4337
4238
|
/**
|
|
4338
|
-
*
|
|
4339
|
-
- HIO10G:通用高HIO万兆型。
|
|
4340
|
-
- HCD:云盘版。
|
|
4239
|
+
* <p>产品推荐规格类型:</p><ul><li>GE.LD.T1:本地盘(通用I型)。</li><li>GE.CD.T1:云盘(通用I型)。</li></ul><p>产品白名单规格类型:</p><ul><li>HIO10G:本地盘(高IO万兆型)。</li><li>HCD:云盘(云盘版)。</li></ul><p>注意:白名单规格类型为白名单控制,如若需要,请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</p>
|
|
4341
4240
|
*/
|
|
4342
4241
|
MachineCode: string;
|
|
4343
4242
|
/**
|
|
4344
|
-
*
|
|
4243
|
+
* <p>实例数量,取值范围为[1,10]。</p>
|
|
4345
4244
|
*/
|
|
4346
4245
|
GoodsNum: number;
|
|
4347
4246
|
/**
|
|
4348
|
-
*
|
|
4349
|
-
- REPLSET:副本集。
|
|
4350
|
-
- SHARD:分片集群。
|
|
4247
|
+
* <p>实例类型。</p><ul><li>REPLSET:副本集。</li><li>SHARD:分片集群。</li></ul>
|
|
4351
4248
|
*/
|
|
4352
4249
|
ClusterType: string;
|
|
4353
4250
|
/**
|
|
4354
|
-
*
|
|
4355
|
-
- 创建分片集群实例,指分片的数量。请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
|
|
4251
|
+
* <ul><li>创建副本集实例,指副本集数量,该参数只能为1。</li><li>创建分片集群实例,指分片的数量。请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询分片数量的取值范围,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。</li></ul>
|
|
4356
4252
|
*/
|
|
4357
4253
|
ReplicateSetNum: number;
|
|
4358
4254
|
/**
|
|
4359
|
-
*
|
|
4360
|
-
-选择按量计费,即 <b>InstanceChargeType</b> 设定为 **POSTPAID_BY_HOUR** 时,该参数仅可配置为 1。
|
|
4255
|
+
* <ul><li>选择包年包月计费模式,即 <b>InstanceChargeType </b>设定为<b>PREPAID</b>时,必须设置该参数,指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。<br>-选择按量计费,即 <b>InstanceChargeType</b> 设定为 <strong>POSTPAID_BY_HOUR</strong> 时,该参数仅可配置为 1。</li></ul>
|
|
4361
4256
|
*/
|
|
4362
4257
|
Period?: number;
|
|
4363
4258
|
/**
|
|
4364
|
-
*
|
|
4365
|
-
- PREPAID:包年包月计费。
|
|
4366
|
-
- POSTPAID_BY_HOUR:按量计费。
|
|
4259
|
+
* <p>实例付费方式。</p><ul><li>PREPAID:包年包月计费。</li><li>POSTPAID_BY_HOUR:按量计费。</li></ul>
|
|
4367
4260
|
*/
|
|
4368
4261
|
InstanceChargeType?: string;
|
|
4369
4262
|
/**
|
|
4370
|
-
* Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。注意为空时取默认取值为2C
|
|
4263
|
+
* <p>Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。注意为空时取默认取值为2C。</p>
|
|
4371
4264
|
*/
|
|
4372
4265
|
MongosCpu?: number;
|
|
4373
4266
|
/**
|
|
4374
|
-
* Mongos 内存大小。- 购买分片集群时,必须填写。- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。注意为空时取默认取值为4G
|
|
4267
|
+
* <p>Mongos 内存大小。- 购买分片集群时,必须填写。- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。注意为空时取默认取值为4G。</p>
|
|
4375
4268
|
*/
|
|
4376
4269
|
MongosMemory?: number;
|
|
4377
4270
|
/**
|
|
4378
|
-
*
|
|
4271
|
+
* <p>指 Mongos 个数,取值范围为[3,32]。若为分片集群实例询价,则该参数必须设置。注意为空时取默认取值为3个节点。</p>
|
|
4379
4272
|
*/
|
|
4380
4273
|
MongosNum?: number;
|
|
4381
4274
|
/**
|
|
4382
|
-
*
|
|
4275
|
+
* <p>指 ConfigServer CPU核数,固定取值为 1,单位:GB,可不配置该参数。</p>
|
|
4383
4276
|
*/
|
|
4384
4277
|
ConfigServerCpu?: number;
|
|
4385
4278
|
/**
|
|
4386
|
-
*
|
|
4279
|
+
* <p>指 ConfigServer 内存大小,固定取值为 2,单位:GB,可不配置该参数。</p>
|
|
4387
4280
|
*/
|
|
4388
4281
|
ConfigServerMemory?: number;
|
|
4389
4282
|
/**
|
|
4390
|
-
*
|
|
4283
|
+
* <p>指 ConfigServer 磁盘大小,固定取值为 20,单位:GB,可不配置该参数。</p>
|
|
4391
4284
|
*/
|
|
4392
4285
|
ConfigServerVolume?: number;
|
|
4286
|
+
/**
|
|
4287
|
+
* <ul><li>创建副本集实例,指每个副本集内只读节点数量。 </li><li>创建分片集群实例,指每个分片的只读节点数量。<br>取值范围为[1,5]。</li></ul>
|
|
4288
|
+
*/
|
|
4289
|
+
ReadonlyNodeNum?: number;
|
|
4290
|
+
/**
|
|
4291
|
+
* <p>实例CPU大小。</p><ul><li>单位:C。</li><li>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。</li><li>注意:通用 I 型实例询价时必须传入与内存对应的 CPU 核数大小</li></ul>
|
|
4292
|
+
*/
|
|
4293
|
+
Cpu?: number;
|
|
4393
4294
|
}
|
|
4394
4295
|
/**
|
|
4395
4296
|
* 需要终止的操作。
|
|
@@ -4459,7 +4360,7 @@ export interface DescribeDBInstanceParamTplResponse {
|
|
|
4459
4360
|
*/
|
|
4460
4361
|
export interface ModifyDBInstanceSpecResponse {
|
|
4461
4362
|
/**
|
|
4462
|
-
*
|
|
4363
|
+
* <p>订单 ID。</p>
|
|
4463
4364
|
*/
|
|
4464
4365
|
DealId?: string;
|
|
4465
4366
|
/**
|