tencentcloud-sdk-nodejs-postgres 4.0.267 → 4.0.271

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.
@@ -51,6 +51,18 @@ class Client extends TencentCloudCommon.AbstractClient {
51
51
  async DestroyDBInstance(req, cb) {
52
52
  return this.request("DestroyDBInstance", req, cb);
53
53
  }
54
+ /**
55
+ * 本接口 (DescribeBackupPlans) 用于实例所有的备份计划查询
56
+ */
57
+ async DescribeBackupPlans(req, cb) {
58
+ return this.request("DescribeBackupPlans", req, cb);
59
+ }
60
+ /**
61
+ * 本接口(RenewInstance)用于续费实例。
62
+ */
63
+ async RenewInstance(req, cb) {
64
+ return this.request("RenewInstance", req, cb);
65
+ }
54
66
  /**
55
67
  * 本接口(DescribeDBBackups)用于查询实例备份列表。
56
68
  */
@@ -93,6 +105,12 @@ class Client extends TencentCloudCommon.AbstractClient {
93
105
  async DescribeDBInstanceParameters(req, cb) {
94
106
  return this.request("DescribeDBInstanceParameters", req, cb);
95
107
  }
108
+ /**
109
+ * 本接口 (ModifyBackupPlan) 用于实例备份计划的修改,默认是在每天的凌晨开始全量备份,备份保留时长是7天。可以根据此接口指定时间进行实例的备份。
110
+ */
111
+ async ModifyBackupPlan(req, cb) {
112
+ return this.request("ModifyBackupPlan", req, cb);
113
+ }
96
114
  /**
97
115
  * 关闭serverlessDB实例外网
98
116
  */
@@ -141,6 +159,12 @@ class Client extends TencentCloudCommon.AbstractClient {
141
159
  async UpgradeDBInstance(req, cb) {
142
160
  return this.request("UpgradeDBInstance", req, cb);
143
161
  }
162
+ /**
163
+ * 本接口(ModifyDBInstanceDeployment)用于修改节点可用区部署方式,仅支持主实例。
164
+ */
165
+ async ModifyDBInstanceDeployment(req, cb) {
166
+ return this.request("ModifyDBInstanceDeployment", req, cb);
167
+ }
144
168
  /**
145
169
  * 本接口 (CreateDBInstances) 用于创建一个或者多个PostgreSQL实例,仅发货实例不会进行初始化。
146
170
  */
@@ -208,10 +232,10 @@ class Client extends TencentCloudCommon.AbstractClient {
208
232
  return this.request("ModifyDBInstanceSpec", req, cb);
209
233
  }
210
234
  /**
211
- * 本接口(RemoveDBInstanceFromReadOnlyGroup)用户将只读实例从只读组中移除
235
+ * 本接口(DescribeAvailableRecoveryTime)用于查询实例可恢复的时间范围。
212
236
  */
213
- async RemoveDBInstanceFromReadOnlyGroup(req, cb) {
214
- return this.request("RemoveDBInstanceFromReadOnlyGroup", req, cb);
237
+ async DescribeAvailableRecoveryTime(req, cb) {
238
+ return this.request("DescribeAvailableRecoveryTime", req, cb);
215
239
  }
216
240
  /**
217
241
  * 本接口(CreateReadOnlyGroup)用于创建只读组
@@ -243,6 +267,12 @@ class Client extends TencentCloudCommon.AbstractClient {
243
267
  async CloseDBExtranetAccess(req, cb) {
244
268
  return this.request("CloseDBExtranetAccess", req, cb);
245
269
  }
270
+ /**
271
+ * 用于克隆实例,支持指定备份集、指定时间点进行克隆。
272
+ */
273
+ async CloneDBInstance(req, cb) {
274
+ return this.request("CloneDBInstance", req, cb);
275
+ }
246
276
  /**
247
277
  * 本接口(AddDBInstanceToReadOnlyGroup)用于添加只读实例到只读组
248
278
  */
@@ -280,10 +310,10 @@ class Client extends TencentCloudCommon.AbstractClient {
280
310
  return this.request("RebalanceReadOnlyGroup", req, cb);
281
311
  }
282
312
  /**
283
- * 本接口(RenewInstance)用于续费实例。
313
+ * 本接口(DescribeCloneDBInstanceSpec)用于查询克隆实例可选择的最小规格,包括SpecCode和磁盘。
284
314
  */
285
- async RenewInstance(req, cb) {
286
- return this.request("RenewInstance", req, cb);
315
+ async DescribeCloneDBInstanceSpec(req, cb) {
316
+ return this.request("DescribeCloneDBInstanceSpec", req, cb);
287
317
  }
288
318
  /**
289
319
  * 接口(DescribeDatabases)用来拉取数据库列表
@@ -315,6 +345,12 @@ class Client extends TencentCloudCommon.AbstractClient {
315
345
  async CreateInstances(req, cb) {
316
346
  return this.request("CreateInstances", req, cb);
317
347
  }
348
+ /**
349
+ * 本接口(RemoveDBInstanceFromReadOnlyGroup)用户将只读实例从只读组中移除
350
+ */
351
+ async RemoveDBInstanceFromReadOnlyGroup(req, cb) {
352
+ return this.request("RemoveDBInstanceFromReadOnlyGroup", req, cb);
353
+ }
318
354
  /**
319
355
  * 本接口 (DescribeProductConfig) 用于查询售卖规格配置。
320
356
  */
@@ -265,6 +265,10 @@ export interface CreateInstancesRequest {
265
265
  * PostgreSQL内核版本。当输入该参数时,会创建该内核版本号实例
266
266
  */
267
267
  DBKernelVersion?: string;
268
+ /**
269
+ * 实例节点信息,购买跨可用区实例时填写。
270
+ */
271
+ DBNodeSet?: Array<DBNode>;
268
272
  }
269
273
  /**
270
274
  * 描述一种规格的信息
@@ -321,6 +325,23 @@ export interface SpecItemInfo {
321
325
  */
322
326
  KernelVersion: string;
323
327
  }
328
+ /**
329
+ * DescribeAvailableRecoveryTime返回参数结构体
330
+ */
331
+ export interface DescribeAvailableRecoveryTimeResponse {
332
+ /**
333
+ * 可恢复的最早时间,时区为东八区(UTC+8)。
334
+ */
335
+ RecoveryBeginTime: string;
336
+ /**
337
+ * 可恢复的最晚时间,时区为东八区(UTC+8)。
338
+ */
339
+ RecoveryEndTime: string;
340
+ /**
341
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
342
+ */
343
+ RequestId?: string;
344
+ }
324
345
  /**
325
346
  * ModifyDBInstanceReadOnlyGroup返回参数结构体
326
347
  */
@@ -334,6 +355,121 @@ export interface ModifyDBInstanceReadOnlyGroupResponse {
334
355
  */
335
356
  RequestId?: string;
336
357
  }
358
+ /**
359
+ * CloneDBInstance请求参数结构体
360
+ */
361
+ export interface CloneDBInstanceRequest {
362
+ /**
363
+ * 克隆的源实例ID。
364
+ */
365
+ DBInstanceId: string;
366
+ /**
367
+ * 售卖规格ID。该参数可以通过调用DescribeProductConfig的返回值中的SpecCode字段来获取。
368
+ */
369
+ SpecCode: string;
370
+ /**
371
+ * 实例容量大小,单位:GB。
372
+ */
373
+ Storage: number;
374
+ /**
375
+ * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
376
+ */
377
+ Period: number;
378
+ /**
379
+ * 续费标记:0-正常续费(默认);1-自动续费。
380
+ */
381
+ AutoRenewFlag: number;
382
+ /**
383
+ * 私有网络ID。
384
+ */
385
+ VpcId: string;
386
+ /**
387
+ * 已配置的私有网络中的子网ID。
388
+ */
389
+ SubnetId: string;
390
+ /**
391
+ * 新购实例的实例名称。
392
+ */
393
+ Name?: string;
394
+ /**
395
+ * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。
396
+ */
397
+ InstanceChargeType?: string;
398
+ /**
399
+ * 安全组ID。
400
+ */
401
+ SecurityGroupIds?: Array<string>;
402
+ /**
403
+ * 项目ID。
404
+ */
405
+ ProjectId?: number;
406
+ /**
407
+ * 实例需要绑定的Tag信息,默认为空。
408
+ */
409
+ TagList?: Array<Tag>;
410
+ /**
411
+ * 购买多可用区实例时填写。
412
+ */
413
+ DBNodeSet?: Array<DBNode>;
414
+ /**
415
+ * 是否自动使用代金券。1(是),0(否),默认不使用。
416
+ */
417
+ AutoVoucher?: number;
418
+ /**
419
+ * 代金券ID列表。
420
+ */
421
+ VoucherIds?: string;
422
+ /**
423
+ * 活动ID。
424
+ */
425
+ ActivityId?: number;
426
+ /**
427
+ * 基础备份集ID。
428
+ */
429
+ BackupSetId?: string;
430
+ /**
431
+ * 恢复时间点。
432
+ */
433
+ RecoveryTargetTime?: string;
434
+ }
435
+ /**
436
+ * DescribeCloneDBInstanceSpec请求参数结构体
437
+ */
438
+ export interface DescribeCloneDBInstanceSpecRequest {
439
+ /**
440
+ * 实例ID。
441
+ */
442
+ DBInstanceId: string;
443
+ /**
444
+ * 基础备份集ID,此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
445
+ */
446
+ BackupSetId?: string;
447
+ /**
448
+ * 恢复目标时间,此入参和BackupSetId必须选择一个传入。时区以东八区(UTC+8)为准。
449
+ */
450
+ RecoveryTargetTime?: string;
451
+ }
452
+ /**
453
+ * 备份计划
454
+ */
455
+ export interface BackupPlan {
456
+ /**
457
+ * 备份周期
458
+ */
459
+ BackupPeriod: string;
460
+ /**
461
+ * 基础备份保留时长
462
+ */
463
+ BaseBackupRetentionPeriod: number;
464
+ /**
465
+ * 开始备份的最早时间
466
+ */
467
+ MinBackupStartTime: string;
468
+ /**
469
+ * 开始备份的最晚时间
470
+ */
471
+ MaxBackupStartTime: string;
472
+ }
337
473
  /**
338
474
  * OpenServerlessDBExtranetAccess请求参数结构体
339
475
  */
@@ -523,6 +659,31 @@ export interface DBInstanceNetInfo {
523
659
  */
524
660
  SubnetId: string;
525
661
  }
662
+ /**
663
+ * ModifyDBInstanceDeployment请求参数结构体
664
+ */
665
+ export interface ModifyDBInstanceDeploymentRequest {
666
+ /**
667
+ * 实例ID。
668
+ */
669
+ DBInstanceId: string;
670
+ /**
671
+ * 实例节点信息。
672
+ */
673
+ DBNodeSet: Array<DBNode>;
674
+ /**
675
+ * 切换时间,默认为 立即切换,入参为 0 :立即切换 。1:指定时间切换。
676
+ */
677
+ SwitchTag: number;
678
+ /**
679
+ * 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。
680
+ */
681
+ SwitchStartTime?: string;
682
+ /**
683
+ * 切换截止时间,时间格式:HH:MM:SS,例如:01:30:00。
684
+ */
685
+ SwitchEndTime?: string;
686
+ }
526
687
  /**
527
688
  * 描述可用区的编码和状态信息
528
689
  */
@@ -540,13 +701,18 @@ export interface ZoneInfo {
540
701
  */
541
702
  ZoneId: number;
542
703
  /**
543
- * 可用状态,UNAVAILABLE表示不可用,AVAILABLE表示可用
704
+ * 可用状态,UNAVAILABLE表示不可用,AVAILABLE表示可用,SELLOUT表示售罄
544
705
  */
545
706
  ZoneState: string;
546
707
  /**
547
708
  * 该可用区是否支持Ipv6
548
709
  */
549
710
  ZoneSupportIpv6: number;
711
+ /**
712
+ * 该可用区对应的备可用区集合
713
+ 注意:此字段可能返回 null,表示取不到有效值。
714
+ */
715
+ StandbyZoneSet: Array<string>;
550
716
  }
551
717
  /**
552
718
  * InquiryPriceCreateDBInstances请求参数结构体
@@ -682,24 +848,23 @@ export interface CloseServerlessDBExtranetAccessRequest {
682
848
  DBInstanceName?: string;
683
849
  }
684
850
  /**
685
- * serverless账号描述
851
+ * CloneDBInstance返回参数结构体
686
852
  */
687
- export interface ServerlessDBAccount {
853
+ export interface CloneDBInstanceResponse {
688
854
  /**
689
- * 用户名
855
+ * 订单号。
690
856
  注意:此字段可能返回 null,表示取不到有效值。
691
857
  */
692
- DBUser: string;
858
+ DealName: string;
693
859
  /**
694
- * 密码
860
+ * 订单流水号。
695
861
  注意:此字段可能返回 null,表示取不到有效值。
696
862
  */
697
- DBPassword: string;
863
+ BillId: string;
698
864
  /**
699
- * 连接数限制
700
- 注意:此字段可能返回 null,表示取不到有效值。
701
- */
702
- DBConnLimit: number;
865
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
866
+ */
867
+ RequestId?: string;
703
868
  }
704
869
  /**
705
870
  * ModifyDBInstanceReadOnlyGroup请求参数结构体
@@ -752,6 +917,15 @@ export interface CreateReadOnlyDBInstanceResponse {
752
917
  */
753
918
  RequestId?: string;
754
919
  }
920
+ /**
921
+ * DescribeAvailableRecoveryTime请求参数结构体
922
+ */
923
+ export interface DescribeAvailableRecoveryTimeRequest {
924
+ /**
925
+ * 实例ID
926
+ */
927
+ DBInstanceId: string;
928
+ }
755
929
  /**
756
930
  * 慢SQL耗时分段分析
757
931
  */
@@ -872,6 +1046,19 @@ export interface ServerlessDBInstanceNetInfo {
872
1046
  */
873
1047
  NetType: string;
874
1048
  }
1049
+ /**
1050
+ * DescribeBackupPlans返回参数结构体
1051
+ */
1052
+ export interface DescribeBackupPlansResponse {
1053
+ /**
1054
+ * 实例的备份计划集
1055
+ */
1056
+ Plans: Array<BackupPlan>;
1057
+ /**
1058
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1059
+ */
1060
+ RequestId?: string;
1061
+ }
875
1062
  /**
876
1063
  * DescribeDBInstances请求参数结构体
877
1064
  */
@@ -1262,6 +1449,35 @@ export interface DestroyDBInstanceRequest {
1262
1449
  */
1263
1450
  DBInstanceId: string;
1264
1451
  }
1452
+ /**
1453
+ * serverless账号描述
1454
+ */
1455
+ export interface ServerlessDBAccount {
1456
+ /**
1457
+ * 用户名
1458
+ 注意:此字段可能返回 null,表示取不到有效值。
1459
+ */
1460
+ DBUser: string;
1461
+ /**
1462
+ * 密码
1463
+ 注意:此字段可能返回 null,表示取不到有效值。
1464
+ */
1465
+ DBPassword: string;
1466
+ /**
1467
+ * 连接数限制
1468
+ 注意:此字段可能返回 null,表示取不到有效值。
1469
+ */
1470
+ DBConnLimit: number;
1471
+ }
1472
+ /**
1473
+ * ModifyDBInstanceDeployment返回参数结构体
1474
+ */
1475
+ export interface ModifyDBInstanceDeploymentResponse {
1476
+ /**
1477
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1478
+ */
1479
+ RequestId?: string;
1480
+ }
1265
1481
  /**
1266
1482
  * DescribeParamsEvent请求参数结构体
1267
1483
  */
@@ -2146,6 +2362,11 @@ export interface DBInstance {
2146
2362
  注意:此字段可能返回 null,表示取不到有效值。
2147
2363
  */
2148
2364
  DBMajorVersion: string;
2365
+ /**
2366
+ * 实例的节点信息
2367
+ 注意:此字段可能返回 null,表示取不到有效值。
2368
+ */
2369
+ DBNodeSet: Array<DBNode>;
2149
2370
  }
2150
2371
  /**
2151
2372
  * DescribeProductConfig返回参数结构体
@@ -2274,6 +2495,21 @@ export interface RemoveDBInstanceFromReadOnlyGroupRequest {
2274
2495
  */
2275
2496
  ReadOnlyGroupId: string;
2276
2497
  }
2498
+ /**
2499
+ * 描述实例节点信息,包括节点类型、节点所在可用区。
2500
+ */
2501
+ export interface DBNode {
2502
+ /**
2503
+ * 节点类型,值可以为:
2504
+ Primary,代表主节点;
2505
+ Standby,代表备节点。
2506
+ */
2507
+ Role: string;
2508
+ /**
2509
+ * 节点所在可用区,例如 ap-guangzhou-1。
2510
+ */
2511
+ Zone: string;
2512
+ }
2277
2513
  /**
2278
2514
  * ModifyDBInstanceName返回参数结构体
2279
2515
  */
@@ -2381,6 +2617,23 @@ export interface CreateReadOnlyDBInstanceRequest {
2381
2617
  */
2382
2618
  SecurityGroupIds?: Array<string>;
2383
2619
  }
2620
+ /**
2621
+ * DescribeCloneDBInstanceSpec返回参数结构体
2622
+ */
2623
+ export interface DescribeCloneDBInstanceSpecResponse {
2624
+ /**
2625
+ * 可购买的最小规格码。
2626
+ */
2627
+ MinSpecCode: string;
2628
+ /**
2629
+ * 可购买的最小磁盘容量,单位GB。
2630
+ */
2631
+ MinStorage: number;
2632
+ /**
2633
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2634
+ */
2635
+ RequestId?: string;
2636
+ }
2384
2637
  /**
2385
2638
  * DescribeZones返回参数结构体
2386
2639
  */
@@ -2388,11 +2641,11 @@ export interface DescribeZonesResponse {
2388
2641
  /**
2389
2642
  * 返回的结果数量。
2390
2643
  */
2391
- TotalCount?: number;
2644
+ TotalCount: number;
2392
2645
  /**
2393
2646
  * 可用区信息集合。
2394
2647
  */
2395
- ZoneSet?: Array<ZoneInfo>;
2648
+ ZoneSet: Array<ZoneInfo>;
2396
2649
  /**
2397
2650
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2398
2651
  */
@@ -2463,6 +2716,15 @@ export interface CloseDBExtranetAccessRequest {
2463
2716
  */
2464
2717
  IsIpv6?: number;
2465
2718
  }
2719
+ /**
2720
+ * ModifyBackupPlan返回参数结构体
2721
+ */
2722
+ export interface ModifyBackupPlanResponse {
2723
+ /**
2724
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2725
+ */
2726
+ RequestId?: string;
2727
+ }
2466
2728
  /**
2467
2729
  * CreateServerlessDBInstance请求参数结构体
2468
2730
  */
@@ -2630,6 +2892,11 @@ export interface DBBackup {
2630
2892
  * 外网下载地址
2631
2893
  */
2632
2894
  ExternalAddr: string;
2895
+ /**
2896
+ * 备份集ID
2897
+ 注意:此字段可能返回 null,表示取不到有效值。
2898
+ */
2899
+ SetId: string;
2633
2900
  }
2634
2901
  /**
2635
2902
  * DescribeDBErrlogs返回参数结构体
@@ -2648,6 +2915,31 @@ export interface DescribeDBErrlogsResponse {
2648
2915
  */
2649
2916
  RequestId?: string;
2650
2917
  }
2918
+ /**
2919
+ * ModifyBackupPlan请求参数结构体
2920
+ */
2921
+ export interface ModifyBackupPlanRequest {
2922
+ /**
2923
+ * 实例ID
2924
+ */
2925
+ DBInstanceId: string;
2926
+ /**
2927
+ * 实例最早开始备份时间
2928
+ */
2929
+ MinBackupStartTime?: string;
2930
+ /**
2931
+ * 实例最晚开始备份时间
2932
+ */
2933
+ MaxBackupStartTime?: string;
2934
+ /**
2935
+ * 实例备份保留时长,取值范围为3-7,单位是天
2936
+ */
2937
+ BaseBackupRetentionPeriod?: number;
2938
+ /**
2939
+ * 实例备份周期,按照星期维度,格式为小写星期英文单词
2940
+ */
2941
+ BackupPeriod?: Array<string>;
2942
+ }
2651
2943
  /**
2652
2944
  * 批量修改参数
2653
2945
  */
@@ -2814,6 +3106,15 @@ export interface RemoveDBInstanceFromReadOnlyGroupResponse {
2814
3106
  */
2815
3107
  RequestId?: string;
2816
3108
  }
3109
+ /**
3110
+ * DescribeBackupPlans请求参数结构体
3111
+ */
3112
+ export interface DescribeBackupPlansRequest {
3113
+ /**
3114
+ * 实例ID
3115
+ */
3116
+ DBInstanceId: string;
3117
+ }
2817
3118
  /**
2818
3119
  * ResetAccountPassword请求参数结构体
2819
3120
  */