@alicloud/polardb20170801 5.2.2 → 5.3.0

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/dist/client.d.ts CHANGED
@@ -3,6 +3,75 @@
3
3
  import * as $Util from '@alicloud/tea-util';
4
4
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
5
5
  import * as $tea from '@alicloud/tea-typescript';
6
+ export declare class CancelActiveOperationTasksRequest extends $tea.Model {
7
+ ownerAccount?: string;
8
+ ownerId?: number;
9
+ /**
10
+ * @remarks
11
+ * This parameter is required.
12
+ *
13
+ * @example
14
+ * cn-beijing
15
+ */
16
+ regionId?: string;
17
+ resourceOwnerAccount?: string;
18
+ resourceOwnerId?: number;
19
+ securityToken?: string;
20
+ /**
21
+ * @remarks
22
+ * This parameter is required.
23
+ *
24
+ * @example
25
+ * 2355,2352
26
+ */
27
+ taskIds?: string;
28
+ static names(): {
29
+ [key: string]: string;
30
+ };
31
+ static types(): {
32
+ [key: string]: any;
33
+ };
34
+ constructor(map?: {
35
+ [key: string]: any;
36
+ });
37
+ }
38
+ export declare class CancelActiveOperationTasksResponseBody extends $tea.Model {
39
+ /**
40
+ * @example
41
+ * 25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB
42
+ */
43
+ requestId?: string;
44
+ /**
45
+ * @example
46
+ * 2355,2352
47
+ */
48
+ taskIds?: string;
49
+ static names(): {
50
+ [key: string]: string;
51
+ };
52
+ static types(): {
53
+ [key: string]: any;
54
+ };
55
+ constructor(map?: {
56
+ [key: string]: any;
57
+ });
58
+ }
59
+ export declare class CancelActiveOperationTasksResponse extends $tea.Model {
60
+ headers?: {
61
+ [key: string]: string;
62
+ };
63
+ statusCode?: number;
64
+ body?: CancelActiveOperationTasksResponseBody;
65
+ static names(): {
66
+ [key: string]: string;
67
+ };
68
+ static types(): {
69
+ [key: string]: any;
70
+ };
71
+ constructor(map?: {
72
+ [key: string]: any;
73
+ });
74
+ }
6
75
  export declare class CancelScheduleTasksRequest extends $tea.Model {
7
76
  /**
8
77
  * @remarks
@@ -595,8 +664,8 @@ export declare class CreateAccountRequest extends $tea.Model {
595
664
  * @remarks
596
665
  * The password of the account. The password must meet the following requirements:
597
666
  *
598
- * * It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
599
- * * It must be 8 to 32 characters in length.
667
+ * * The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
668
+ * * The password must be 8 to 32 characters in length.
600
669
  * * Special characters include `! @ # $ % ^ & * ( ) _ + - =`
601
670
  *
602
671
  * This parameter is required.
@@ -632,14 +701,15 @@ export declare class CreateAccountRequest extends $tea.Model {
632
701
  * The type of the account. Valid values:
633
702
  *
634
703
  * * **Normal**: standard account
635
- * * **Super**: privileged account
704
+ * * **Super**: privileged account.
636
705
  *
637
706
  * >
638
707
  *
639
708
  * * If you leave this parameter empty, the default value **Super** is used.
640
709
  *
641
- * * You can create multiple privileged accounts for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. A privileged account is granted more permissions than a standard account. For more information about how to create a database account, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
642
- * * You can create only one privileged account for a PolarDB for MySQL cluster. A privileged account is granted more permissions than a standard account. For more information about how to create a database account, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
710
+ * * You can create multiple privileged accounts for a PolarDB for PostgreSQL (Compatible with Oracle) cluster or a PolarDB for PostgreSQL cluster. A privileged account has more permissions than a standard account. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
711
+ *
712
+ * * You can create only one privileged account for a PolarDB for MySQL cluster. A privileged account has more permissions than a standard account. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
643
713
  *
644
714
  * @example
645
715
  * Normal
@@ -675,22 +745,6 @@ export declare class CreateAccountRequest extends $tea.Model {
675
745
  DBName?: string;
676
746
  ownerAccount?: string;
677
747
  ownerId?: number;
678
- /**
679
- * @remarks
680
- * Specifies whether to grant the specified account required permissions on all existing databases in the current cluster and databases that will be further created for the current cluster. Valid values:
681
- *
682
- * * **0 or unspecified**: does not grant required permissions.
683
- * * **1**: grants required permissions.
684
- *
685
- * >
686
- *
687
- * * The parameter is valid only after you configure the `AccountPrivilege` parameter.
688
- *
689
- * * If you set the parameter to `1`, the current account is granted to the required permissions on all databases in the current cluster that are specified by the `AccountPrivilege` parameter.
690
- *
691
- * @example
692
- * 0
693
- */
694
748
  privForAllDB?: string;
695
749
  resourceOwnerAccount?: string;
696
750
  resourceOwnerId?: number;
@@ -1267,12 +1321,16 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1267
1321
  DBNodeClass?: string;
1268
1322
  /**
1269
1323
  * @remarks
1270
- * Number of standard edition nodes. Values are as follows:
1324
+ * The number of nodes. This parameter is supported for Standard Edition clusters. Valid values:
1325
+ *
1326
+ * * **1** (default): only one primary node.
1327
+ * * **2**: one read-only node and one primary node.
1328
+ *
1329
+ * >
1271
1330
  *
1272
- * - **1** (default): Indicates there is only one read-write node.
1273
- * - **2**: Indicates there is one read-only node and one read-write node.
1274
- * > - Enterprise edition defaults to 2 nodes, while the standard edition defaults to 1 node.
1275
- * > - Only supported by PolarDB MySQL edition.
1331
+ * * By default, an Enterprise Edition cluster has two nodes and a Standard Edition cluster has one node.
1332
+ *
1333
+ * * This parameter is supported only for PolarDB for MySQL clusters.
1276
1334
  *
1277
1335
  * @example
1278
1336
  * 1
@@ -1662,6 +1720,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1662
1720
  * List of tags.
1663
1721
  */
1664
1722
  tag?: CreateDBClusterRequestTag[];
1723
+ targetMinorVersion?: string;
1665
1724
  /**
1666
1725
  * @remarks
1667
1726
  * If the payment type is **Prepaid**, this parameter is required.
@@ -4232,6 +4291,9 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4232
4291
  /**
4233
4292
  * @remarks
4234
4293
  * The name of the database account that is used to connect to the AI nodes in the cluster.
4294
+ *
4295
+ * @example
4296
+ * testacc
4235
4297
  */
4236
4298
  accountName?: string;
4237
4299
  /**
@@ -4408,12 +4470,17 @@ export declare class DescribeAccountsResponse extends $tea.Model {
4408
4470
  }
4409
4471
  export declare class DescribeActivationCodeDetailsRequest extends $tea.Model {
4410
4472
  /**
4473
+ * @remarks
4474
+ * The ID of the activation code.
4475
+ *
4411
4476
  * @example
4412
4477
  * 123
4413
4478
  */
4414
4479
  activationCodeId?: number;
4415
4480
  /**
4416
4481
  * @remarks
4482
+ * The Alibaba Cloud order ID (including the virtual order ID).
4483
+ *
4417
4484
  * This parameter is required.
4418
4485
  *
4419
4486
  * @example
@@ -4436,59 +4503,89 @@ export declare class DescribeActivationCodeDetailsRequest extends $tea.Model {
4436
4503
  }
4437
4504
  export declare class DescribeActivationCodeDetailsResponseBody extends $tea.Model {
4438
4505
  /**
4506
+ * @remarks
4507
+ * The time when the activation code takes effect.
4508
+ *
4439
4509
  * @example
4440
4510
  * 2024-10-16 16:46:20
4441
4511
  */
4442
4512
  activateAt?: string;
4443
4513
  /**
4514
+ * @remarks
4515
+ * The activation code in the base64 format. The activation code is decoded and stored into a file named license.lic. PolarDB can access and read the license.lic file upon startup to validate the license or perform related operations.
4516
+ *
4444
4517
  * @example
4445
4518
  * AAEAA******AAA=
4446
4519
  */
4447
4520
  certContentB64?: string;
4448
4521
  /**
4522
+ * @remarks
4523
+ * The description of the activation code.
4524
+ *
4449
4525
  * @example
4450
4526
  * testCode
4451
4527
  */
4452
4528
  description?: string;
4453
4529
  /**
4530
+ * @remarks
4531
+ * The time when the activation code expires.
4532
+ *
4454
4533
  * @example
4455
4534
  * 2054-10-09 16:46:20
4456
4535
  */
4457
4536
  expireAt?: string;
4458
4537
  /**
4538
+ * @remarks
4539
+ * The time when the activation code was created.
4540
+ *
4459
4541
  * @example
4460
4542
  * 2024-10-16 16:46:20
4461
4543
  */
4462
4544
  gmtCreated?: string;
4463
4545
  /**
4546
+ * @remarks
4547
+ * The time when the activation code was last updated.
4548
+ *
4464
4549
  * @example
4465
4550
  * 2024-10-16 16:46:20
4466
4551
  */
4467
4552
  gmtModified?: string;
4468
4553
  /**
4554
+ * @remarks
4555
+ * The ID of the activation code.
4556
+ *
4469
4557
  * @example
4470
4558
  * 123
4471
4559
  */
4472
4560
  id?: number;
4473
4561
  /**
4562
+ * @remarks
4563
+ * The MAC address.
4564
+ *
4474
4565
  * @example
4475
4566
  * 12:34:56:78:98:00
4476
4567
  */
4477
4568
  macAddress?: string;
4478
4569
  /**
4570
+ * @remarks
4571
+ * The name of the activation code.
4572
+ *
4479
4573
  * @example
4480
4574
  * testName
4481
4575
  */
4482
4576
  name?: string;
4483
4577
  /**
4484
4578
  * @remarks
4485
- * Id of the request
4579
+ * The request ID.
4486
4580
  *
4487
4581
  * @example
4488
4582
  * F2A9EFA7-915F-4572-8299-85A307******
4489
4583
  */
4490
4584
  requestId?: string;
4491
4585
  /**
4586
+ * @remarks
4587
+ * The system identifier of the database.
4588
+ *
4492
4589
  * @example
4493
4590
  * 1234567890123456
4494
4591
  */
@@ -4624,6 +4721,123 @@ export declare class DescribeActivationCodesResponse extends $tea.Model {
4624
4721
  [key: string]: any;
4625
4722
  });
4626
4723
  }
4724
+ export declare class DescribeActiveOperationTasksRequest extends $tea.Model {
4725
+ /**
4726
+ * @example
4727
+ * -1
4728
+ */
4729
+ allowCancel?: number;
4730
+ /**
4731
+ * @example
4732
+ * -1
4733
+ */
4734
+ allowChange?: number;
4735
+ /**
4736
+ * @example
4737
+ * all
4738
+ */
4739
+ changeLevel?: string;
4740
+ /**
4741
+ * @example
4742
+ * pc-3ns***********d5d
4743
+ */
4744
+ DBClusterId?: string;
4745
+ /**
4746
+ * @example
4747
+ * MySQL
4748
+ */
4749
+ DBType?: string;
4750
+ ownerAccount?: string;
4751
+ ownerId?: number;
4752
+ /**
4753
+ * @example
4754
+ * 1
4755
+ */
4756
+ pageNumber?: number;
4757
+ /**
4758
+ * @example
4759
+ * 30
4760
+ */
4761
+ pageSize?: number;
4762
+ /**
4763
+ * @remarks
4764
+ * This parameter is required.
4765
+ *
4766
+ * @example
4767
+ * cn-beijing
4768
+ */
4769
+ regionId?: string;
4770
+ resourceOwnerAccount?: string;
4771
+ resourceOwnerId?: number;
4772
+ securityToken?: string;
4773
+ /**
4774
+ * @example
4775
+ * -1
4776
+ */
4777
+ status?: number;
4778
+ /**
4779
+ * @example
4780
+ * DatabaseProxyUpgrading
4781
+ */
4782
+ taskType?: string;
4783
+ static names(): {
4784
+ [key: string]: string;
4785
+ };
4786
+ static types(): {
4787
+ [key: string]: any;
4788
+ };
4789
+ constructor(map?: {
4790
+ [key: string]: any;
4791
+ });
4792
+ }
4793
+ export declare class DescribeActiveOperationTasksResponseBody extends $tea.Model {
4794
+ items?: DescribeActiveOperationTasksResponseBodyItems[];
4795
+ /**
4796
+ * @example
4797
+ * 1
4798
+ */
4799
+ pageNumber?: number;
4800
+ /**
4801
+ * @example
4802
+ * 30
4803
+ */
4804
+ pageSize?: number;
4805
+ /**
4806
+ * @example
4807
+ * FAF88508-D5F8-52B1-8824-262601769E31
4808
+ */
4809
+ requestId?: string;
4810
+ /**
4811
+ * @example
4812
+ * 1
4813
+ */
4814
+ totalRecordCount?: number;
4815
+ static names(): {
4816
+ [key: string]: string;
4817
+ };
4818
+ static types(): {
4819
+ [key: string]: any;
4820
+ };
4821
+ constructor(map?: {
4822
+ [key: string]: any;
4823
+ });
4824
+ }
4825
+ export declare class DescribeActiveOperationTasksResponse extends $tea.Model {
4826
+ headers?: {
4827
+ [key: string]: string;
4828
+ };
4829
+ statusCode?: number;
4830
+ body?: DescribeActiveOperationTasksResponseBody;
4831
+ static names(): {
4832
+ [key: string]: string;
4833
+ };
4834
+ static types(): {
4835
+ [key: string]: any;
4836
+ };
4837
+ constructor(map?: {
4838
+ [key: string]: any;
4839
+ });
4840
+ }
4627
4841
  export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
4628
4842
  /**
4629
4843
  * @remarks
@@ -5313,7 +5527,7 @@ export declare class DescribeBackupsRequest extends $tea.Model {
5313
5527
  export declare class DescribeBackupsResponseBody extends $tea.Model {
5314
5528
  /**
5315
5529
  * @remarks
5316
- * The details of backup sets.
5530
+ * The queried backup sets.
5317
5531
  */
5318
5532
  items?: DescribeBackupsResponseBodyItems;
5319
5533
  /**
@@ -5340,6 +5554,10 @@ export declare class DescribeBackupsResponseBody extends $tea.Model {
5340
5554
  * 24A1990B-4F6E-482B-B8CB-75C612******
5341
5555
  */
5342
5556
  requestId?: string;
5557
+ /**
5558
+ * @example
5559
+ * 4639948800
5560
+ */
5343
5561
  totalLevel2BackupSize?: string;
5344
5562
  /**
5345
5563
  * @remarks
@@ -5543,7 +5761,7 @@ export declare class DescribeClassListRequest extends $tea.Model {
5543
5761
  export declare class DescribeClassListResponseBody extends $tea.Model {
5544
5762
  /**
5545
5763
  * @remarks
5546
- * The specifications of the cluster.
5764
+ * The cluster specifications.
5547
5765
  */
5548
5766
  items?: DescribeClassListResponseBodyItems[];
5549
5767
  /**
@@ -5926,6 +6144,16 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5926
6144
  * StandbyClusterON
5927
6145
  */
5928
6146
  hotStandbyCluster?: string;
6147
+ /**
6148
+ * @remarks
6149
+ * Indicates whether the automatic IMCI-based query acceleration feature is enabled. Valid values:
6150
+ *
6151
+ * * `ON`: enabled
6152
+ * * `OFF`: disabled
6153
+ *
6154
+ * @example
6155
+ * OFF
6156
+ */
5929
6157
  imciAutoIndex?: string;
5930
6158
  /**
5931
6159
  * @remarks
@@ -6172,7 +6400,8 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
6172
6400
  /**
6173
6401
  * @remarks
6174
6402
  * Storage billing type. Valid values are as follows:
6175
- * - **Postpaid**:Pay-as-you-go (by capacity). - **Prepaid**:Subscription (by space).
6403
+ * - **Postpaid**: Pay-as-you-go (by capacity).
6404
+ * - **Prepaid**: Subscription (by space).
6176
6405
  *
6177
6406
  * @example
6178
6407
  * Prepaid
@@ -6226,7 +6455,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
6226
6455
  subCategory?: string;
6227
6456
  /**
6228
6457
  * @remarks
6229
- * Indicates whether the failover with hot replica feature is supported if the cluster has In-Memory Column Index (IMCI) nodes.
6458
+ * Indicates whether queries based on In-Memory Column Indexes (IMCIs) are supported during and after a failover with hot replica.
6230
6459
  *
6231
6460
  * @example
6232
6461
  * ON
@@ -6787,7 +7016,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6787
7016
  migrationStatus?: string;
6788
7017
  /**
6789
7018
  * @remarks
6790
- * The port number.
7019
+ * The endpoints of the ApsaraDB RDS instance.
6791
7020
  */
6792
7021
  rdsEndpointList?: DescribeDBClusterMigrationResponseBodyRdsEndpointList[];
6793
7022
  /**
@@ -6815,6 +7044,12 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6815
7044
  */
6816
7045
  sourceRDSDBInstanceId?: string;
6817
7046
  /**
7047
+ * @remarks
7048
+ * The type of the source database. Valid values:
7049
+ *
7050
+ * - **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
7051
+ * - **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
7052
+ *
6818
7053
  * @example
6819
7054
  * PolarDBMySQL
6820
7055
  */
@@ -7116,7 +7351,7 @@ export declare class DescribeDBClusterPerformanceRequest extends $tea.Model {
7116
7351
  startTime?: string;
7117
7352
  /**
7118
7353
  * @remarks
7119
- * The Query Type
7354
+ * The query type.
7120
7355
  *
7121
7356
  * @example
7122
7357
  * orca
@@ -7295,7 +7530,7 @@ export declare class DescribeDBClusterSSLResponse extends $tea.Model {
7295
7530
  export declare class DescribeDBClusterServerlessConfRequest extends $tea.Model {
7296
7531
  /**
7297
7532
  * @remarks
7298
- * The ID of the serverless cluster.
7533
+ * Serverless cluster ID.
7299
7534
  *
7300
7535
  * This parameter is required.
7301
7536
  *
@@ -7321,10 +7556,11 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7321
7556
  agileScaleMax?: string;
7322
7557
  /**
7323
7558
  * @remarks
7324
- * Indicates whether the no-activity suspension feature is enabled. Default value: false. Valid values:
7559
+ * Whether to enable idle shutdown. Values:
7325
7560
  *
7326
- * * **true**
7327
- * * **false**
7561
+ * - **true**: Enable
7562
+ *
7563
+ * - **false**: Disable (default)
7328
7564
  *
7329
7565
  * @example
7330
7566
  * true
@@ -7332,7 +7568,7 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7332
7568
  allowShutDown?: string;
7333
7569
  /**
7334
7570
  * @remarks
7335
- * The ID of the serverless cluster.
7571
+ * Serverless cluster ID.
7336
7572
  *
7337
7573
  * @example
7338
7574
  * pc-bp10gr51qasnl****
@@ -7340,17 +7576,31 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7340
7576
  DBClusterId?: string;
7341
7577
  /**
7342
7578
  * @remarks
7343
- * The ID of the request.
7579
+ * Request ID.
7344
7580
  *
7345
7581
  * @example
7346
7582
  * 5E71541A-6007-4DCC-A38A-F872C31FEB45
7347
7583
  */
7348
7584
  requestId?: string;
7585
+ /**
7586
+ * @remarks
7587
+ * Maximum limit for the number of read-only column storage nodes. Range: 0~7.
7588
+ *
7589
+ * @example
7590
+ * 1
7591
+ */
7349
7592
  scaleApRoNumMax?: string;
7593
+ /**
7594
+ * @remarks
7595
+ * Minimum limit for the number of read-only column storage nodes. Range: 0~7.
7596
+ *
7597
+ * @example
7598
+ * 1
7599
+ */
7350
7600
  scaleApRoNumMin?: string;
7351
7601
  /**
7352
7602
  * @remarks
7353
- * The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
7603
+ * Maximum scaling limit for a single node. Range: 1 PCU~32 PCU.
7354
7604
  *
7355
7605
  * @example
7356
7606
  * 3
@@ -7358,7 +7608,7 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7358
7608
  scaleMax?: string;
7359
7609
  /**
7360
7610
  * @remarks
7361
- * The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
7611
+ * Minimum scaling limit for a single node. Range: 1 PCU~31 PCU.
7362
7612
  *
7363
7613
  * @example
7364
7614
  * 1
@@ -7366,7 +7616,7 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7366
7616
  scaleMin?: string;
7367
7617
  /**
7368
7618
  * @remarks
7369
- * The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
7619
+ * Maximum scaling limit for the number of read-only nodes. Range: 0~15.
7370
7620
  *
7371
7621
  * @example
7372
7622
  * 4
@@ -7374,7 +7624,7 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7374
7624
  scaleRoNumMax?: string;
7375
7625
  /**
7376
7626
  * @remarks
7377
- * The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
7627
+ * Minimum scaling limit for the number of read-only nodes. Range: 0~15.
7378
7628
  *
7379
7629
  * @example
7380
7630
  * 2
@@ -7382,15 +7632,51 @@ export declare class DescribeDBClusterServerlessConfResponseBody extends $tea.Mo
7382
7632
  scaleRoNumMin?: string;
7383
7633
  /**
7384
7634
  * @remarks
7385
- * The detection period for no-activity suspension. Valid values: 300 to 86400. Unit: seconds. The value must be a multiple of 300.
7635
+ * Detection duration for idle shutdown. Range: 300~86,400. Unit: seconds. The detection duration must be a multiple of 300 seconds.
7386
7636
  *
7387
7637
  * @example
7388
7638
  * 10
7389
7639
  */
7390
7640
  secondsUntilAutoPause?: string;
7641
+ /**
7642
+ * @remarks
7643
+ * CPU upscale threshold.
7644
+ *
7645
+ * @example
7646
+ * 60
7647
+ */
7391
7648
  serverlessRuleCpuEnlargeThreshold?: string;
7649
+ /**
7650
+ * @remarks
7651
+ * CPU downscale threshold.
7652
+ *
7653
+ * @example
7654
+ * 30
7655
+ */
7392
7656
  serverlessRuleCpuShrinkThreshold?: string;
7657
+ /**
7658
+ * @remarks
7659
+ * Elasticity sensitivity. Values:
7660
+ *
7661
+ * - normal: Standard
7662
+ *
7663
+ * - flexible: Sensitive
7664
+ *
7665
+ * @example
7666
+ * normal
7667
+ */
7393
7668
  serverlessRuleMode?: string;
7669
+ /**
7670
+ * @remarks
7671
+ * Whether steady state is enabled. Values:
7672
+ *
7673
+ * 1: Enabled
7674
+ *
7675
+ * 0: Disabled
7676
+ *
7677
+ * @example
7678
+ * 1
7679
+ */
7394
7680
  switchs?: string;
7395
7681
  traditionalScaleMaxThreshold?: string;
7396
7682
  static names(): {
@@ -9619,6 +9905,8 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponse extends $tea.
9619
9905
  export declare class DescribeLicenseOrderDetailsRequest extends $tea.Model {
9620
9906
  /**
9621
9907
  * @remarks
9908
+ * The Alibaba Cloud order ID (or virtual order ID).
9909
+ *
9622
9910
  * This parameter is required.
9623
9911
  *
9624
9912
  * @example
@@ -9641,71 +9929,119 @@ export declare class DescribeLicenseOrderDetailsRequest extends $tea.Model {
9641
9929
  }
9642
9930
  export declare class DescribeLicenseOrderDetailsResponseBody extends $tea.Model {
9643
9931
  /**
9932
+ * @remarks
9933
+ * The number of generated activation codes.
9934
+ *
9644
9935
  * @example
9645
9936
  * 2
9646
9937
  */
9647
9938
  activatedCodeCount?: number;
9648
9939
  /**
9940
+ * @remarks
9941
+ * The maximum number of activation codes that you can apply for.
9942
+ *
9649
9943
  * @example
9650
9944
  * 8
9651
9945
  */
9652
9946
  activationCodeQuota?: number;
9653
9947
  /**
9948
+ * @remarks
9949
+ * The Alibaba Cloud order ID (including the virtual order ID).
9950
+ *
9654
9951
  * @example
9655
9952
  * 239618016570503
9656
9953
  */
9657
9954
  aliyunOrderId?: string;
9658
9955
  /**
9956
+ * @remarks
9957
+ * Indicates whether activation codes can be generated without the system identifier.
9958
+ *
9659
9959
  * @example
9660
9960
  * false
9661
9961
  */
9662
9962
  allowEmptySystemIdentifier?: boolean;
9663
9963
  /**
9964
+ * @remarks
9965
+ * The type of the engine. Valid values: PG, Oracle, and MySQL.
9966
+ *
9664
9967
  * @example
9665
9968
  * PG
9666
9969
  */
9667
9970
  engine?: string;
9668
9971
  /**
9972
+ * @remarks
9973
+ * The time when the order was created.
9974
+ *
9669
9975
  * @example
9670
9976
  * 2021-10-19 01:13:45
9671
9977
  */
9672
9978
  gmtCreated?: string;
9673
9979
  /**
9980
+ * @remarks
9981
+ * The time when the order was last updated.
9982
+ *
9674
9983
  * @example
9675
9984
  * 2024-10-16 16:46:20
9676
9985
  */
9677
9986
  gmtModified?: string;
9678
9987
  /**
9988
+ * @remarks
9989
+ * Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).
9990
+ *
9679
9991
  * @example
9680
9992
  * false
9681
9993
  */
9682
9994
  isVirtualOrder?: boolean;
9683
9995
  /**
9996
+ * @remarks
9997
+ * Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).
9998
+ *
9684
9999
  * @example
9685
10000
  * false
9686
10001
  */
9687
10002
  isVirtualOrderFrozen?: boolean;
9688
10003
  /**
10004
+ * @remarks
10005
+ * The plan type. Valid values:
10006
+ *
10007
+ * * single_node_subscribe
10008
+ * * single_node_long_term
10009
+ * * primary_backup_subscribe
10010
+ * * primary_backup_long_term
10011
+ * * pre_generation_long_term
10012
+ *
9689
10013
  * @example
9690
10014
  * pre_generation_long_term
9691
10015
  */
9692
10016
  packageType?: string;
9693
10017
  /**
10018
+ * @remarks
10019
+ * The validity period of the plan, which is one year (common) or thirty years (long-term).
10020
+ *
9694
10021
  * @example
9695
10022
  * 1 year
9696
10023
  */
9697
10024
  packageValidity?: string;
9698
10025
  /**
10026
+ * @remarks
10027
+ * The plan validity period, one year (common) or thirty years (long-term).
10028
+ *
9699
10029
  * @example
9700
10030
  * aliyun_market
9701
10031
  */
9702
10032
  purchaseChannel?: string;
9703
10033
  /**
10034
+ * @remarks
10035
+ * The request ID.
10036
+ *
9704
10037
  * @example
9705
10038
  * 22C0ACF0-DD29-4B67-9190-B7A48C******
9706
10039
  */
9707
10040
  requestId?: string;
9708
10041
  /**
10042
+ * @remarks
10043
+ * The virtual order ID.
10044
+ *
9709
10045
  * @example
9710
10046
  * 239618016570503
9711
10047
  */
@@ -9790,6 +10126,9 @@ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9790
10126
  /**
9791
10127
  * @remarks
9792
10128
  * Specifies whether to query only virtual orders.
10129
+ *
10130
+ * @example
10131
+ * true
9793
10132
  */
9794
10133
  virtualOrder?: boolean;
9795
10134
  static names(): {
@@ -12974,6 +13313,85 @@ export declare class ModifyAccountPasswordResponse extends $tea.Model {
12974
13313
  [key: string]: any;
12975
13314
  });
12976
13315
  }
13316
+ export declare class ModifyActiveOperationTasksRequest extends $tea.Model {
13317
+ /**
13318
+ * @example
13319
+ * 0
13320
+ */
13321
+ immediateStart?: number;
13322
+ ownerAccount?: string;
13323
+ ownerId?: number;
13324
+ /**
13325
+ * @remarks
13326
+ * This parameter is required.
13327
+ *
13328
+ * @example
13329
+ * cn-beijing
13330
+ */
13331
+ regionId?: string;
13332
+ resourceOwnerAccount?: string;
13333
+ resourceOwnerId?: number;
13334
+ securityToken?: string;
13335
+ /**
13336
+ * @example
13337
+ * 2023-04-25T06:00:00Z
13338
+ */
13339
+ switchTime?: string;
13340
+ /**
13341
+ * @remarks
13342
+ * This parameter is required.
13343
+ *
13344
+ * @example
13345
+ * 11111,22222
13346
+ */
13347
+ taskIds?: string;
13348
+ static names(): {
13349
+ [key: string]: string;
13350
+ };
13351
+ static types(): {
13352
+ [key: string]: any;
13353
+ };
13354
+ constructor(map?: {
13355
+ [key: string]: any;
13356
+ });
13357
+ }
13358
+ export declare class ModifyActiveOperationTasksResponseBody extends $tea.Model {
13359
+ /**
13360
+ * @example
13361
+ * 42CD2EF5-D77E-5AD4-961B-159330D98286
13362
+ */
13363
+ requestId?: string;
13364
+ /**
13365
+ * @example
13366
+ * 11111,22222
13367
+ */
13368
+ taskIds?: string;
13369
+ static names(): {
13370
+ [key: string]: string;
13371
+ };
13372
+ static types(): {
13373
+ [key: string]: any;
13374
+ };
13375
+ constructor(map?: {
13376
+ [key: string]: any;
13377
+ });
13378
+ }
13379
+ export declare class ModifyActiveOperationTasksResponse extends $tea.Model {
13380
+ headers?: {
13381
+ [key: string]: string;
13382
+ };
13383
+ statusCode?: number;
13384
+ body?: ModifyActiveOperationTasksResponseBody;
13385
+ static names(): {
13386
+ [key: string]: string;
13387
+ };
13388
+ static types(): {
13389
+ [key: string]: any;
13390
+ };
13391
+ constructor(map?: {
13392
+ [key: string]: any;
13393
+ });
13394
+ }
12977
13395
  export declare class ModifyAutoRenewAttributeRequest extends $tea.Model {
12978
13396
  /**
12979
13397
  * @remarks
@@ -13730,6 +14148,7 @@ export declare class ModifyDBClusterAndNodesParametersRequest extends $tea.Model
13730
14148
  plannedStartTime?: string;
13731
14149
  resourceOwnerAccount?: string;
13732
14150
  resourceOwnerId?: number;
14151
+ standbyClusterIdListNeedToSync?: string;
13733
14152
  static names(): {
13734
14153
  [key: string]: string;
13735
14154
  };
@@ -18713,6 +19132,143 @@ export declare class DescribeActivationCodesResponseBodyItems extends $tea.Model
18713
19132
  [key: string]: any;
18714
19133
  });
18715
19134
  }
19135
+ export declare class DescribeActiveOperationTasksResponseBodyItems extends $tea.Model {
19136
+ /**
19137
+ * @example
19138
+ * 0
19139
+ */
19140
+ allowCancel?: number;
19141
+ /**
19142
+ * @example
19143
+ * 0
19144
+ */
19145
+ allowChange?: number;
19146
+ /**
19147
+ * @example
19148
+ * S0
19149
+ */
19150
+ changeLevel?: string;
19151
+ /**
19152
+ * @example
19153
+ * System maintenance
19154
+ */
19155
+ changeLevelEn?: string;
19156
+ changeLevelZh?: string;
19157
+ /**
19158
+ * @example
19159
+ * 2020-06-09T22:00:42Z
19160
+ */
19161
+ createdTime?: string;
19162
+ /**
19163
+ * @example
19164
+ * cn-beijing-h
19165
+ */
19166
+ currentAVZ?: string;
19167
+ /**
19168
+ * @example
19169
+ * pc-*****************
19170
+ */
19171
+ DBClusterId?: string;
19172
+ DBNodeIds?: string[];
19173
+ /**
19174
+ * @example
19175
+ * MySQL
19176
+ */
19177
+ DBType?: string;
19178
+ /**
19179
+ * @example
19180
+ * 8.0
19181
+ */
19182
+ DBVersion?: string;
19183
+ /**
19184
+ * @example
19185
+ * 2020-06-11T15:59:59Z
19186
+ */
19187
+ deadline?: string;
19188
+ /**
19189
+ * @example
19190
+ * TransientDisconnection
19191
+ */
19192
+ impact?: string;
19193
+ /**
19194
+ * @example
19195
+ * Transient instance disconnection
19196
+ */
19197
+ impactEn?: string;
19198
+ impactZh?: string;
19199
+ /**
19200
+ * @example
19201
+ * test
19202
+ */
19203
+ insComment?: string;
19204
+ /**
19205
+ * @example
19206
+ * 2020-06-09T22:00:42Z
19207
+ */
19208
+ modifiedTime?: string;
19209
+ /**
19210
+ * @example
19211
+ * 04:00:00
19212
+ */
19213
+ prepareInterval?: string;
19214
+ /**
19215
+ * @example
19216
+ * cn-hangzhou
19217
+ */
19218
+ region?: string;
19219
+ /**
19220
+ * @example
19221
+ * userCancel
19222
+ */
19223
+ resultInfo?: string;
19224
+ /**
19225
+ * @example
19226
+ * 2023-05-19T02:48:17Z
19227
+ */
19228
+ startTime?: string;
19229
+ /**
19230
+ * @example
19231
+ * 3
19232
+ */
19233
+ status?: number;
19234
+ /**
19235
+ * @example
19236
+ * 2020-06-09T22:00:00Z
19237
+ */
19238
+ switchTime?: string;
19239
+ /**
19240
+ * @example
19241
+ * 107202351
19242
+ */
19243
+ taskId?: number;
19244
+ /**
19245
+ * @example
19246
+ * {
19247
+ * "Action": "UpgradeDBInstance"
19248
+ * }
19249
+ */
19250
+ taskParams?: string;
19251
+ /**
19252
+ * @example
19253
+ * DatabaseSoftwareUpgrading
19254
+ */
19255
+ taskType?: string;
19256
+ /**
19257
+ * @example
19258
+ * Minor version update
19259
+ */
19260
+ taskTypeEn?: string;
19261
+ taskTypeZh?: string;
19262
+ static names(): {
19263
+ [key: string]: string;
19264
+ };
19265
+ static types(): {
19266
+ [key: string]: any;
19267
+ };
19268
+ constructor(map?: {
19269
+ [key: string]: any;
19270
+ });
19271
+ }
18716
19272
  export declare class DescribeAutoRenewAttributeResponseBodyItemsAutoRenewAttribute extends $tea.Model {
18717
19273
  /**
18718
19274
  * @remarks
@@ -19067,8 +19623,7 @@ export declare class DescribeBackupsResponseBodyItemsBackup extends $tea.Model {
19067
19623
  DBClusterId?: string;
19068
19624
  /**
19069
19625
  * @remarks
19070
- * The expected expiration time of the backup set.
19071
- * > This parameter is supported only for instances that are enabled with sparse backup.
19626
+ * The expected expiration time of the backup set (This parameter is supported only for clusters for which sparse backup is enabled).
19072
19627
  *
19073
19628
  * @example
19074
19629
  * 2022-10-24T08:13:23Z
@@ -20115,6 +20670,12 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
20115
20670
  */
20116
20671
  port?: string;
20117
20672
  /**
20673
+ * @remarks
20674
+ * Indicates whether SSL encryption is enabled. Valid values:
20675
+ *
20676
+ * - **Enabled**
20677
+ * - **Disabled**
20678
+ *
20118
20679
  * @example
20119
20680
  * Enabled
20120
20681
  */
@@ -20152,6 +20713,9 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
20152
20713
  */
20153
20714
  addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
20154
20715
  /**
20716
+ * @remarks
20717
+ * The instance type.
20718
+ *
20155
20719
  * @example
20156
20720
  * ReadOnly
20157
20721
  * Maxscale
@@ -20159,11 +20723,20 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
20159
20723
  */
20160
20724
  custinsType?: string;
20161
20725
  /**
20726
+ * @remarks
20727
+ * The ID of the endpoint.
20728
+ *
20162
20729
  * @example
20163
20730
  * rm-************-normal
20164
20731
  */
20165
20732
  DBEndpointId?: string;
20166
20733
  /**
20734
+ * @remarks
20735
+ * The type of the endpoint. Valid values:
20736
+ *
20737
+ * - **Normal**: the standard endpoint
20738
+ * - **ReadWriteSplitting**: the read/write splitting endpoint
20739
+ *
20167
20740
  * @example
20168
20741
  * Normal
20169
20742
  */
@@ -20556,6 +21129,7 @@ export declare class DescribeDBClusterSSLResponseBodyItems extends $tea.Model {
20556
21129
  * pe-************
20557
21130
  */
20558
21131
  DBEndpointId?: string;
21132
+ SSLAutoRotate?: string;
20559
21133
  /**
20560
21134
  * @remarks
20561
21135
  * The SSL connection string.
@@ -24357,6 +24931,21 @@ export default class Client extends OpenApi {
24357
24931
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
24358
24932
  [key: string]: string;
24359
24933
  }, endpoint: string): string;
24934
+ /**
24935
+ * 用户侧取消任务
24936
+ *
24937
+ * @param request - CancelActiveOperationTasksRequest
24938
+ * @param runtime - runtime options for this request RuntimeOptions
24939
+ * @returns CancelActiveOperationTasksResponse
24940
+ */
24941
+ cancelActiveOperationTasksWithOptions(request: CancelActiveOperationTasksRequest, runtime: $Util.RuntimeOptions): Promise<CancelActiveOperationTasksResponse>;
24942
+ /**
24943
+ * 用户侧取消任务
24944
+ *
24945
+ * @param request - CancelActiveOperationTasksRequest
24946
+ * @returns CancelActiveOperationTasksResponse
24947
+ */
24948
+ cancelActiveOperationTasks(request: CancelActiveOperationTasksRequest): Promise<CancelActiveOperationTasksResponse>;
24360
24949
  /**
24361
24950
  * Cancels scheduled tasks that are not yet started.
24362
24951
  *
@@ -24545,7 +25134,7 @@ export default class Client extends OpenApi {
24545
25134
  */
24546
25135
  createColdStorageInstance(request: CreateColdStorageInstanceRequest): Promise<CreateColdStorageInstanceResponse>;
24547
25136
  /**
24548
- * Create Database Cluster
25137
+ * CreateDBCluster.
24549
25138
  *
24550
25139
  * @param request - CreateDBClusterRequest
24551
25140
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24553,7 +25142,7 @@ export default class Client extends OpenApi {
24553
25142
  */
24554
25143
  createDBClusterWithOptions(request: CreateDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBClusterResponse>;
24555
25144
  /**
24556
- * Create Database Cluster
25145
+ * CreateDBCluster.
24557
25146
  *
24558
25147
  * @param request - CreateDBClusterRequest
24559
25148
  * @returns CreateDBClusterResponse
@@ -25027,7 +25616,7 @@ export default class Client extends OpenApi {
25027
25616
  */
25028
25617
  describeAccounts(request: DescribeAccountsRequest): Promise<DescribeAccountsResponse>;
25029
25618
  /**
25030
- * 查询激活码详情
25619
+ * Queries the details of an activation code.
25031
25620
  *
25032
25621
  * @param request - DescribeActivationCodeDetailsRequest
25033
25622
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25035,7 +25624,7 @@ export default class Client extends OpenApi {
25035
25624
  */
25036
25625
  describeActivationCodeDetailsWithOptions(request: DescribeActivationCodeDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodeDetailsResponse>;
25037
25626
  /**
25038
- * 查询激活码详情
25627
+ * Queries the details of an activation code.
25039
25628
  *
25040
25629
  * @param request - DescribeActivationCodeDetailsRequest
25041
25630
  * @returns DescribeActivationCodeDetailsResponse
@@ -25056,6 +25645,21 @@ export default class Client extends OpenApi {
25056
25645
  * @returns DescribeActivationCodesResponse
25057
25646
  */
25058
25647
  describeActivationCodes(request: DescribeActivationCodesRequest): Promise<DescribeActivationCodesResponse>;
25648
+ /**
25649
+ * 用户侧查询运维任务
25650
+ *
25651
+ * @param request - DescribeActiveOperationTasksRequest
25652
+ * @param runtime - runtime options for this request RuntimeOptions
25653
+ * @returns DescribeActiveOperationTasksResponse
25654
+ */
25655
+ describeActiveOperationTasksWithOptions(request: DescribeActiveOperationTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActiveOperationTasksResponse>;
25656
+ /**
25657
+ * 用户侧查询运维任务
25658
+ *
25659
+ * @param request - DescribeActiveOperationTasksRequest
25660
+ * @returns DescribeActiveOperationTasksResponse
25661
+ */
25662
+ describeActiveOperationTasks(request: DescribeActiveOperationTasksRequest): Promise<DescribeActiveOperationTasksResponse>;
25059
25663
  /**
25060
25664
  * Queries the auto-renewal attributes of a subscription PolarDB cluster.
25061
25665
  *
@@ -25361,7 +25965,7 @@ export default class Client extends OpenApi {
25361
25965
  */
25362
25966
  describeDBClusterSSL(request: DescribeDBClusterSSLRequest): Promise<DescribeDBClusterSSLResponse>;
25363
25967
  /**
25364
- * Queries the configurations of a serverless cluster.
25968
+ * Query serverless configuration.
25365
25969
  *
25366
25970
  * @param request - DescribeDBClusterServerlessConfRequest
25367
25971
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25369,7 +25973,7 @@ export default class Client extends OpenApi {
25369
25973
  */
25370
25974
  describeDBClusterServerlessConfWithOptions(request: DescribeDBClusterServerlessConfRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterServerlessConfResponse>;
25371
25975
  /**
25372
- * Queries the configurations of a serverless cluster.
25976
+ * Query serverless configuration.
25373
25977
  *
25374
25978
  * @param request - DescribeDBClusterServerlessConfRequest
25375
25979
  * @returns DescribeDBClusterServerlessConfResponse
@@ -25664,7 +26268,7 @@ export default class Client extends OpenApi {
25664
26268
  */
25665
26269
  describeGlobalSecurityIPGroupRelation(request: DescribeGlobalSecurityIPGroupRelationRequest): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
25666
26270
  /**
25667
- * 查看License订单详情
26271
+ * Queries the information of a license order.
25668
26272
  *
25669
26273
  * @param request - DescribeLicenseOrderDetailsRequest
25670
26274
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25672,7 +26276,7 @@ export default class Client extends OpenApi {
25672
26276
  */
25673
26277
  describeLicenseOrderDetailsWithOptions(request: DescribeLicenseOrderDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrderDetailsResponse>;
25674
26278
  /**
25675
- * 查看License订单详情
26279
+ * Queries the information of a license order.
25676
26280
  *
25677
26281
  * @param request - DescribeLicenseOrderDetailsRequest
25678
26282
  * @returns DescribeLicenseOrderDetailsResponse
@@ -26135,6 +26739,21 @@ export default class Client extends OpenApi {
26135
26739
  * @returns ModifyAccountPasswordResponse
26136
26740
  */
26137
26741
  modifyAccountPassword(request: ModifyAccountPasswordRequest): Promise<ModifyAccountPasswordResponse>;
26742
+ /**
26743
+ * 用户侧修改任务
26744
+ *
26745
+ * @param request - ModifyActiveOperationTasksRequest
26746
+ * @param runtime - runtime options for this request RuntimeOptions
26747
+ * @returns ModifyActiveOperationTasksResponse
26748
+ */
26749
+ modifyActiveOperationTasksWithOptions(request: ModifyActiveOperationTasksRequest, runtime: $Util.RuntimeOptions): Promise<ModifyActiveOperationTasksResponse>;
26750
+ /**
26751
+ * 用户侧修改任务
26752
+ *
26753
+ * @param request - ModifyActiveOperationTasksRequest
26754
+ * @returns ModifyActiveOperationTasksResponse
26755
+ */
26756
+ modifyActiveOperationTasks(request: ModifyActiveOperationTasksRequest): Promise<ModifyActiveOperationTasksResponse>;
26138
26757
  /**
26139
26758
  * Modifies the auto-renewal attributes of a subscription PolarDB cluster.
26140
26759
  *
@@ -26532,7 +27151,7 @@ export default class Client extends OpenApi {
26532
27151
  */
26533
27152
  modifyDBNodeClass(request: ModifyDBNodeClassRequest): Promise<ModifyDBNodeClassResponse>;
26534
27153
  /**
26535
- * Enables or disables the hot standby node in a cluster.
27154
+ * Enables or disables the failover with hot replica feature for a node in a cluster.
26536
27155
  *
26537
27156
  * @param request - ModifyDBNodeHotReplicaModeRequest
26538
27157
  * @param runtime - runtime options for this request RuntimeOptions
@@ -26540,7 +27159,7 @@ export default class Client extends OpenApi {
26540
27159
  */
26541
27160
  modifyDBNodeHotReplicaModeWithOptions(request: ModifyDBNodeHotReplicaModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeHotReplicaModeResponse>;
26542
27161
  /**
26543
- * Enables or disables the hot standby node in a cluster.
27162
+ * Enables or disables the failover with hot replica feature for a node in a cluster.
26544
27163
  *
26545
27164
  * @param request - ModifyDBNodeHotReplicaModeRequest
26546
27165
  * @returns ModifyDBNodeHotReplicaModeResponse