tencentcloud-sdk-nodejs-postgres 4.0.646 → 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.
@@ -237,7 +237,12 @@ export interface OpenDBExtranetAccessRequest {
237
237
  */
238
238
  export interface CreateInstancesRequest {
239
239
  /**
240
- * 售卖规格ID。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。
240
+ * 实例所属主可用区, 如:ap-guangzhou-3;若需要支持多可用区,在DBNodeSet.N字段中进行添加主可用区和备可用区信息;
241
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
242
+ */
243
+ Zone: string
244
+ /**
245
+ * 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
241
246
  */
242
247
  SpecCode: string
243
248
  /**
@@ -245,132 +250,168 @@ export interface CreateInstancesRequest {
245
250
  */
246
251
  Storage: number
247
252
  /**
248
- * 一次性购买的实例数量。取值1-10
253
+ * 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
249
254
  */
250
255
  InstanceCount: number
251
256
  /**
252
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
257
+ * 购买时长,单位:月。
258
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
259
+ <li>后付费:只支持1
253
260
  */
254
261
  Period: number
255
262
  /**
256
- * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
257
- */
258
- Zone: string
259
- /**
260
- * 实例字符集,目前只支持:UTF8、LATIN1。
263
+ * 实例字符集,目前只支持:
264
+ <li> UTF8
265
+ <li> LATIN1
261
266
  */
262
267
  Charset: string
263
268
  /**
264
- * 实例根账号用户名。
269
+ * 实例根账号用户名,具体规范如下:
270
+ <li>用户名需要1-16个字符,只能由字母、数字或下划线组成
271
+ <li>不能为postgres
272
+ <li>不能由数字和pg_开头
273
+ <li>所有规则均不区分大小写
265
274
  */
266
275
  AdminName: string
267
276
  /**
268
- * 实例根账号用户名对应的密码。
277
+ * 实例根账号用户名对应的密码,长度8 ~ 32位,推荐使用12位以上的密码;不能以" / "开头;
278
+ 必须包含以下四项,字符种类:
279
+ <li>小写字母: [a ~ z]
280
+ <li>大写字母:[A ~ Z]
281
+ <li>数字:0 - 9
282
+ <li>特殊字符:()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
269
283
  */
270
284
  AdminPassword: string
271
285
  /**
272
- * 项目ID。
286
+ * PostgreSQL大版本号,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取,目前支持10,11,12,13,14,15这几个大版本。
287
+ 当只输入该参数时,会基于此大版本号创建对应的最新小版本的最新内核版本号实例。
288
+ 该参数和DBVersion、DBKernelVersion需要至少指定一个,如无指定购买内核小版本需求时,只传入该参数即可。
289
+
273
290
  */
274
- ProjectId?: number
291
+ DBMajorVersion?: string
275
292
  /**
276
- * PostgreSQL版本。当输入该参数时,会基于此版本创建对应的最新内核版本号实例。该参数和DBMajorVersion、DBKernelVersion至少需要传递一个。
293
+ * PostgreSQL社区大版本+小版本号,如12.4,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
294
+ 当只输入该参数时,会基于此社区小版本号创建对应的最新内核版本实例。
295
+ 该参数和DBMajorVersion、DBKernelVersion需要至少指定一个。
277
296
  */
278
297
  DBVersion?: string
279
298
  /**
280
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。
281
- */
282
- InstanceChargeType?: string
283
- /**
284
- * 是否自动使用代金券。1(是),0(否),默认不使用。
299
+ * PostgreSQL内核版本号,如v12.7_r1.8,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
300
+ 当只输入该参数时,会创建指定的内核版本实例。只针对内核版本需要指定时使用,一般场景不推荐传入该参数。
301
+
285
302
  */
286
- AutoVoucher?: number
303
+ DBKernelVersion?: string
287
304
  /**
288
- * 代金券ID列表,目前仅支持指定一张代金券。
305
+ * 实例计费类型,目前支持:
306
+ <li>PREPAID:预付费,即包年包月
307
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
308
+ 默认值:PREPAID
289
309
  */
290
- VoucherIds?: Array<string>
310
+ InstanceChargeType?: string
291
311
  /**
292
- * 私有网络ID
312
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
293
313
  */
294
314
  VpcId?: string
295
315
  /**
296
- * 已配置的私有网络中的子网ID
316
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
297
317
  */
298
318
  SubnetId?: string
299
319
  /**
300
- * 续费标记:0-正常续费(默认);1-自动续费。
320
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
321
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
301
322
  */
302
- AutoRenewFlag?: number
323
+ DBNodeSet?: Array<DBNode>
303
324
  /**
304
- * 活动ID。
325
+ * 续费标记:
326
+ <li>0:手动续费
327
+ <li>1:自动续费
328
+ 默认值:0
305
329
  */
306
- ActivityId?: number
330
+ AutoRenewFlag?: number
307
331
  /**
308
- * 实例名。
332
+ * 是否自动使用代金券:
333
+ <li>0:否
334
+ <li>1:是
335
+ 默认值:0
309
336
  */
310
- Name?: string
337
+ AutoVoucher?: number
311
338
  /**
312
- * 是否需要支持Ipv6,1:是,0:否(默认)。
339
+ * 代金券ID列表,目前仅支持指定一张代金券。
313
340
  */
314
- NeedSupportIpv6?: number
341
+ VoucherIds?: Array<string>
315
342
  /**
316
- * 实例需要绑定的Tag信息,默认为空。
343
+ * 项目ID。
317
344
  */
318
- TagList?: Array<Tag>
345
+ ProjectId?: number
319
346
  /**
320
- * 安全组ID。
347
+ * 活动ID。
321
348
  */
322
- SecurityGroupIds?: Array<string>
349
+ ActivityId?: number
323
350
  /**
324
- * PostgreSQL主要版本。目前支持10,11,12,13这几个版本。当输入该参数时,会基于此版本创建对应的最新内核版本号实例。该参数和DBVersion、DBKernelVersion至少需要传递一个。
351
+ * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
352
+
325
353
  */
326
- DBMajorVersion?: string
354
+ Name?: string
327
355
  /**
328
- * PostgreSQL内核版本。当输入该参数时,会创建该内核版本号实例。该参数和DBVersion、DBMajorVersion至少需要传递一个。
356
+ * 实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
329
357
  */
330
- DBKernelVersion?: string
358
+ TagList?: Array<Tag>
331
359
  /**
332
- * 实例节点信息,购买跨可用区实例时填写。
360
+ * 实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
361
+
333
362
  */
334
- DBNodeSet?: Array<DBNode>
363
+ SecurityGroupIds?: Array<string>
335
364
  /**
336
- * 是否需要支持数据透明加密,1:是,0:否(默认)。
365
+ * 是否需要支持数据透明加密:
366
+ <li>0:否
367
+ <li>1:是
368
+ 默认值:0
369
+ 参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
337
370
  */
338
371
  NeedSupportTDE?: number
339
372
  /**
340
373
  * 自定义密钥的KeyId,若选择自定义密匙加密,则需要传入自定义密匙的KeyId,KeyId是CMK的唯一标识。
374
+ KeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
341
375
  */
342
376
  KMSKeyId?: string
343
377
  /**
344
378
  * 使用KMS服务的地域,KMSRegion为空默认使用本地域的KMS,本地域不支持的情况下需自选其他KMS支持的地域。
379
+ KMSRegion相关介绍参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
345
380
  */
346
381
  KMSRegion?: string
347
382
  /**
348
383
  * 数据库引擎,支持:
349
- 1、postgresql(云数据库PostgreSQL);
350
- 2、mssql_compatibleMSSQL兼容-云数据库PostgreSQL);
351
- 如不指定默认使用postgresql
384
+ <li>postgresql:云数据库PostgreSQL
385
+ <li>mssql_compatibleMSSQL兼容-云数据库PostgreSQL
386
+ 默认值:postgresql
352
387
  */
353
388
  DBEngine?: string
354
389
  /**
355
390
  * 数据库引擎的配置信息,配置格式如下:
356
391
  {"$key1":"$value1", "$key2":"$value2"}
357
-
358
392
  各引擎支持如下:
359
- 1、mssql_compatible引擎:
360
- migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
361
- defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
393
+ mssql_compatible引擎:
394
+ <li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
395
+ <li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
362
396
  "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"。
363
- serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:
364
- "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"。
397
+ <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"。
365
398
  */
366
399
  DBEngineConfig?: string
367
400
  /**
368
- * 主从同步方式,可取值:
369
- 1、Semi-sync:半同步
370
- 2、Async:异步
371
- 当前只支持Semi-sync
401
+ * 主从同步方式,支持:
402
+ <li>Semi-sync:半同步
403
+ <li>Async:异步
404
+ 主实例默认值:Semi-sync
405
+ 只读实例默认值:Async
372
406
  */
373
407
  SyncMode?: string
408
+ /**
409
+ * 是否需要支持Ipv6:
410
+ <li>0:否
411
+ <li>1:是
412
+ 默认值:0
413
+ */
414
+ NeedSupportIpv6?: number
374
415
  }
375
416
 
376
417
  /**
@@ -1198,17 +1239,17 @@ export interface CloneDBInstanceResponse {
1198
1239
  * 订单号。
1199
1240
  注意:此字段可能返回 null,表示取不到有效值。
1200
1241
  */
1201
- DealName: string
1242
+ DealName?: string
1202
1243
  /**
1203
1244
  * 订单流水号。
1204
1245
  注意:此字段可能返回 null,表示取不到有效值。
1205
1246
  */
1206
- BillId: string
1247
+ BillId?: string
1207
1248
  /**
1208
1249
  * 克隆出的新实例ID,当前只支持后付费返回该值。
1209
1250
  注意:此字段可能返回 null,表示取不到有效值。
1210
1251
  */
1211
- DBInstanceId: string
1252
+ DBInstanceId?: string
1212
1253
  /**
1213
1254
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1214
1255
  */
@@ -2300,7 +2341,7 @@ export interface CloneDBInstanceRequest {
2300
2341
  */
2301
2342
  DBInstanceId: string
2302
2343
  /**
2303
- * 售卖规格ID。该参数可以通过调用DescribeProductConfig的返回值中的SpecCode字段来获取。
2344
+ * 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
2304
2345
  */
2305
2346
  SpecCode: string
2306
2347
  /**
@@ -2308,31 +2349,40 @@ export interface CloneDBInstanceRequest {
2308
2349
  */
2309
2350
  Storage: number
2310
2351
  /**
2311
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
2352
+ * 购买时长,单位:月。
2353
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
2354
+ <li>后付费:只支持1
2312
2355
  */
2313
2356
  Period: number
2314
2357
  /**
2315
- * 续费标记:0-正常续费(默认);1-自动续费。
2358
+ * 续费标记:
2359
+ <li>0:手动续费
2360
+ <li>1:自动续费
2361
+ 默认值:0
2316
2362
  */
2317
2363
  AutoRenewFlag: number
2318
2364
  /**
2319
- * 私有网络ID
2365
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
2320
2366
  */
2321
2367
  VpcId: string
2322
2368
  /**
2323
- * 已配置的私有网络中的子网ID
2369
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
2324
2370
  */
2325
2371
  SubnetId: string
2326
2372
  /**
2327
- * 新购实例的实例名称。
2373
+ * 新购的实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
2328
2374
  */
2329
2375
  Name?: string
2330
2376
  /**
2331
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。
2377
+ * 实例计费类型,目前支持:
2378
+ <li>PREPAID:预付费,即包年包月
2379
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
2380
+ 默认值:PREPAID
2332
2381
  */
2333
2382
  InstanceChargeType?: string
2334
2383
  /**
2335
- * 安全组ID。
2384
+ * 实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
2385
+
2336
2386
  */
2337
2387
  SecurityGroupIds?: Array<string>
2338
2388
  /**
@@ -2340,15 +2390,19 @@ export interface CloneDBInstanceRequest {
2340
2390
  */
2341
2391
  ProjectId?: number
2342
2392
  /**
2343
- * 实例需要绑定的Tag信息,默认为空。
2393
+ * 实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
2344
2394
  */
2345
2395
  TagList?: Array<Tag>
2346
2396
  /**
2347
- * 购买多可用区实例时填写。
2397
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
2398
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
2348
2399
  */
2349
2400
  DBNodeSet?: Array<DBNode>
2350
2401
  /**
2351
- * 是否自动使用代金券。1(是),0(否),默认不使用。
2402
+ * 是否自动使用代金券:
2403
+ <li>0:否
2404
+ <li>1:是
2405
+ 默认值:0
2352
2406
  */
2353
2407
  AutoVoucher?: number
2354
2408
  /**
@@ -2367,6 +2421,14 @@ export interface CloneDBInstanceRequest {
2367
2421
  * 恢复时间点。
2368
2422
  */
2369
2423
  RecoveryTargetTime?: string
2424
+ /**
2425
+ * 主从同步方式,支持:
2426
+ <li>Semi-sync:半同步
2427
+ <li>Async:异步
2428
+ 主实例默认值:Semi-sync
2429
+ 只读实例默认值:Async
2430
+ */
2431
+ SyncMode?: string
2370
2432
  }
2371
2433
 
2372
2434
  /**
@@ -3429,175 +3491,201 @@ export interface ModifyDBInstanceDeploymentResponse {
3429
3491
  */
3430
3492
  export interface DBInstance {
3431
3493
  /**
3432
- * 实例所属地域,如: ap-guangzhou,对应RegionSet的Region字段
3433
- */
3434
- Region: string
3435
- /**
3436
- * 实例所属可用区, 如:ap-guangzhou-3,对应ZoneSet的Zone字段
3494
+ * 实例所属地域,如: ap-guangzhou,对应RegionSet的Region字段。
3437
3495
  */
3438
- Zone: string
3496
+ Region?: string
3439
3497
  /**
3440
- * 项目ID
3498
+ * 实例所属可用区, 如:ap-guangzhou-3,对应ZoneSet的Zone字段。
3441
3499
  */
3442
- ProjectId: number
3500
+ Zone?: string
3443
3501
  /**
3444
- * 私有网络ID
3502
+ * 私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。
3445
3503
  */
3446
- VpcId: string
3504
+ VpcId?: string
3447
3505
  /**
3448
- * 子网ID
3506
+ * 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。
3449
3507
  */
3450
- SubnetId: string
3508
+ SubnetId?: string
3451
3509
  /**
3452
- * 实例ID
3510
+ * 实例ID
3453
3511
  */
3454
- DBInstanceId: string
3512
+ DBInstanceId?: string
3455
3513
  /**
3456
- * 实例名称
3514
+ * 实例名称。
3457
3515
  */
3458
- DBInstanceName: string
3516
+ DBInstanceName?: string
3459
3517
  /**
3460
- * 实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、waitSwitch(等待切换)、switching(切换中)、readonly(只读)、restarting(重启中)、network changing(网络变更中)、upgrading(内核版本升级中)
3518
+ * 实例状态,分别为: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(主备切换中)
3461
3519
  */
3462
- DBInstanceStatus: string
3520
+ DBInstanceStatus?: string
3463
3521
  /**
3464
3522
  * 实例分配的内存大小,单位:GB
3465
3523
  */
3466
- DBInstanceMemory: number
3524
+ DBInstanceMemory?: number
3467
3525
  /**
3468
3526
  * 实例分配的存储空间大小,单位:GB
3469
3527
  */
3470
- DBInstanceStorage: number
3528
+ DBInstanceStorage?: number
3471
3529
  /**
3472
3530
  * 实例分配的CPU数量,单位:个
3473
3531
  */
3474
- DBInstanceCpu: number
3532
+ DBInstanceCpu?: number
3475
3533
  /**
3476
3534
  * 售卖规格ID
3477
3535
  */
3478
- DBInstanceClass: string
3536
+ DBInstanceClass?: string
3479
3537
  /**
3480
- * 实例类型,类型有:1、primary(主实例);2、readonly(只读实例);3、guard(灾备实例);4、temp(临时实例)
3538
+ * PostgreSQL大版本号,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取,目前支持10,11,12,13,14,15这几个大版本。
3539
+ 注意:此字段可能返回 null,表示取不到有效值。
3481
3540
  */
3482
- DBInstanceType: string
3541
+ DBMajorVersion?: string
3483
3542
  /**
3484
- * 实例版本,目前只支持standard(双机高可用版, 一主一从)
3543
+ * PostgreSQL社区大版本+小版本号,如12.4,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
3485
3544
  */
3486
- DBInstanceVersion: string
3545
+ DBVersion?: string
3487
3546
  /**
3488
- * 实例DB字符集
3547
+ * PostgreSQL内核版本号,如v12.7_r1.8,版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。
3548
+ 注意:此字段可能返回 null,表示取不到有效值。
3489
3549
  */
3490
- DBCharset: string
3550
+ DBKernelVersion?: string
3491
3551
  /**
3492
- * PostgreSQL版本
3552
+ * 实例类型,类型有:
3553
+ <li>primary:主实例
3554
+ <li>readonly:只读实例
3555
+ <li>guard:灾备实例
3556
+ <li>temp:临时实例
3493
3557
  */
3494
- DBVersion: string
3558
+ DBInstanceType?: string
3495
3559
  /**
3496
- * 实例创建时间
3560
+ * 实例版本,目前只支持standard(双机高可用版, 一主一从)。
3497
3561
  */
3498
- CreateTime: string
3562
+ DBInstanceVersion?: string
3499
3563
  /**
3500
- * 实例执行最后一次更新的时间
3564
+ * 实例字符集,目前只支持:
3565
+ <li> UTF8
3566
+ <li> LATIN1
3501
3567
  */
3502
- UpdateTime: string
3568
+ DBCharset?: string
3503
3569
  /**
3504
- * 实例到期时间
3570
+ * 实例创建时间。
3505
3571
  */
3506
- ExpireTime: string
3572
+ CreateTime?: string
3507
3573
  /**
3508
- * 实例隔离时间
3574
+ * 实例执行最后一次更新的时间。
3509
3575
  */
3510
- IsolatedTime: string
3576
+ UpdateTime?: string
3511
3577
  /**
3512
- * 计费模式,1、prepaid(包年包月,预付费);2、postpaid(按量计费,后付费)
3578
+ * 实例到期时间。
3513
3579
  */
3514
- PayType: string
3580
+ ExpireTime?: string
3515
3581
  /**
3516
- * 是否自动续费,1:自动续费,0:不自动续费
3582
+ * 实例隔离时间。
3517
3583
  */
3518
- AutoRenew: number
3584
+ IsolatedTime?: string
3519
3585
  /**
3520
- * 实例网络连接信息
3586
+ * 计费模式:
3587
+ <li>prepaid:包年包月,预付费
3588
+ <li>postpaid:按量计费,后付费
3521
3589
  */
3522
- DBInstanceNetInfo: Array<DBInstanceNetInfo>
3590
+ PayType?: string
3523
3591
  /**
3524
- * 机器类型
3592
+ * 是否自动续费:
3593
+ <li>0:手动续费
3594
+ <li>1:自动续费
3595
+ 默认值:0
3525
3596
  */
3526
- Type: string
3597
+ AutoRenew?: number
3527
3598
  /**
3528
- * 用户的AppId
3599
+ * 实例网络连接信息。
3529
3600
  */
3530
- AppId: number
3601
+ DBInstanceNetInfo?: Array<DBInstanceNetInfo>
3531
3602
  /**
3532
- * 实例的Uid
3603
+ * 机器类型。
3533
3604
  */
3534
- Uid: number
3605
+ Type?: string
3535
3606
  /**
3536
- * 实例是否支持Ipv6,1:支持,0:不支持
3607
+ * 用户的AppId。
3537
3608
  */
3538
- SupportIpv6: number
3609
+ AppId?: number
3539
3610
  /**
3540
- * 实例绑定的标签信息
3541
- 注意:此字段可能返回 null,表示取不到有效值。
3611
+ * 实例的Uid。
3542
3612
  */
3543
- TagList: Array<Tag>
3613
+ Uid?: number
3544
3614
  /**
3545
- * 主实例信息,仅在实例为只读实例时返回
3546
- 注意:此字段可能返回 null,表示取不到有效值。
3615
+ * 项目ID。
3547
3616
  */
3548
- MasterDBInstanceId: string
3617
+ ProjectId?: number
3549
3618
  /**
3550
- * 只读实例数量
3619
+ * 实例绑定的标签信息。
3551
3620
  注意:此字段可能返回 null,表示取不到有效值。
3552
3621
  */
3553
- ReadOnlyInstanceNum: number
3622
+ TagList?: Array<Tag>
3554
3623
  /**
3555
- * 只读实例在只读组中的状态
3624
+ * 主实例信息,仅在实例为只读实例时返回。
3556
3625
  注意:此字段可能返回 null,表示取不到有效值。
3557
3626
  */
3558
- StatusInReadonlyGroup: string
3627
+ MasterDBInstanceId?: string
3559
3628
  /**
3560
- * 下线时间
3629
+ * 只读实例数量。
3561
3630
  注意:此字段可能返回 null,表示取不到有效值。
3562
3631
  */
3563
- OfflineTime: string
3632
+ ReadOnlyInstanceNum?: number
3564
3633
  /**
3565
- * 数据库内核版本
3634
+ * 只读实例在只读组中的状态。
3566
3635
  注意:此字段可能返回 null,表示取不到有效值。
3567
3636
  */
3568
- DBKernelVersion: string
3637
+ StatusInReadonlyGroup?: string
3569
3638
  /**
3570
- * 实例网络信息列表(此字段已废弃)
3639
+ * 下线时间。
3571
3640
  注意:此字段可能返回 null,表示取不到有效值。
3572
3641
  */
3573
- NetworkAccessList: Array<NetworkAccess>
3642
+ OfflineTime?: string
3574
3643
  /**
3575
- * PostgreSQL主要版本
3644
+ * 实例的节点信息。
3576
3645
  注意:此字段可能返回 null,表示取不到有效值。
3577
3646
  */
3578
- DBMajorVersion: string
3647
+ DBNodeSet?: Array<DBNode>
3579
3648
  /**
3580
- * 实例的节点信息
3649
+ * 实例是否支持TDE数据加密:
3650
+ <li>0:不支持
3651
+ <li>1:支持
3652
+ 默认值:0
3653
+ TDE数据加密可参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
3581
3654
  注意:此字段可能返回 null,表示取不到有效值。
3582
3655
  */
3583
- DBNodeSet: Array<DBNode>
3656
+ IsSupportTDE?: number
3584
3657
  /**
3585
- * 实例是否支持TDE数据加密 0:不支持,1:支持
3658
+ * 数据库引擎,支持:
3659
+ <li>postgresql:云数据库PostgreSQL
3660
+ <li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL
3661
+ 默认值:postgresql
3586
3662
  注意:此字段可能返回 null,表示取不到有效值。
3587
3663
  */
3588
- IsSupportTDE: number
3664
+ DBEngine?: string
3589
3665
  /**
3590
- * 数据库引擎,支持:
3591
- 1、postgresql(云数据库PostgreSQL);
3592
- 2、mssql_compatible(MSSQL兼容-云数据库PostgreSQL);
3666
+ * 数据库引擎的配置信息,配置格式如下:
3667
+ {"$key1":"$value1", "$key2":"$value2"}
3668
+ 各引擎支持如下:
3669
+ mssql_compatible引擎:
3670
+ <li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。
3671
+ <li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:
3672
+ "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"。
3673
+ <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"。
3593
3674
  注意:此字段可能返回 null,表示取不到有效值。
3594
3675
  */
3595
- DBEngine: string
3676
+ DBEngineConfig?: string
3596
3677
  /**
3597
- * 数据库引擎的配置信息
3678
+ * 实例网络信息列表(此字段已废弃)
3598
3679
  注意:此字段可能返回 null,表示取不到有效值。
3599
3680
  */
3600
- DBEngineConfig: string
3681
+ NetworkAccessList?: Array<NetworkAccess>
3682
+ /**
3683
+ * 实例是否支持Ipv6:
3684
+ <li>0:否
3685
+ <li>1:是
3686
+ 默认值:0
3687
+ */
3688
+ SupportIpv6?: number
3601
3689
  }
3602
3690
 
3603
3691
  /**
@@ -347,7 +347,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
347
347
  */
348
348
  UpgradeDBInstance(req: UpgradeDBInstanceRequest, cb?: (error: string, rep: UpgradeDBInstanceResponse) => void): Promise<UpgradeDBInstanceResponse>;
349
349
  /**
350
- * 本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例,通过此接口创建的实例无需进行初始化,可直接使用。
351
- */
350
+ * 本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例,通过此接口创建的实例无需进行初始化,可直接使用。
351
+ <li>实例创建成功后将自动开机启动,实例状态变为“运行中”。
352
+ <li>预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。
353
+ */
352
354
  CreateInstances(req: CreateInstancesRequest, cb?: (error: string, rep: CreateInstancesResponse) => void): Promise<CreateInstancesResponse>;
353
355
  }