tencentcloud-sdk-nodejs-postgres 4.0.645 → 4.0.647

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.
@@ -212,7 +212,12 @@ export interface OpenDBExtranetAccessRequest {
212
212
  */
213
213
  export interface CreateInstancesRequest {
214
214
  /**
215
- * 售卖规格ID。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。
215
+ * 实例所属主可用区, 如:ap-guangzhou-3;若需要支持多可用区,在DBNodeSet.N字段中进行添加主可用区和备可用区信息;
216
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
217
+ */
218
+ Zone: string;
219
+ /**
220
+ * 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
216
221
  */
217
222
  SpecCode: string;
218
223
  /**
@@ -220,132 +225,168 @@ export interface CreateInstancesRequest {
220
225
  */
221
226
  Storage: number;
222
227
  /**
223
- * 一次性购买的实例数量。取值1-10
228
+ * 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
224
229
  */
225
230
  InstanceCount: number;
226
231
  /**
227
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
232
+ * 购买时长,单位:月。
233
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
234
+ <li>后付费:只支持1
228
235
  */
229
236
  Period: number;
230
237
  /**
231
- * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
232
- */
233
- Zone: string;
234
- /**
235
- * 实例字符集,目前只支持:UTF8、LATIN1。
238
+ * 实例字符集,目前只支持:
239
+ <li> UTF8
240
+ <li> LATIN1
236
241
  */
237
242
  Charset: string;
238
243
  /**
239
- * 实例根账号用户名。
244
+ * 实例根账号用户名,具体规范如下:
245
+ <li>用户名需要1-16个字符,只能由字母、数字或下划线组成
246
+ <li>不能为postgres
247
+ <li>不能由数字和pg_开头
248
+ <li>所有规则均不区分大小写
240
249
  */
241
250
  AdminName: string;
242
251
  /**
243
- * 实例根账号用户名对应的密码。
252
+ * 实例根账号用户名对应的密码,长度8 ~ 32位,推荐使用12位以上的密码;不能以" / "开头;
253
+ 必须包含以下四项,字符种类:
254
+ <li>小写字母: [a ~ z]
255
+ <li>大写字母:[A ~ Z]
256
+ <li>数字:0 - 9
257
+ <li>特殊字符:()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
244
258
  */
245
259
  AdminPassword: string;
246
260
  /**
247
- * 项目ID。
261
+ * PostgreSQL大版本号,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取,目前支持10,11,12,13,14,15这几个大版本。
262
+ 当只输入该参数时,会基于此大版本号创建对应的最新小版本的最新内核版本号实例。
263
+ 该参数和DBVersion、DBKernelVersion需要至少指定一个,如无指定购买内核小版本需求时,只传入该参数即可。
264
+
248
265
  */
249
- ProjectId?: number;
266
+ DBMajorVersion?: string;
250
267
  /**
251
- * PostgreSQL版本。当输入该参数时,会基于此版本创建对应的最新内核版本号实例。该参数和DBMajorVersion、DBKernelVersion至少需要传递一个。
268
+ * PostgreSQL社区大版本+小版本号,如12.4,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
269
+ 当只输入该参数时,会基于此社区小版本号创建对应的最新内核版本实例。
270
+ 该参数和DBMajorVersion、DBKernelVersion需要至少指定一个。
252
271
  */
253
272
  DBVersion?: string;
254
273
  /**
255
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。
256
- */
257
- InstanceChargeType?: string;
258
- /**
259
- * 是否自动使用代金券。1(是),0(否),默认不使用。
274
+ * PostgreSQL内核版本号,如v12.7_r1.8,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
275
+ 当只输入该参数时,会创建指定的内核版本实例。只针对内核版本需要指定时使用,一般场景不推荐传入该参数。
276
+
260
277
  */
261
- AutoVoucher?: number;
278
+ DBKernelVersion?: string;
262
279
  /**
263
- * 代金券ID列表,目前仅支持指定一张代金券。
280
+ * 实例计费类型,目前支持:
281
+ <li>PREPAID:预付费,即包年包月
282
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
283
+ 默认值:PREPAID
264
284
  */
265
- VoucherIds?: Array<string>;
285
+ InstanceChargeType?: string;
266
286
  /**
267
- * 私有网络ID
287
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
268
288
  */
269
289
  VpcId?: string;
270
290
  /**
271
- * 已配置的私有网络中的子网ID
291
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
272
292
  */
273
293
  SubnetId?: string;
274
294
  /**
275
- * 续费标记:0-正常续费(默认);1-自动续费。
295
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
296
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
276
297
  */
277
- AutoRenewFlag?: number;
298
+ DBNodeSet?: Array<DBNode>;
278
299
  /**
279
- * 活动ID。
300
+ * 续费标记:
301
+ <li>0:手动续费
302
+ <li>1:自动续费
303
+ 默认值:0
280
304
  */
281
- ActivityId?: number;
305
+ AutoRenewFlag?: number;
282
306
  /**
283
- * 实例名。
307
+ * 是否自动使用代金券:
308
+ <li>0:否
309
+ <li>1:是
310
+ 默认值:0
284
311
  */
285
- Name?: string;
312
+ AutoVoucher?: number;
286
313
  /**
287
- * 是否需要支持Ipv6,1:是,0:否(默认)。
314
+ * 代金券ID列表,目前仅支持指定一张代金券。
288
315
  */
289
- NeedSupportIpv6?: number;
316
+ VoucherIds?: Array<string>;
290
317
  /**
291
- * 实例需要绑定的Tag信息,默认为空。
318
+ * 项目ID。
292
319
  */
293
- TagList?: Array<Tag>;
320
+ ProjectId?: number;
294
321
  /**
295
- * 安全组ID。
322
+ * 活动ID。
296
323
  */
297
- SecurityGroupIds?: Array<string>;
324
+ ActivityId?: number;
298
325
  /**
299
- * PostgreSQL主要版本。目前支持10,11,12,13这几个版本。当输入该参数时,会基于此版本创建对应的最新内核版本号实例。该参数和DBVersion、DBKernelVersion至少需要传递一个。
326
+ * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
327
+
300
328
  */
301
- DBMajorVersion?: string;
329
+ Name?: string;
302
330
  /**
303
- * PostgreSQL内核版本。当输入该参数时,会创建该内核版本号实例。该参数和DBVersion、DBMajorVersion至少需要传递一个。
331
+ * 实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
304
332
  */
305
- DBKernelVersion?: string;
333
+ TagList?: Array<Tag>;
306
334
  /**
307
- * 实例节点信息,购买跨可用区实例时填写。
335
+ * 实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
336
+
308
337
  */
309
- DBNodeSet?: Array<DBNode>;
338
+ SecurityGroupIds?: Array<string>;
310
339
  /**
311
- * 是否需要支持数据透明加密,1:是,0:否(默认)。
340
+ * 是否需要支持数据透明加密:
341
+ <li>0:否
342
+ <li>1:是
343
+ 默认值:0
344
+ 参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
312
345
  */
313
346
  NeedSupportTDE?: number;
314
347
  /**
315
348
  * 自定义密钥的KeyId,若选择自定义密匙加密,则需要传入自定义密匙的KeyId,KeyId是CMK的唯一标识。
349
+ KeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
316
350
  */
317
351
  KMSKeyId?: string;
318
352
  /**
319
353
  * 使用KMS服务的地域,KMSRegion为空默认使用本地域的KMS,本地域不支持的情况下需自选其他KMS支持的地域。
354
+ KMSRegion相关介绍参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
320
355
  */
321
356
  KMSRegion?: string;
322
357
  /**
323
358
  * 数据库引擎,支持:
324
- 1、postgresql(云数据库PostgreSQL);
325
- 2、mssql_compatibleMSSQL兼容-云数据库PostgreSQL);
326
- 如不指定默认使用postgresql
359
+ <li>postgresql:云数据库PostgreSQL
360
+ <li>mssql_compatibleMSSQL兼容-云数据库PostgreSQL
361
+ 默认值:postgresql
327
362
  */
328
363
  DBEngine?: string;
329
364
  /**
330
365
  * 数据库引擎的配置信息,配置格式如下:
331
366
  {"$key1":"$value1", "$key2":"$value2"}
332
-
333
367
  各引擎支持如下:
334
- 1、mssql_compatible引擎:
335
- migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
336
- defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
368
+ mssql_compatible引擎:
369
+ <li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
370
+ <li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
337
371
  "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。
338
- serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:
339
- "bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。
372
+ <li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:"bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。
340
373
  */
341
374
  DBEngineConfig?: string;
342
375
  /**
343
- * 主从同步方式,可取值:
344
- 1、Semi-sync:半同步
345
- 2、Async:异步
346
- 当前只支持Semi-sync
376
+ * 主从同步方式,支持:
377
+ <li>Semi-sync:半同步
378
+ <li>Async:异步
379
+ 主实例默认值:Semi-sync
380
+ 只读实例默认值:Async
347
381
  */
348
382
  SyncMode?: string;
383
+ /**
384
+ * 是否需要支持Ipv6:
385
+ <li>0:否
386
+ <li>1:是
387
+ 默认值:0
388
+ */
389
+ NeedSupportIpv6?: number;
349
390
  }
350
391
  /**
351
392
  * 描述一种规格的信息
@@ -1134,17 +1175,17 @@ export interface CloneDBInstanceResponse {
1134
1175
  * 订单号。
1135
1176
  注意:此字段可能返回 null,表示取不到有效值。
1136
1177
  */
1137
- DealName: string;
1178
+ DealName?: string;
1138
1179
  /**
1139
1180
  * 订单流水号。
1140
1181
  注意:此字段可能返回 null,表示取不到有效值。
1141
1182
  */
1142
- BillId: string;
1183
+ BillId?: string;
1143
1184
  /**
1144
1185
  * 克隆出的新实例ID,当前只支持后付费返回该值。
1145
1186
  注意:此字段可能返回 null,表示取不到有效值。
1146
1187
  */
1147
- DBInstanceId: string;
1188
+ DBInstanceId?: string;
1148
1189
  /**
1149
1190
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1150
1191
  */
@@ -2193,7 +2234,7 @@ export interface CloneDBInstanceRequest {
2193
2234
  */
2194
2235
  DBInstanceId: string;
2195
2236
  /**
2196
- * 售卖规格ID。该参数可以通过调用DescribeProductConfig的返回值中的SpecCode字段来获取。
2237
+ * 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
2197
2238
  */
2198
2239
  SpecCode: string;
2199
2240
  /**
@@ -2201,31 +2242,40 @@ export interface CloneDBInstanceRequest {
2201
2242
  */
2202
2243
  Storage: number;
2203
2244
  /**
2204
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
2245
+ * 购买时长,单位:月。
2246
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
2247
+ <li>后付费:只支持1
2205
2248
  */
2206
2249
  Period: number;
2207
2250
  /**
2208
- * 续费标记:0-正常续费(默认);1-自动续费。
2251
+ * 续费标记:
2252
+ <li>0:手动续费
2253
+ <li>1:自动续费
2254
+ 默认值:0
2209
2255
  */
2210
2256
  AutoRenewFlag: number;
2211
2257
  /**
2212
- * 私有网络ID
2258
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
2213
2259
  */
2214
2260
  VpcId: string;
2215
2261
  /**
2216
- * 已配置的私有网络中的子网ID
2262
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
2217
2263
  */
2218
2264
  SubnetId: string;
2219
2265
  /**
2220
- * 新购实例的实例名称。
2266
+ * 新购的实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
2221
2267
  */
2222
2268
  Name?: string;
2223
2269
  /**
2224
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。
2270
+ * 实例计费类型,目前支持:
2271
+ <li>PREPAID:预付费,即包年包月
2272
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
2273
+ 默认值:PREPAID
2225
2274
  */
2226
2275
  InstanceChargeType?: string;
2227
2276
  /**
2228
- * 安全组ID。
2277
+ * 实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
2278
+
2229
2279
  */
2230
2280
  SecurityGroupIds?: Array<string>;
2231
2281
  /**
@@ -2233,15 +2283,19 @@ export interface CloneDBInstanceRequest {
2233
2283
  */
2234
2284
  ProjectId?: number;
2235
2285
  /**
2236
- * 实例需要绑定的Tag信息,默认为空。
2286
+ * 实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
2237
2287
  */
2238
2288
  TagList?: Array<Tag>;
2239
2289
  /**
2240
- * 购买多可用区实例时填写。
2290
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
2291
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
2241
2292
  */
2242
2293
  DBNodeSet?: Array<DBNode>;
2243
2294
  /**
2244
- * 是否自动使用代金券。1(是),0(否),默认不使用。
2295
+ * 是否自动使用代金券:
2296
+ <li>0:否
2297
+ <li>1:是
2298
+ 默认值:0
2245
2299
  */
2246
2300
  AutoVoucher?: number;
2247
2301
  /**
@@ -2260,6 +2314,14 @@ export interface CloneDBInstanceRequest {
2260
2314
  * 恢复时间点。
2261
2315
  */
2262
2316
  RecoveryTargetTime?: string;
2317
+ /**
2318
+ * 主从同步方式,支持:
2319
+ <li>Semi-sync:半同步
2320
+ <li>Async:异步
2321
+ 主实例默认值:Semi-sync
2322
+ 只读实例默认值:Async
2323
+ */
2324
+ SyncMode?: string;
2263
2325
  }
2264
2326
  /**
2265
2327
  * DeleteParameterTemplate请求参数结构体
@@ -3280,175 +3342,201 @@ export interface ModifyDBInstanceDeploymentResponse {
3280
3342
  */
3281
3343
  export interface DBInstance {
3282
3344
  /**
3283
- * 实例所属地域,如: ap-guangzhou,对应RegionSet的Region字段
3284
- */
3285
- Region: string;
3286
- /**
3287
- * 实例所属可用区, 如:ap-guangzhou-3,对应ZoneSet的Zone字段
3345
+ * 实例所属地域,如: ap-guangzhou,对应RegionSet的Region字段。
3288
3346
  */
3289
- Zone: string;
3347
+ Region?: string;
3290
3348
  /**
3291
- * 项目ID
3349
+ * 实例所属可用区, 如:ap-guangzhou-3,对应ZoneSet的Zone字段。
3292
3350
  */
3293
- ProjectId: number;
3351
+ Zone?: string;
3294
3352
  /**
3295
- * 私有网络ID
3353
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
3296
3354
  */
3297
- VpcId: string;
3355
+ VpcId?: string;
3298
3356
  /**
3299
- * 子网ID
3357
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
3300
3358
  */
3301
- SubnetId: string;
3359
+ SubnetId?: string;
3302
3360
  /**
3303
- * 实例ID
3361
+ * 实例ID
3304
3362
  */
3305
- DBInstanceId: string;
3363
+ DBInstanceId?: string;
3306
3364
  /**
3307
- * 实例名称
3365
+ * 实例名称。
3308
3366
  */
3309
- DBInstanceName: string;
3367
+ DBInstanceName?: string;
3310
3368
  /**
3311
- * 实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、waitSwitch(等待切换)、switching(切换中)、readonly(只读)、restarting(重启中)、network changing(网络变更中)、upgrading(内核版本升级中)
3369
+ * 实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、waitSwitch(等待切换)、switching(切换中)、readonly(只读)、restarting(重启中)、network changing(网络变更中)、upgrading(内核版本升级中)、audit-switching(审计状态变更中)、primary-switching(主备切换中)
3312
3370
  */
3313
- DBInstanceStatus: string;
3371
+ DBInstanceStatus?: string;
3314
3372
  /**
3315
3373
  * 实例分配的内存大小,单位:GB
3316
3374
  */
3317
- DBInstanceMemory: number;
3375
+ DBInstanceMemory?: number;
3318
3376
  /**
3319
3377
  * 实例分配的存储空间大小,单位:GB
3320
3378
  */
3321
- DBInstanceStorage: number;
3379
+ DBInstanceStorage?: number;
3322
3380
  /**
3323
3381
  * 实例分配的CPU数量,单位:个
3324
3382
  */
3325
- DBInstanceCpu: number;
3383
+ DBInstanceCpu?: number;
3326
3384
  /**
3327
3385
  * 售卖规格ID
3328
3386
  */
3329
- DBInstanceClass: string;
3387
+ DBInstanceClass?: string;
3330
3388
  /**
3331
- * 实例类型,类型有:1、primary(主实例);2、readonly(只读实例);3、guard(灾备实例);4、temp(临时实例)
3389
+ * PostgreSQL大版本号,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取,目前支持10,11,12,13,14,15这几个大版本。
3390
+ 注意:此字段可能返回 null,表示取不到有效值。
3332
3391
  */
3333
- DBInstanceType: string;
3392
+ DBMajorVersion?: string;
3334
3393
  /**
3335
- * 实例版本,目前只支持standard(双机高可用版, 一主一从)
3394
+ * PostgreSQL社区大版本+小版本号,如12.4,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
3336
3395
  */
3337
- DBInstanceVersion: string;
3396
+ DBVersion?: string;
3338
3397
  /**
3339
- * 实例DB字符集
3398
+ * PostgreSQL内核版本号,如v12.7_r1.8,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
3399
+ 注意:此字段可能返回 null,表示取不到有效值。
3340
3400
  */
3341
- DBCharset: string;
3401
+ DBKernelVersion?: string;
3342
3402
  /**
3343
- * PostgreSQL版本
3403
+ * 实例类型,类型有:
3404
+ <li>primary:主实例
3405
+ <li>readonly:只读实例
3406
+ <li>guard:灾备实例
3407
+ <li>temp:临时实例
3344
3408
  */
3345
- DBVersion: string;
3409
+ DBInstanceType?: string;
3346
3410
  /**
3347
- * 实例创建时间
3411
+ * 实例版本,目前只支持standard(双机高可用版, 一主一从)。
3348
3412
  */
3349
- CreateTime: string;
3413
+ DBInstanceVersion?: string;
3350
3414
  /**
3351
- * 实例执行最后一次更新的时间
3415
+ * 实例字符集,目前只支持:
3416
+ <li> UTF8
3417
+ <li> LATIN1
3352
3418
  */
3353
- UpdateTime: string;
3419
+ DBCharset?: string;
3354
3420
  /**
3355
- * 实例到期时间
3421
+ * 实例创建时间。
3356
3422
  */
3357
- ExpireTime: string;
3423
+ CreateTime?: string;
3358
3424
  /**
3359
- * 实例隔离时间
3425
+ * 实例执行最后一次更新的时间。
3360
3426
  */
3361
- IsolatedTime: string;
3427
+ UpdateTime?: string;
3362
3428
  /**
3363
- * 计费模式,1、prepaid(包年包月,预付费);2、postpaid(按量计费,后付费)
3429
+ * 实例到期时间。
3364
3430
  */
3365
- PayType: string;
3431
+ ExpireTime?: string;
3366
3432
  /**
3367
- * 是否自动续费,1:自动续费,0:不自动续费
3433
+ * 实例隔离时间。
3368
3434
  */
3369
- AutoRenew: number;
3435
+ IsolatedTime?: string;
3370
3436
  /**
3371
- * 实例网络连接信息
3437
+ * 计费模式:
3438
+ <li>prepaid:包年包月,预付费
3439
+ <li>postpaid:按量计费,后付费
3372
3440
  */
3373
- DBInstanceNetInfo: Array<DBInstanceNetInfo>;
3441
+ PayType?: string;
3374
3442
  /**
3375
- * 机器类型
3443
+ * 是否自动续费:
3444
+ <li>0:手动续费
3445
+ <li>1:自动续费
3446
+ 默认值:0
3376
3447
  */
3377
- Type: string;
3448
+ AutoRenew?: number;
3378
3449
  /**
3379
- * 用户的AppId
3450
+ * 实例网络连接信息。
3380
3451
  */
3381
- AppId: number;
3452
+ DBInstanceNetInfo?: Array<DBInstanceNetInfo>;
3382
3453
  /**
3383
- * 实例的Uid
3454
+ * 机器类型。
3384
3455
  */
3385
- Uid: number;
3456
+ Type?: string;
3386
3457
  /**
3387
- * 实例是否支持Ipv6,1:支持,0:不支持
3458
+ * 用户的AppId。
3388
3459
  */
3389
- SupportIpv6: number;
3460
+ AppId?: number;
3390
3461
  /**
3391
- * 实例绑定的标签信息
3392
- 注意:此字段可能返回 null,表示取不到有效值。
3462
+ * 实例的Uid。
3393
3463
  */
3394
- TagList: Array<Tag>;
3464
+ Uid?: number;
3395
3465
  /**
3396
- * 主实例信息,仅在实例为只读实例时返回
3397
- 注意:此字段可能返回 null,表示取不到有效值。
3466
+ * 项目ID。
3398
3467
  */
3399
- MasterDBInstanceId: string;
3468
+ ProjectId?: number;
3400
3469
  /**
3401
- * 只读实例数量
3470
+ * 实例绑定的标签信息。
3402
3471
  注意:此字段可能返回 null,表示取不到有效值。
3403
3472
  */
3404
- ReadOnlyInstanceNum: number;
3473
+ TagList?: Array<Tag>;
3405
3474
  /**
3406
- * 只读实例在只读组中的状态
3475
+ * 主实例信息,仅在实例为只读实例时返回。
3407
3476
  注意:此字段可能返回 null,表示取不到有效值。
3408
3477
  */
3409
- StatusInReadonlyGroup: string;
3478
+ MasterDBInstanceId?: string;
3410
3479
  /**
3411
- * 下线时间
3480
+ * 只读实例数量。
3412
3481
  注意:此字段可能返回 null,表示取不到有效值。
3413
3482
  */
3414
- OfflineTime: string;
3483
+ ReadOnlyInstanceNum?: number;
3415
3484
  /**
3416
- * 数据库内核版本
3485
+ * 只读实例在只读组中的状态。
3417
3486
  注意:此字段可能返回 null,表示取不到有效值。
3418
3487
  */
3419
- DBKernelVersion: string;
3488
+ StatusInReadonlyGroup?: string;
3420
3489
  /**
3421
- * 实例网络信息列表(此字段已废弃)
3490
+ * 下线时间。
3422
3491
  注意:此字段可能返回 null,表示取不到有效值。
3423
3492
  */
3424
- NetworkAccessList: Array<NetworkAccess>;
3493
+ OfflineTime?: string;
3425
3494
  /**
3426
- * PostgreSQL主要版本
3495
+ * 实例的节点信息。
3427
3496
  注意:此字段可能返回 null,表示取不到有效值。
3428
3497
  */
3429
- DBMajorVersion: string;
3498
+ DBNodeSet?: Array<DBNode>;
3430
3499
  /**
3431
- * 实例的节点信息
3500
+ * 实例是否支持TDE数据加密:
3501
+ <li>0:不支持
3502
+ <li>1:支持
3503
+ 默认值:0
3504
+ TDE数据加密可参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
3432
3505
  注意:此字段可能返回 null,表示取不到有效值。
3433
3506
  */
3434
- DBNodeSet: Array<DBNode>;
3507
+ IsSupportTDE?: number;
3435
3508
  /**
3436
- * 实例是否支持TDE数据加密 0:不支持,1:支持
3509
+ * 数据库引擎,支持:
3510
+ <li>postgresql:云数据库PostgreSQL
3511
+ <li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL
3512
+ 默认值:postgresql
3437
3513
  注意:此字段可能返回 null,表示取不到有效值。
3438
3514
  */
3439
- IsSupportTDE: number;
3515
+ DBEngine?: string;
3440
3516
  /**
3441
- * 数据库引擎,支持:
3442
- 1、postgresql(云数据库PostgreSQL);
3443
- 2、mssql_compatible(MSSQL兼容-云数据库PostgreSQL);
3517
+ * 数据库引擎的配置信息,配置格式如下:
3518
+ {"$key1":"$value1", "$key2":"$value2"}
3519
+ 各引擎支持如下:
3520
+ mssql_compatible引擎:
3521
+ <li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
3522
+ <li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
3523
+ "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。
3524
+ <li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:"bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。
3444
3525
  注意:此字段可能返回 null,表示取不到有效值。
3445
3526
  */
3446
- DBEngine: string;
3527
+ DBEngineConfig?: string;
3447
3528
  /**
3448
- * 数据库引擎的配置信息
3529
+ * 实例网络信息列表(此字段已废弃)
3449
3530
  注意:此字段可能返回 null,表示取不到有效值。
3450
3531
  */
3451
- DBEngineConfig: string;
3532
+ NetworkAccessList?: Array<NetworkAccess>;
3533
+ /**
3534
+ * 实例是否支持Ipv6:
3535
+ <li>0:否
3536
+ <li>1:是
3537
+ 默认值:0
3538
+ */
3539
+ SupportIpv6?: number;
3452
3540
  }
3453
3541
  /**
3454
3542
  * DeleteParameterTemplate返回参数结构体