@alicloud/polardb20170801 5.2.0 → 5.2.2

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
@@ -682,6 +682,12 @@ export declare class CreateAccountRequest extends $tea.Model {
682
682
  * * **0 or unspecified**: does not grant required permissions.
683
683
  * * **1**: grants required permissions.
684
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
+ *
685
691
  * @example
686
692
  * 0
687
693
  */
@@ -736,6 +742,8 @@ export declare class CreateAccountResponse extends $tea.Model {
736
742
  export declare class CreateActivationCodeRequest extends $tea.Model {
737
743
  /**
738
744
  * @remarks
745
+ * The Alibaba Cloud order ID (including the virtual order ID).
746
+ *
739
747
  * This parameter is required.
740
748
  *
741
749
  * @example
@@ -743,12 +751,17 @@ export declare class CreateActivationCodeRequest extends $tea.Model {
743
751
  */
744
752
  aliyunOrderId?: string;
745
753
  /**
754
+ * @remarks
755
+ * The description of the activation code.
756
+ *
746
757
  * @example
747
758
  * testCode
748
759
  */
749
760
  description?: string;
750
761
  /**
751
762
  * @remarks
763
+ * The MAC address.
764
+ *
752
765
  * This parameter is required.
753
766
  *
754
767
  * @example
@@ -757,6 +770,8 @@ export declare class CreateActivationCodeRequest extends $tea.Model {
757
770
  macAddress?: string;
758
771
  /**
759
772
  * @remarks
773
+ * The name of the activation code. The name can contain only letters, digits, underscores (_), and hyphens (-). The activation code file downloaded from the console is named based on this name.
774
+ *
760
775
  * This parameter is required.
761
776
  *
762
777
  * @example
@@ -768,6 +783,9 @@ export declare class CreateActivationCodeRequest extends $tea.Model {
768
783
  resourceOwnerAccount?: string;
769
784
  resourceOwnerId?: number;
770
785
  /**
786
+ * @remarks
787
+ * The system identifier of the database. This parameter is required if you set AllowEmptySystemIdentifier to false.
788
+ *
771
789
  * @example
772
790
  * 1234567890123456
773
791
  */
@@ -784,59 +802,89 @@ export declare class CreateActivationCodeRequest extends $tea.Model {
784
802
  }
785
803
  export declare class CreateActivationCodeResponseBody extends $tea.Model {
786
804
  /**
805
+ * @remarks
806
+ * The time when the activation code takes effect.
807
+ *
787
808
  * @example
788
809
  * 2024-10-16 16:46:20
789
810
  */
790
811
  activateAt?: string;
791
812
  /**
813
+ * @remarks
814
+ * 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.
815
+ *
792
816
  * @example
793
817
  * AAEAA******AAA=
794
818
  */
795
819
  certContentB64?: string;
796
820
  /**
821
+ * @remarks
822
+ * The description of the activation code.
823
+ *
797
824
  * @example
798
825
  * testCode
799
826
  */
800
827
  description?: string;
801
828
  /**
829
+ * @remarks
830
+ * The time when the activation code expires.
831
+ *
802
832
  * @example
803
833
  * 2054-10-09 16:46:20
804
834
  */
805
835
  expireAt?: string;
806
836
  /**
837
+ * @remarks
838
+ * The time when the activation code was created.
839
+ *
807
840
  * @example
808
841
  * 2024-10-16 16:46:20
809
842
  */
810
843
  gmtCreated?: string;
811
844
  /**
845
+ * @remarks
846
+ * The time when the activation code was last updated.
847
+ *
812
848
  * @example
813
849
  * 2024-10-16 16:46:20
814
850
  */
815
851
  gmtModified?: string;
816
852
  /**
853
+ * @remarks
854
+ * The activation code ID.
855
+ *
817
856
  * @example
818
857
  * 123
819
858
  */
820
859
  id?: number;
821
860
  /**
861
+ * @remarks
862
+ * The MAC address.
863
+ *
822
864
  * @example
823
865
  * 12:34:56:78:98:00
824
866
  */
825
867
  macAddress?: string;
826
868
  /**
869
+ * @remarks
870
+ * The name of the activation code.
871
+ *
827
872
  * @example
828
873
  * testName
829
874
  */
830
875
  name?: string;
831
876
  /**
832
877
  * @remarks
833
- * Id of the request
878
+ * The request ID.
834
879
  *
835
880
  * @example
836
881
  * 4CE6DF97-AEA4-484F-906F-C407EE******
837
882
  */
838
883
  requestId?: string;
839
884
  /**
885
+ * @remarks
886
+ * The system identifier of the database.
887
+ *
840
888
  * @example
841
889
  * 1234567890123456
842
890
  */
@@ -1090,6 +1138,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1090
1138
  * NONE
1091
1139
  */
1092
1140
  backupRetentionPolicyOnClusterDeletion?: string;
1141
+ burstingEnabled?: string;
1093
1142
  /**
1094
1143
  * @remarks
1095
1144
  * Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.
@@ -2537,6 +2586,13 @@ export declare class CreateGlobalDatabaseNetworkRequest extends $tea.Model {
2537
2586
  * pc-bp1q76364ird*****
2538
2587
  */
2539
2588
  DBClusterId?: string;
2589
+ /**
2590
+ * @remarks
2591
+ * Specifies whether to create a global domain name.
2592
+ *
2593
+ * @example
2594
+ * false
2595
+ */
2540
2596
  enableGlobalDomainName?: boolean;
2541
2597
  /**
2542
2598
  * @remarks
@@ -2720,6 +2776,8 @@ export declare class CreateGlobalSecurityIPGroupResponse extends $tea.Model {
2720
2776
  export declare class CreateOrGetVirtualLicenseOrderRequest extends $tea.Model {
2721
2777
  /**
2722
2778
  * @remarks
2779
+ * The type of the engine. Valid values: PG, Oracle, and MySQL.
2780
+ *
2723
2781
  * This parameter is required.
2724
2782
  *
2725
2783
  * @example
@@ -2742,69 +2800,105 @@ export declare class CreateOrGetVirtualLicenseOrderRequest extends $tea.Model {
2742
2800
  }
2743
2801
  export declare class CreateOrGetVirtualLicenseOrderResponseBody extends $tea.Model {
2744
2802
  /**
2803
+ * @remarks
2804
+ * The number of generated activation codes.
2805
+ *
2745
2806
  * @example
2746
2807
  * 1
2747
2808
  */
2748
2809
  activatedCodeCount?: number;
2749
2810
  /**
2811
+ * @remarks
2812
+ * The maximum number of activation codes that you can apply for.
2813
+ *
2750
2814
  * @example
2751
2815
  * 10
2752
2816
  */
2753
2817
  activationCodeQuota?: number;
2754
2818
  /**
2819
+ * @remarks
2820
+ * The Alibaba Cloud order ID (including the virtual order ID).
2821
+ *
2755
2822
  * @example
2756
2823
  * 2233****445566
2757
2824
  */
2758
2825
  aliyunOrderId?: string;
2759
2826
  /**
2827
+ * @remarks
2828
+ * Indicates whether activation codes can be generated without the system identifier.
2829
+ *
2760
2830
  * @example
2761
2831
  * false
2762
2832
  */
2763
2833
  allowEmptySystemIdentifier?: boolean;
2764
2834
  /**
2835
+ * @remarks
2836
+ * The time when the order was created.
2837
+ *
2765
2838
  * @example
2766
2839
  * 2024-10-16 16:46:20
2767
2840
  */
2768
2841
  gmtCreated?: string;
2769
2842
  /**
2843
+ * @remarks
2844
+ * The time when the order was last updated.
2845
+ *
2770
2846
  * @example
2771
2847
  * 2024-10-16 16:46:20
2772
2848
  */
2773
2849
  gmtModified?: string;
2774
2850
  /**
2851
+ * @remarks
2852
+ * Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).
2853
+ *
2775
2854
  * @example
2776
2855
  * true
2777
2856
  */
2778
2857
  isVirtualOrder?: boolean;
2779
2858
  /**
2859
+ * @remarks
2860
+ * Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).
2861
+ *
2780
2862
  * @example
2781
2863
  * false
2782
2864
  */
2783
2865
  isVirtualOrderFrozen?: boolean;
2784
2866
  /**
2867
+ * @remarks
2868
+ * The plan type.
2869
+ *
2785
2870
  * @example
2786
2871
  * pre_generation_long_term
2787
2872
  */
2788
2873
  packageType?: string;
2789
2874
  /**
2875
+ * @remarks
2876
+ * The validity period of the plan, which is one year (common) or thirty years (long-term).
2877
+ *
2790
2878
  * @example
2791
2879
  * 30 years
2792
2880
  */
2793
2881
  packageValidity?: string;
2794
2882
  /**
2883
+ * @remarks
2884
+ * The purchase channel.
2885
+ *
2795
2886
  * @example
2796
2887
  * aliyun_market
2797
2888
  */
2798
2889
  purchaseChannel?: string;
2799
2890
  /**
2800
2891
  * @remarks
2801
- * Id of the request
2892
+ * The ID of the request.
2802
2893
  *
2803
2894
  * @example
2804
2895
  * 45D24263-7E3A-4140-9472-************
2805
2896
  */
2806
2897
  requestId?: string;
2807
2898
  /**
2899
+ * @remarks
2900
+ * The ID of the virtual order.
2901
+ *
2808
2902
  * @example
2809
2903
  * 2024********483
2810
2904
  */
@@ -4135,6 +4229,11 @@ export declare class DescribeAITaskStatusRequest extends $tea.Model {
4135
4229
  });
4136
4230
  }
4137
4231
  export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4232
+ /**
4233
+ * @remarks
4234
+ * The name of the database account that is used to connect to the AI nodes in the cluster.
4235
+ */
4236
+ accountName?: string;
4138
4237
  /**
4139
4238
  * @remarks
4140
4239
  * The cluster ID.
@@ -4153,10 +4252,10 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4153
4252
  requestId?: string;
4154
4253
  /**
4155
4254
  * @remarks
4156
- * The state of the PolarDB for AI feature. Valid values:
4255
+ * The status of the PolarDB for AI feature. Valid values:
4157
4256
  *
4158
- * * **1**: The feature is enabled.
4159
- * * **2**: The feature is disabled.
4257
+ * * **1**: enabled.
4258
+ * * **2**: disabled.
4160
4259
  *
4161
4260
  * @example
4162
4261
  * 1
@@ -4164,7 +4263,7 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4164
4263
  status?: string;
4165
4264
  /**
4166
4265
  * @remarks
4167
- * The state description of the PolarDB for AI feature.
4266
+ * The description of the status of the PolarDB for AI feature.
4168
4267
  *
4169
4268
  * @example
4170
4269
  * Closed State
@@ -4423,6 +4522,8 @@ export declare class DescribeActivationCodeDetailsResponse extends $tea.Model {
4423
4522
  export declare class DescribeActivationCodesRequest extends $tea.Model {
4424
4523
  /**
4425
4524
  * @remarks
4525
+ * The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
4526
+ *
4426
4527
  * This parameter is required.
4427
4528
  *
4428
4529
  * @example
@@ -4432,11 +4533,17 @@ export declare class DescribeActivationCodesRequest extends $tea.Model {
4432
4533
  ownerAccount?: string;
4433
4534
  ownerId?: number;
4434
4535
  /**
4536
+ * @remarks
4537
+ * The page number.
4538
+ *
4435
4539
  * @example
4436
4540
  * 1
4437
4541
  */
4438
4542
  pageNumber?: number;
4439
4543
  /**
4544
+ * @remarks
4545
+ * The number of entries per page.
4546
+ *
4440
4547
  * @example
4441
4548
  * 30
4442
4549
  */
@@ -4454,26 +4561,39 @@ export declare class DescribeActivationCodesRequest extends $tea.Model {
4454
4561
  });
4455
4562
  }
4456
4563
  export declare class DescribeActivationCodesResponseBody extends $tea.Model {
4564
+ /**
4565
+ * @remarks
4566
+ * The queried activation codes.
4567
+ */
4457
4568
  items?: DescribeActivationCodesResponseBodyItems[];
4458
4569
  /**
4570
+ * @remarks
4571
+ * The page number.
4572
+ *
4459
4573
  * @example
4460
4574
  * 1
4461
4575
  */
4462
4576
  pageNumber?: number;
4463
4577
  /**
4578
+ * @remarks
4579
+ * The number of entries returned on the current page.
4580
+ *
4464
4581
  * @example
4465
4582
  * 1
4466
4583
  */
4467
4584
  pageRecordCount?: number;
4468
4585
  /**
4469
4586
  * @remarks
4470
- * Id of the request
4587
+ * The request ID.
4471
4588
  *
4472
4589
  * @example
4473
4590
  * 65D7ACE6-4A61-4B6E-B357-8CB24A******
4474
4591
  */
4475
4592
  requestId?: string;
4476
4593
  /**
4594
+ * @remarks
4595
+ * The total number of entries returned.
4596
+ *
4477
4597
  * @example
4478
4598
  * 1
4479
4599
  */
@@ -4517,7 +4637,7 @@ export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
4517
4637
  ownerId?: number;
4518
4638
  /**
4519
4639
  * @remarks
4520
- * The page number. The value must be an integer that is larger than 0 and does not exceed the maximum value of the INTEGER data type. Default value: 1.
4640
+ * The page number. The value must be an integer that is greater than 0. Default value: 1.
4521
4641
  *
4522
4642
  * @example
4523
4643
  * 1
@@ -4525,7 +4645,7 @@ export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
4525
4645
  pageNumber?: number;
4526
4646
  /**
4527
4647
  * @remarks
4528
- * The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
4648
+ * The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.
4529
4649
  *
4530
4650
  * @example
4531
4651
  * 30
@@ -5220,6 +5340,7 @@ export declare class DescribeBackupsResponseBody extends $tea.Model {
5220
5340
  * 24A1990B-4F6E-482B-B8CB-75C612******
5221
5341
  */
5222
5342
  requestId?: string;
5343
+ totalLevel2BackupSize?: string;
5223
5344
  /**
5224
5345
  * @remarks
5225
5346
  * The total number of returned entries.
@@ -5617,6 +5738,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5617
5738
  * 5,242,880
5618
5739
  */
5619
5740
  blktagUsed?: number;
5741
+ burstingEnabled?: string;
5620
5742
  /**
5621
5743
  * @remarks
5622
5744
  * [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
@@ -6565,7 +6687,11 @@ export declare class DescribeDBClusterEndpointsResponse extends $tea.Model {
6565
6687
  export declare class DescribeDBClusterMigrationRequest extends $tea.Model {
6566
6688
  /**
6567
6689
  * @remarks
6568
- * The ID of the cluster.
6690
+ * The network type of the endpoint. Valid values:
6691
+ *
6692
+ * * **Public**: the public endpoint
6693
+ * * **Private**: the internal endpoint (VPC)
6694
+ * * **Inner**: the internal endpoint (classic network)
6569
6695
  *
6570
6696
  * This parameter is required.
6571
6697
  *
@@ -6590,7 +6716,10 @@ export declare class DescribeDBClusterMigrationRequest extends $tea.Model {
6590
6716
  export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6591
6717
  /**
6592
6718
  * @remarks
6593
- * The description of a migration exception. If no exception occurs during the migration, an empty string is returned.
6719
+ * The mode of the source ApsaraDB RDS instance. Valid values:
6720
+ *
6721
+ * * **rw**: read and write mode
6722
+ * * **ro**: read-only mode
6594
6723
  *
6595
6724
  * @example
6596
6725
  * test
@@ -6598,12 +6727,12 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6598
6727
  comment?: string;
6599
6728
  /**
6600
6729
  * @remarks
6601
- * The endpoints of the PolarDB cluster.
6730
+ * The port number.
6602
6731
  */
6603
6732
  DBClusterEndpointList?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointList[];
6604
6733
  /**
6605
6734
  * @remarks
6606
- * The ID of the cluster.
6735
+ * The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
6607
6736
  *
6608
6737
  * @example
6609
6738
  * pc-****************
@@ -6611,10 +6740,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6611
6740
  DBClusterId?: string;
6612
6741
  /**
6613
6742
  * @remarks
6614
- * The mode of the PolarDB cluster. Valid values:
6615
- *
6616
- * * **rw**: read and write mode
6617
- * * **ro**: read-only mode
6743
+ * Details about the endpoints.
6618
6744
  *
6619
6745
  * @example
6620
6746
  * ro
@@ -6622,7 +6748,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6622
6748
  DBClusterReadWriteMode?: string;
6623
6749
  /**
6624
6750
  * @remarks
6625
- * The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
6751
+ * The vSwitch ID.
6626
6752
  *
6627
6753
  * @example
6628
6754
  * 0
@@ -6630,7 +6756,11 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6630
6756
  delayedSeconds?: number;
6631
6757
  /**
6632
6758
  * @remarks
6633
- * The ID of the synchronous task.
6759
+ * The network type of the endpoint. Valid values:
6760
+ *
6761
+ * * **Public**: the public endpoint
6762
+ * * **Private**: the internal endpoint (VPC)
6763
+ * * **Inner**: the internal endpoint (classic network)
6634
6764
  *
6635
6765
  * @example
6636
6766
  * dts**********618bs
@@ -6638,7 +6768,10 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6638
6768
  dtsInstanceId?: string;
6639
6769
  /**
6640
6770
  * @remarks
6641
- * The expiration time of the replication between ApsaraDB RDS and PolarDB. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.
6771
+ * The mode of the PolarDB cluster. Valid values:
6772
+ *
6773
+ * * **rw**: read and write mode
6774
+ * * **ro**: read-only mode
6642
6775
  *
6643
6776
  * @example
6644
6777
  * 2020-06-17T01:56:36Z
@@ -6646,15 +6779,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6646
6779
  expiredTime?: string;
6647
6780
  /**
6648
6781
  * @remarks
6649
- * The migration state of the PolarDB cluster. Valid values:
6650
- *
6651
- * * **NO_MIGRATION**: No migration task is running.
6652
- * * **RDS2POLARDB_CLONING**: Data is being replicated.
6653
- * * **RDS2POLARDB_SYNCING**: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode.
6654
- * * **SWITCHING**: Databases are being switched.
6655
- * * **POLARDB2RDS_SYNCING**: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications.
6656
- * * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
6657
- * * **CLOSING_MIGRATION**: The migration task is being terminated.
6782
+ * The endpoint.
6658
6783
  *
6659
6784
  * @example
6660
6785
  * RDS2POLARDB_SYNCING
@@ -6662,15 +6787,12 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6662
6787
  migrationStatus?: string;
6663
6788
  /**
6664
6789
  * @remarks
6665
- * The endpoints of the ApsaraDB RDS instance.
6790
+ * The port number.
6666
6791
  */
6667
6792
  rdsEndpointList?: DescribeDBClusterMigrationResponseBodyRdsEndpointList[];
6668
6793
  /**
6669
6794
  * @remarks
6670
- * The mode of the source ApsaraDB RDS instance. Valid values:
6671
- *
6672
- * * **rw**: read and write mode
6673
- * * **ro**: read-only mode
6795
+ * The ID of the synchronous task.
6674
6796
  *
6675
6797
  * @example
6676
6798
  * rw
@@ -6678,7 +6800,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6678
6800
  rdsReadWriteMode?: string;
6679
6801
  /**
6680
6802
  * @remarks
6681
- * The ID of the request.
6803
+ * The ID of the source ApsaraDB RDS instance.
6682
6804
  *
6683
6805
  * @example
6684
6806
  * F2A9EFA7-915F-4572-8299-85A307******
@@ -6686,29 +6808,28 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6686
6808
  requestId?: string;
6687
6809
  /**
6688
6810
  * @remarks
6689
- * The ID of the source ApsaraDB RDS instance.
6811
+ * The endpoints of the ApsaraDB RDS instance.
6690
6812
  *
6691
6813
  * @example
6692
6814
  * rm-************
6693
6815
  */
6694
6816
  sourceRDSDBInstanceId?: string;
6695
6817
  /**
6696
- * @remarks
6697
- * The type of the source database. Valid values:
6698
- *
6699
- * * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
6700
- * * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
6701
- *
6702
6818
  * @example
6703
6819
  * PolarDBMySQL
6704
6820
  */
6705
6821
  srcDbType?: string;
6706
6822
  /**
6707
6823
  * @remarks
6708
- * The synchronization direction. Valid values:
6824
+ * The migration state of the PolarDB cluster. Valid values:
6709
6825
  *
6710
- * * **RDS2POLARDB**: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster.
6711
- * * **POLARDB2RDS**: Data is replicated from a PolarDB cluster to an ApsaraDB RDS instance.
6826
+ * * **NO_MIGRATION**: No migration task is running.
6827
+ * * **RDS2POLARDB_CLONING**: Data is being replicated.
6828
+ * * **RDS2POLARDB_SYNCING**: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode.
6829
+ * * **SWITCHING**: Databases are being switched.
6830
+ * * **POLARDB2RDS_SYNCING**: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications.
6831
+ * * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
6832
+ * * **CLOSING_MIGRATION**: The migration task is being terminated.
6712
6833
  *
6713
6834
  * @example
6714
6835
  * RDS2POLARDB
@@ -8506,9 +8627,7 @@ export declare class DescribeDBProxyPerformanceRequest extends $tea.Model {
8506
8627
  DBEndpointId?: string;
8507
8628
  /**
8508
8629
  * @remarks
8509
- * Database instance node ID.
8510
- *
8511
- * > It is used to query the metrics of Proxy on different DB nodes, supporting metrics such as PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.
8630
+ * The ID of the node in the cluster. This parameter can be used to query the performance metrics of PolarProxy on different nodes. The following metrics are supported: PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.
8512
8631
  *
8513
8632
  * @example
8514
8633
  * pi-******************
@@ -9619,6 +9738,9 @@ export declare class DescribeLicenseOrderDetailsResponse extends $tea.Model {
9619
9738
  }
9620
9739
  export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9621
9740
  /**
9741
+ * @remarks
9742
+ * The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
9743
+ *
9622
9744
  * @example
9623
9745
  * 239618016570503
9624
9746
  */
@@ -9626,27 +9748,49 @@ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9626
9748
  ownerAccount?: string;
9627
9749
  ownerId?: number;
9628
9750
  /**
9751
+ * @remarks
9752
+ * The type of the package. Valid values:
9753
+ *
9754
+ * * single_node_subscribe: Single-node Edition (Subscription).
9755
+ * * single_node_long_term: Single-node Edition (Long-term).
9756
+ * * primary_backup_subscribe: HA Edition (Subscription).
9757
+ * * primary_backup_long_term: HA Edition (Long-term).
9758
+ * * pre_generation_long_term: Pre-generated (Long-term).
9759
+ *
9629
9760
  * @example
9630
9761
  * single_node_subscribe
9631
9762
  */
9632
9763
  packageType?: string;
9633
9764
  /**
9765
+ * @remarks
9766
+ * The page number.
9767
+ *
9634
9768
  * @example
9635
9769
  * 1
9636
9770
  */
9637
9771
  pageNumber?: number;
9638
9772
  /**
9773
+ * @remarks
9774
+ * The number of entries per page.
9775
+ *
9639
9776
  * @example
9640
9777
  * 30
9641
9778
  */
9642
9779
  pageSize?: number;
9643
9780
  /**
9781
+ * @remarks
9782
+ * The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market specifies Alibaba Cloud Marketplace. aliyun_public specifies the PolarDB buy page.
9783
+ *
9644
9784
  * @example
9645
9785
  * aliyun_market
9646
9786
  */
9647
9787
  purchaseChannel?: string;
9648
9788
  resourceOwnerAccount?: string;
9649
9789
  resourceOwnerId?: number;
9790
+ /**
9791
+ * @remarks
9792
+ * Specifies whether to query only virtual orders.
9793
+ */
9650
9794
  virtualOrder?: boolean;
9651
9795
  static names(): {
9652
9796
  [key: string]: string;
@@ -9659,23 +9803,39 @@ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9659
9803
  });
9660
9804
  }
9661
9805
  export declare class DescribeLicenseOrdersResponseBody extends $tea.Model {
9806
+ /**
9807
+ * @remarks
9808
+ * The queried orders.
9809
+ */
9662
9810
  items?: DescribeLicenseOrdersResponseBodyItems[];
9663
9811
  /**
9812
+ * @remarks
9813
+ * The page number.
9814
+ *
9664
9815
  * @example
9665
9816
  * 1
9666
9817
  */
9667
9818
  pageNumber?: number;
9668
9819
  /**
9820
+ * @remarks
9821
+ * The number of entries returned on the current page.
9822
+ *
9669
9823
  * @example
9670
9824
  * 12
9671
9825
  */
9672
9826
  pageRecordCount?: number;
9673
9827
  /**
9828
+ * @remarks
9829
+ * The request ID.
9830
+ *
9674
9831
  * @example
9675
9832
  * 34458CD3-33E0-4624-BFEF-840C15******
9676
9833
  */
9677
9834
  requestId?: string;
9678
9835
  /**
9836
+ * @remarks
9837
+ * The total number of entries returned.
9838
+ *
9679
9839
  * @example
9680
9840
  * 50
9681
9841
  */
@@ -12044,9 +12204,9 @@ export declare class EvaluateRegionResourceRequest extends $tea.Model {
12044
12204
  * @remarks
12045
12205
  * The cluster link type. The backend randomly selects the default value. Valid values:
12046
12206
  *
12047
- * * **lvs** :Linux virtual server
12048
- * * **proxy**: proxy server
12049
- * * **dns**: domain name system
12207
+ * * **lvs**: Linux virtual server.
12208
+ * * **proxy**: proxy server.
12209
+ * * **dns**: domain name system.
12050
12210
  *
12051
12211
  * @example
12052
12212
  * lvs
@@ -12116,9 +12276,9 @@ export declare class EvaluateRegionResourceRequest extends $tea.Model {
12116
12276
  dispenseMode?: string;
12117
12277
  /**
12118
12278
  * @remarks
12119
- * Specifies whether Maxscale is created. Default value: true. Valid values:
12279
+ * Specifies whether to create Maxscale. Valid values:
12120
12280
  *
12121
- * * **true**
12281
+ * * **true** (default)
12122
12282
  * * **false**
12123
12283
  *
12124
12284
  * This parameter is required.
@@ -13236,6 +13396,22 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
13236
13396
  * 0
13237
13397
  */
13238
13398
  faultSimulateMode?: string;
13399
+ /**
13400
+ * @remarks
13401
+ * Specifies whether to enable automatic IMCI-based query acceleration. IMCI is short for In-Memory Column Index. Valid values:
13402
+ *
13403
+ * * `ON`: enables automatic IMCI-based query acceleration.
13404
+ * * `OFF`: disables automatic IMCI-based query acceleration.
13405
+ *
13406
+ * >
13407
+ *
13408
+ * * This parameter is supported only for PolarDB for MySQL clusters.
13409
+ *
13410
+ * * For information about the cluster version limits, see [Automatic IMCI-based query acceleration](https://help.aliyun.com/document_detail/2854119.html).
13411
+ *
13412
+ * @example
13413
+ * OFF
13414
+ */
13239
13415
  imciAutoIndex?: string;
13240
13416
  ownerAccount?: string;
13241
13417
  ownerId?: number;
@@ -13821,10 +13997,10 @@ export declare class ModifyDBClusterDescriptionResponse extends $tea.Model {
13821
13997
  export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13822
13998
  /**
13823
13999
  * @remarks
13824
- * Specifies whether to automatically associate newly added nodes with the cluster endpoint. Default value: Disable. Valid values:
14000
+ * Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
13825
14001
  *
13826
- * * **Enable**
13827
- * * **Disable**
14002
+ * * **Enable**: enables automatic association of newly added nodes with the cluster endpoint.
14003
+ * * **Disable** (default): disables automatic association of newly added nodes with the cluster endpoint.
13828
14004
  *
13829
14005
  * @example
13830
14006
  * Enable
@@ -13860,60 +14036,74 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13860
14036
  DBEndpointId?: string;
13861
14037
  /**
13862
14038
  * @remarks
13863
- * The advanced configurations of the cluster endpoint, which are in the JSON format. You can specify the configurations of the following attributes: consistency level, transaction splitting, connection pool, and primary node accepts read requests.
14039
+ * The advanced configurations of the cluster endpoint, which are in the JSON format. You can configure the consistency level, transaction splitting, and connection pool settings, and specify whether the primary node accepts read requests.
13864
14040
  *
13865
- * * Specifies the load balancing policy in the format of `{\\"LoadBalancePolicy\\":\\"Selected value\\"}`. Default value: 0. Valid values:
14041
+ * * The load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
13866
14042
  *
13867
- * * **0**: connections-based load balancing
14043
+ * * **0** (default): connections-based load balancing
13868
14044
  * * **1**: active requests-based load balancing
13869
14045
  *
13870
- * * Specifies whether to enable the primary node accepts read requests feature in the format of `{\\"MasterAcceptReads\\":\\"Selected value\\"}`. Default value: on. Valid values:
14046
+ * * Specifies whether to allow the primary node to accept read requests. Format: `{\\"MasterAcceptReads\\":\\"Specification about whether to allow the primary node to accept read requests\\"}`. Valid values:
13871
14047
  *
13872
- * * **on**
13873
- * * **off**
14048
+ * * **on** (default): allows the primary node to accept read requests.
14049
+ * * **off**: does not allow the primary node to accept read requests.
13874
14050
  *
13875
- * * Specifies whether to enable the transaction splitting feature in the format of `{\\"DistributedTransaction\\":\\"Selected value\\"}`. Default value: on. Valid values:
14051
+ * * Specifies whether to enable the transaction splitting feature. Format: `{\\"DistributedTransaction\\":\\"Specification about whether to enable the transaction splitting feature\\"}`. Valid values:
13876
14052
  *
13877
- * * **on**
13878
- * * **off**
14053
+ * * **on** (default): enables the transaction splitting feature.
14054
+ * * **off**: disables the transaction splitting feature.
13879
14055
  *
13880
- * * Specifies the consistency level in the format of `{\\"ConsistLevel\\":\\"Selected value\\"}`. Default value: 1. Valid values:
14056
+ * * The consistency level. Format: `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
13881
14057
  *
13882
14058
  * * **0**: eventual consistency (weak)
13883
- * * **1**: session consistency (medium)
14059
+ * * **1** (default): session consistency (medium)
13884
14060
  * * **2**: global consistency (strong)
13885
14061
  *
13886
- * * Specifies the connection pool in the format of `{\\"ConnectionPersist\\":\\"Selected value\\"}`. Default value: off. Valid values:
14062
+ * * The global consistency timeout. Format: `{\\"ConsistTimeout\\":\\"Global consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 20. Unit: ms.
13887
14063
  *
13888
- * * **off**: disables the connection pool.
14064
+ * * The session consistency timeout. Format: `{\\"ConsistSessionTimeout\\":\\"Session consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 0. Unit: ms.
14065
+ *
14066
+ * * The global (or session) consistency timeout policy. Format: `{\\"ConsistTimeoutAction\\":\\"Consistency timeout policy\\"}`. Valid values:
14067
+ *
14068
+ * * **0** (default): PolarProxy sends read requests to the primary node.
14069
+ * * **1**: PolarProxy returns the "wait replication complete timeout, please retry" error message to the application.
14070
+ *
14071
+ * * Specifies whether to enable the connection pool feature. Format: `{\\"ConnectionPersist\\":\\"Specification about whether to enable the connection pool feature\\"}`. Valid values:
14072
+ *
14073
+ * * **off** (default): disables the connection pool feature.
13889
14074
  * * **Session**: enables the session-level connection pool.
13890
14075
  * * **Transaction**: enables the transaction-level connection pool.
13891
14076
  *
13892
- * * Specifies whether to enable the parallel query feature in the format of `{\\"MaxParallelDegree\\":\\"Selected value\\"}`. Default value: off. Valid values:
14077
+ * * Specifies whether to enable the parallel query feature. Format: `{\\"MaxParallelDegree\\":\\"Specification about whether to enable the parallel query feature\\"}`. Valid values:
13893
14078
  *
13894
- * * **on**
13895
- * * **off**
14079
+ * * **on**: enables the parallel query feature.
14080
+ * * **off** (default): disables the parallel query feature.
13896
14081
  *
13897
- * * Specifies whether to enable the automatic request distribution between row store and column store nodes feature in the format of `{\\"EnableHtapImci\\":\\"Selected value\\"}`. Default value: off. Valid values:
14082
+ * * Specifies whether to enable the automatic request distribution among row store and column store nodes feature. Format: `{\\"EnableHtapImci\\":\\"Specification about whether to enable automatic request distribution among row store and column store nodes feature\\"}`. Valid values:
13898
14083
  *
13899
- * * **on**
13900
- * * **off**
14084
+ * * **on**: enables the automatic request distribution among row store and column store nodes feature.
14085
+ * * **off** (default): disables the automatic request distribution among row store and column store nodes feature.
13901
14086
  *
13902
- * * Specifies whether to enable the overload protection feature in the format of `{\\"EnableOverloadThrottle\\":\\"Selected value\\"}`. Default value: off. Valid values:
14087
+ * * Specifies whether to enable the overload protection feature. Format: `{\\"EnableOverloadThrottle\\":\\"Specification about whether to enable the overload protection feature\\"}`. Valid values:
13903
14088
  *
13904
- * * **on**
13905
- * * **off**
14089
+ * * **on**: enables the overload protection feature.
14090
+ * * **off** (default): disables the overload protection feature.
13906
14091
  *
13907
14092
  * >
13908
14093
  *
13909
- * * You can specify the transaction splitting, primary node accepts read requests, connection pool, and overload protection features for a PolarDB for MySQL cluster only if ReadWriteMode is set to ReadWrite for the cluster endpoint.
14094
+ * * You can configure the transaction splitting, connection pool, and overload protection settings, and specify whether the primary node accepts read requests settings for the cluster endpoint of a PolarDB for MySQL cluster only if ReadWriteMode of the cluster endpoint is set to Read and Write (Automatic Read/Write Splitting).
14095
+ *
14096
+ * * If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read-only**, you can specify the **Connections-based Load Balancing** or **Active Request-based Load Balancing** policy for the cluster endpoint. If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read/Write (Automatic Read/Write Splitting)**, you can specify only the **Active Request-based Load Balancing** policy for the cluster endpoint.
14097
+ *
14098
+ * * You can enable automatic request distribution among column store and row store nodes for the cluster endpoint of a PolarDB for MySQL cluster if ReadWriteMode of the cluster endpoint is set to **Read and Write (Automatic Read/Write Splitting)**, or if the ReadWriteMode of the cluster endpoint is set to **Read-only** and the load balancing policy is set to **Active requests-based load balancing**.
13910
14099
  *
13911
- * * If the read /write mode of a PolarDB for MySQL cluster is set to **Read-only**, the **Connection-based SLB** and **Active Request-based SLB** SLB policies are supported. The **Read-write (Automatic read /write splitting) **mode of the cluster supports** Active Request-based SLB** policy.
13912
- * * If ReadWriteMode is set to **ReadWrite** for the cluster endpoint of a PolarDB for MySQL cluster or if ReadWriteMode is set to **ReadOnly** and the load balancing policy is set to **active requests-based load balancing**, the automatic request distribution between row store and column store nodes feature is supported.
13913
14100
  * * Only PolarDB for MySQL supports global consistency.
13914
- * * If the **ReadWriteMode** parameter is set to **ReadOnly**, the consistency level must be **0**.
13915
- * * You can specify the consistency level, transaction splitting, connection pool, and primary node accepts read requests features at a time, such as `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
13916
- * * The transaction splitting settings are restricted by the consistency level settings. For example, if you set the consistency level to **0**, transaction splitting cannot be enabled. If you set the consistency level to **1** or **2**, transaction splitting can be enabled.
14101
+ *
14102
+ * * You can set the consistency level of the cluster endpoint of a PolarDB for MySQL cluster only to **0** if **ReadWriteMode** of the cluster endpoint is set to **ReadOnly**.
14103
+ *
14104
+ * * You can configure the settings for the consistency level, transaction splitting, and connection pool features, and specify whether the primary node accepts read requests settings at a time. Example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
14105
+ *
14106
+ * * The configuration for transaction splitting is limited by the configuration for the consistency level. For example, if you set the consistency level to **0**, you cannot enable transaction splitting. If you set the consistency level to **1** or **2**, you can enable transaction splitting.
13917
14107
  *
13918
14108
  * @example
13919
14109
  * {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
@@ -13942,7 +14132,24 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13942
14132
  nodes?: string;
13943
14133
  ownerAccount?: string;
13944
14134
  ownerId?: number;
14135
+ /**
14136
+ * @remarks
14137
+ * Global consistency timeout policy. Valid values:
14138
+ *
14139
+ * * **0**: sends the request to the primary node.
14140
+ * * **2**: downgrades the consistency level of a query to inconsistent read when a global consistent read in the query times out. No error message is returned to the client.
14141
+ *
14142
+ * @example
14143
+ * 0
14144
+ */
13945
14145
  polarSccTimeoutAction?: string;
14146
+ /**
14147
+ * @remarks
14148
+ * Global consistency timeout.
14149
+ *
14150
+ * @example
14151
+ * 100
14152
+ */
13946
14153
  polarSccWaitTimeout?: string;
13947
14154
  /**
13948
14155
  * @remarks
@@ -13957,6 +14164,21 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13957
14164
  readWriteMode?: string;
13958
14165
  resourceOwnerAccount?: string;
13959
14166
  resourceOwnerId?: number;
14167
+ /**
14168
+ * @remarks
14169
+ * Specifies whether to enable the global consistency (high-performance mode) feature for the nodes. Valid values:
14170
+ *
14171
+ * * **ON**
14172
+ * * **OFF**
14173
+ *
14174
+ * Valid values:
14175
+ *
14176
+ * * on
14177
+ * * off
14178
+ *
14179
+ * @example
14180
+ * on
14181
+ */
13960
14182
  sccMode?: string;
13961
14183
  static names(): {
13962
14184
  [key: string]: string;
@@ -17988,8 +18210,11 @@ export declare class UpgradeDBClusterVersionRequest extends $tea.Model {
17988
18210
  * @remarks
17989
18211
  * The earliest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
17990
18212
  *
17991
- * > * The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time between `2021-01-14T09:00:00Z` and `2021-01-15T09:00:00Z`.
17992
- * >* If you do not specify this parameter, the kernel update task runs immediately after you submit the request.
18213
+ * >
18214
+ *
18215
+ * * The earliest start time of the task can be a point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`.
18216
+ *
18217
+ * * If you do not specify this parameter, the kernel update task runs immediately after you submit the request.
17993
18218
  *
17994
18219
  * @example
17995
18220
  * 2021-01-14T09:00:00Z
@@ -18407,46 +18632,73 @@ export declare class DescribeAccountsResponseBodyAccounts extends $tea.Model {
18407
18632
  }
18408
18633
  export declare class DescribeActivationCodesResponseBodyItems extends $tea.Model {
18409
18634
  /**
18635
+ * @remarks
18636
+ * The time when the activation code takes effect.
18637
+ *
18410
18638
  * @example
18411
18639
  * 2024-10-16 16:46:20
18412
18640
  */
18413
18641
  activateAt?: string;
18414
18642
  /**
18643
+ * @remarks
18644
+ * The description of the activation code.
18645
+ *
18415
18646
  * @example
18416
18647
  * testCode
18417
18648
  */
18418
18649
  description?: string;
18419
18650
  /**
18651
+ * @remarks
18652
+ * The time when the activation code expires.
18653
+ *
18420
18654
  * @example
18421
18655
  * 2054-10-16 16:46:20
18422
18656
  */
18423
18657
  expireAt?: string;
18424
18658
  /**
18659
+ * @remarks
18660
+ * The time when the activation code was generated.
18661
+ *
18425
18662
  * @example
18426
18663
  * 2024-10-16 16:46:20
18427
18664
  */
18428
18665
  gmtCreated?: string;
18429
18666
  /**
18667
+ * @remarks
18668
+ * The time when the activation code was updated.
18669
+ *
18430
18670
  * @example
18431
18671
  * 2024-10-16 16:46:20
18432
18672
  */
18433
18673
  gmtModified?: string;
18434
18674
  /**
18675
+ * @remarks
18676
+ * The activation code ID.
18677
+ *
18435
18678
  * @example
18436
18679
  * 123
18437
18680
  */
18438
18681
  id?: number;
18439
18682
  /**
18683
+ * @remarks
18684
+ * The media access control (MAC) address used in the generation of the activation code.
18685
+ *
18440
18686
  * @example
18441
18687
  * 12:34:56:78:98:00
18442
18688
  */
18443
18689
  macAddress?: string;
18444
18690
  /**
18691
+ * @remarks
18692
+ * The name of the activation code.
18693
+ *
18445
18694
  * @example
18446
18695
  * testName
18447
18696
  */
18448
18697
  name?: string;
18449
18698
  /**
18699
+ * @remarks
18700
+ * The unique identifier of the database.
18701
+ *
18450
18702
  * @example
18451
18703
  * 1234567890123456
18452
18704
  */
@@ -18939,6 +19191,7 @@ export declare class DescribeClassListResponseBodyItems extends $tea.Model {
18939
19191
  * 8
18940
19192
  */
18941
19193
  cpu?: string;
19194
+ essdMaxStorageCapacity?: string;
18942
19195
  /**
18943
19196
  * @remarks
18944
19197
  * The maximum number of concurrent connections in the cluster.
@@ -18995,6 +19248,7 @@ export declare class DescribeClassListResponseBodyItems extends $tea.Model {
18995
19248
  * 1000000
18996
19249
  */
18997
19250
  pl3MaxIOPS?: string;
19251
+ polarStoreMaxStorageCapacity?: string;
18998
19252
  /**
18999
19253
  * @remarks
19000
19254
  * The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.
@@ -19181,6 +19435,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
19181
19435
  * polar.mysql.x4.large
19182
19436
  */
19183
19437
  DBNodeClass?: string;
19438
+ DBNodeDescription?: string;
19184
19439
  /**
19185
19440
  * @remarks
19186
19441
  * Node ID.
@@ -19700,7 +19955,10 @@ export declare class DescribeDBClusterEndpointsResponseBodyItems extends $tea.Mo
19700
19955
  export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems extends $tea.Model {
19701
19956
  /**
19702
19957
  * @remarks
19703
- * The endpoint.
19958
+ * Indicates whether SSL encryption is enabled. Valid values:
19959
+ *
19960
+ * * **Enabled**
19961
+ * * **Disabled**
19704
19962
  *
19705
19963
  * @example
19706
19964
  * pc-**************.rwlb.rds.aliyuncs.com
@@ -19708,7 +19966,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19708
19966
  connectionString?: string;
19709
19967
  /**
19710
19968
  * @remarks
19711
- * The IP address of the endpoint.
19969
+ * The description of a migration exception. If no exception occurs during the migration, an empty string is returned.
19712
19970
  *
19713
19971
  * @example
19714
19972
  * 192.***.***.10
@@ -19716,11 +19974,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19716
19974
  IPAddress?: string;
19717
19975
  /**
19718
19976
  * @remarks
19719
- * The network type of the endpoint. Valid values:
19720
- *
19721
- * * **Public**: the public endpoint
19722
- * * **Private**: the internal endpoint (VPC)
19723
- * * **Inner**: the internal endpoint (classic network)
19977
+ * The ID of the endpoint.
19724
19978
  *
19725
19979
  * @example
19726
19980
  * Private
@@ -19728,7 +19982,11 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19728
19982
  netType?: string;
19729
19983
  /**
19730
19984
  * @remarks
19731
- * The port number.
19985
+ * The type of the endpoint. Valid values:
19986
+ *
19987
+ * * **Cluster**: the default cluster endpoint
19988
+ * * **Primary**: the primary endpoint
19989
+ * * **Custom**: the custom endpoint
19732
19990
  *
19733
19991
  * @example
19734
19992
  * 3306
@@ -19736,10 +19994,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19736
19994
  port?: string;
19737
19995
  /**
19738
19996
  * @remarks
19739
- * Indicates whether SSL encryption is enabled. Valid values:
19740
- *
19741
- * * **Enabled**
19742
- * * **Disabled**
19997
+ * The ID of the request.
19743
19998
  *
19744
19999
  * @example
19745
20000
  * Enabled
@@ -19747,7 +20002,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19747
20002
  SSLEnabled?: string;
19748
20003
  /**
19749
20004
  * @remarks
19750
- * The VPC ID.
20005
+ * The read/write mode. Valid values:
20006
+ *
20007
+ * * ReadWrite: receives and forwards read and write requests (automatic read-write splitting).
20008
+ * * ReadOnly (default): receives and forwards read requests only.
19751
20009
  *
19752
20010
  * @example
19753
20011
  * vpc-**********
@@ -19755,7 +20013,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19755
20013
  VPCId?: string;
19756
20014
  /**
19757
20015
  * @remarks
19758
- * The vSwitch ID.
20016
+ * The IP address of the endpoint.
19759
20017
  *
19760
20018
  * @example
19761
20019
  * vsw-**********
@@ -19774,12 +20032,12 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19774
20032
  export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends $tea.Model {
19775
20033
  /**
19776
20034
  * @remarks
19777
- * Details about the endpoints.
20035
+ * The VPC ID.
19778
20036
  */
19779
20037
  addressItems?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems[];
19780
20038
  /**
19781
20039
  * @remarks
19782
- * The ID of the endpoint.
20040
+ * The expiration time of the replication between ApsaraDB RDS and PolarDB. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.
19783
20041
  *
19784
20042
  * @example
19785
20043
  * pe-***********
@@ -19787,11 +20045,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19787
20045
  DBEndpointId?: string;
19788
20046
  /**
19789
20047
  * @remarks
19790
- * The type of the endpoint. Valid values:
19791
- *
19792
- * * **Cluster**: the default cluster endpoint
19793
- * * **Primary**: the primary endpoint
19794
- * * **Custom**: the custom endpoint
20048
+ * The ID of the cluster.
19795
20049
  *
19796
20050
  * @example
19797
20051
  * Cluster
@@ -19799,10 +20053,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19799
20053
  endpointType?: string;
19800
20054
  /**
19801
20055
  * @remarks
19802
- * The read/write mode. Valid values:
20056
+ * The synchronization direction. Valid values:
19803
20057
  *
19804
- * * ReadWrite: receives and forwards read and write requests (automatic read-write splitting).
19805
- * * ReadOnly (default): receives and forwards read requests only.
20058
+ * * **RDS2POLARDB**: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster.
20059
+ * * **POLARDB2RDS**: Data is replicated from a PolarDB cluster to an ApsaraDB RDS instance.
19806
20060
  *
19807
20061
  * @example
19808
20062
  * ReadOnly
@@ -19821,7 +20075,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19821
20075
  export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems extends $tea.Model {
19822
20076
  /**
19823
20077
  * @remarks
19824
- * The endpoint.
20078
+ * Indicates whether SSL encryption is enabled. Valid values:
20079
+ *
20080
+ * * **Enabled**
20081
+ * * **Disabled**
19825
20082
  *
19826
20083
  * @example
19827
20084
  * rm-***********.mysql.rds.aliyuncs.com
@@ -19829,7 +20086,10 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19829
20086
  connectionString?: string;
19830
20087
  /**
19831
20088
  * @remarks
19832
- * The IP address of the endpoint.
20089
+ * The type of the source database. Valid values:
20090
+ *
20091
+ * * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
20092
+ * * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
19833
20093
  *
19834
20094
  * @example
19835
20095
  * 172.***.***.173
@@ -19837,11 +20097,7 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19837
20097
  IPAddress?: string;
19838
20098
  /**
19839
20099
  * @remarks
19840
- * The network type of the endpoint. Valid values:
19841
- *
19842
- * * **Public**: the public endpoint
19843
- * * **Private**: the internal endpoint (VPC)
19844
- * * **Inner**: the internal endpoint (classic network)
20100
+ * The ID of the endpoint.
19845
20101
  *
19846
20102
  * @example
19847
20103
  * Private
@@ -19849,26 +20105,23 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19849
20105
  netType?: string;
19850
20106
  /**
19851
20107
  * @remarks
19852
- * The port number.
20108
+ * The type of the endpoint. Valid values:
20109
+ *
20110
+ * * **Normal**: the standard endpoint
20111
+ * * **ReadWriteSplitting**: the read/write splitting endpoint
19853
20112
  *
19854
20113
  * @example
19855
20114
  * 3306
19856
20115
  */
19857
20116
  port?: string;
19858
20117
  /**
19859
- * @remarks
19860
- * Indicates whether SSL encryption is enabled. Valid values:
19861
- *
19862
- * * **Enabled**
19863
- * * **Disabled**
19864
- *
19865
20118
  * @example
19866
20119
  * Enabled
19867
20120
  */
19868
20121
  SSLEnabled?: string;
19869
20122
  /**
19870
20123
  * @remarks
19871
- * The VPC ID.
20124
+ * The instance type.
19872
20125
  *
19873
20126
  * @example
19874
20127
  * vpc-************
@@ -19876,7 +20129,7 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19876
20129
  VPCId?: string;
19877
20130
  /**
19878
20131
  * @remarks
19879
- * The vSwitch ID.
20132
+ * The IP address of the endpoint.
19880
20133
  *
19881
20134
  * @example
19882
20135
  * vsw-**************
@@ -19895,13 +20148,10 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19895
20148
  export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.Model {
19896
20149
  /**
19897
20150
  * @remarks
19898
- * Details about the endpoints.
20151
+ * The VPC ID.
19899
20152
  */
19900
20153
  addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
19901
20154
  /**
19902
- * @remarks
19903
- * The role of the source database instance.
19904
- *
19905
20155
  * @example
19906
20156
  * ReadOnly
19907
20157
  * Maxscale
@@ -19909,20 +20159,11 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
19909
20159
  */
19910
20160
  custinsType?: string;
19911
20161
  /**
19912
- * @remarks
19913
- * The ID of the endpoint.
19914
- *
19915
20162
  * @example
19916
20163
  * rm-************-normal
19917
20164
  */
19918
20165
  DBEndpointId?: string;
19919
20166
  /**
19920
- * @remarks
19921
- * The type of the endpoint. Valid values:
19922
- *
19923
- * * **Normal**: the standard endpoint
19924
- * * **ReadWriteSplitting**: the read/write splitting endpoint
19925
- *
19926
20167
  * @example
19927
20168
  * Normal
19928
20169
  */
@@ -22415,66 +22656,111 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecu
22415
22656
  }
22416
22657
  export declare class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
22417
22658
  /**
22659
+ * @remarks
22660
+ * The number of generated activation codes.
22661
+ *
22418
22662
  * @example
22419
22663
  * 10
22420
22664
  */
22421
22665
  activatedCodeCount?: number;
22422
22666
  /**
22667
+ * @remarks
22668
+ * The maximum number of activation codes that you can apply for.
22669
+ *
22423
22670
  * @example
22424
22671
  * 10
22425
22672
  */
22426
22673
  activationCodeQuota?: number;
22427
22674
  /**
22675
+ * @remarks
22676
+ * The ID of the Alibaba Cloud order. The ID of a virtual order may be returned.
22677
+ *
22428
22678
  * @example
22429
22679
  * 227638319690519
22430
22680
  */
22431
22681
  aliyunOrderId?: string;
22432
22682
  /**
22683
+ * @remarks
22684
+ * Indicates whether the SystemIdentifier parameter can be left empty when the system generates an activation code.
22685
+ *
22433
22686
  * @example
22434
22687
  * false
22435
22688
  */
22436
22689
  allowEmptySystemIdentifier?: boolean;
22437
22690
  /**
22691
+ * @remarks
22692
+ * The engine of the PolarDB cluster. Valid values: PG, Oracle, and MySQL.
22693
+ *
22438
22694
  * @example
22439
22695
  * PG
22440
22696
  */
22441
22697
  engine?: string;
22442
22698
  /**
22699
+ * @remarks
22700
+ * The time when the order was created.
22701
+ *
22443
22702
  * @example
22444
22703
  * 2022-02-11 03:14:15
22445
22704
  */
22446
22705
  gmtCreated?: string;
22447
22706
  /**
22707
+ * @remarks
22708
+ * The time when the order was updated.
22709
+ *
22448
22710
  * @example
22449
22711
  * 2022-02-11 03:14:15
22450
22712
  */
22451
22713
  gmtModified?: string;
22452
22714
  /**
22715
+ * @remarks
22716
+ * Indicates whether the order is a virtual order. Pre-generation of activation codes is allowed for virtual orders.
22717
+ *
22453
22718
  * @example
22454
22719
  * false
22455
22720
  */
22456
22721
  isVirtualOrder?: boolean;
22457
22722
  /**
22723
+ * @remarks
22724
+ * Indicates whether the virtual order is frozen. Generation of activation codes is not allowed for frozen virtual orders.
22725
+ *
22458
22726
  * @example
22459
22727
  * false
22460
22728
  */
22461
22729
  isVirtualOrderFrozen?: boolean;
22462
22730
  /**
22731
+ * @remarks
22732
+ * The type of the package. Valid values:
22733
+ *
22734
+ * * single_node_subscribe: Single-node Edition (Subscription).
22735
+ * * single_node_long_term: Single-node Edition (Long-term).
22736
+ * * primary_backup_subscribe: HA Edition (Subscription).
22737
+ * * primary_backup_long_term: HA Edition (Long-term).
22738
+ * * pre_generation_long_term: Pre-generated (Long-term).
22739
+ *
22463
22740
  * @example
22464
22741
  * single_node_subscribe
22465
22742
  */
22466
22743
  packageType?: string;
22467
22744
  /**
22745
+ * @remarks
22746
+ * The validity period of the package. Valid values: 1 year and 30 years.
22747
+ *
22468
22748
  * @example
22469
22749
  * 1 year
22470
22750
  */
22471
22751
  packageValidity?: string;
22472
22752
  /**
22753
+ * @remarks
22754
+ * The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market indicates Alibaba Cloud Marketplace. aliyun_public indicates the PolarDB buy page.
22755
+ *
22473
22756
  * @example
22474
22757
  * aliyun_public
22475
22758
  */
22476
22759
  purchaseChannel?: string;
22477
22760
  /**
22761
+ * @remarks
22762
+ * The ID of the virtual order.
22763
+ *
22478
22764
  * @example
22479
22765
  * 227638319690519
22480
22766
  */
@@ -24202,7 +24488,7 @@ export default class Client extends OpenApi {
24202
24488
  */
24203
24489
  createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
24204
24490
  /**
24205
- * 生成轻量化版本激活码
24491
+ * Generates a lightweight license activation code.
24206
24492
  *
24207
24493
  * @param request - CreateActivationCodeRequest
24208
24494
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24210,7 +24496,7 @@ export default class Client extends OpenApi {
24210
24496
  */
24211
24497
  createActivationCodeWithOptions(request: CreateActivationCodeRequest, runtime: $Util.RuntimeOptions): Promise<CreateActivationCodeResponse>;
24212
24498
  /**
24213
- * 生成轻量化版本激活码
24499
+ * Generates a lightweight license activation code.
24214
24500
  *
24215
24501
  * @param request - CreateActivationCodeRequest
24216
24502
  * @returns CreateActivationCodeResponse
@@ -24413,7 +24699,7 @@ export default class Client extends OpenApi {
24413
24699
  */
24414
24700
  createGlobalSecurityIPGroup(request: CreateGlobalSecurityIPGroupRequest): Promise<CreateGlobalSecurityIPGroupResponse>;
24415
24701
  /**
24416
- * 创建或获取虚拟证书订单
24702
+ * Creates or obtains a virtual license order.
24417
24703
  *
24418
24704
  * @param request - CreateOrGetVirtualLicenseOrderRequest
24419
24705
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24421,7 +24707,7 @@ export default class Client extends OpenApi {
24421
24707
  */
24422
24708
  createOrGetVirtualLicenseOrderWithOptions(request: CreateOrGetVirtualLicenseOrderRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrGetVirtualLicenseOrderResponse>;
24423
24709
  /**
24424
- * 创建或获取虚拟证书订单
24710
+ * Creates or obtains a virtual license order.
24425
24711
  *
24426
24712
  * @param request - CreateOrGetVirtualLicenseOrderRequest
24427
24713
  * @returns CreateOrGetVirtualLicenseOrderResponse
@@ -24756,7 +25042,7 @@ export default class Client extends OpenApi {
24756
25042
  */
24757
25043
  describeActivationCodeDetails(request: DescribeActivationCodeDetailsRequest): Promise<DescribeActivationCodeDetailsResponse>;
24758
25044
  /**
24759
- * 查询激活码列表
25045
+ * Queries a list of activation codes.
24760
25046
  *
24761
25047
  * @param request - DescribeActivationCodesRequest
24762
25048
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24764,7 +25050,7 @@ export default class Client extends OpenApi {
24764
25050
  */
24765
25051
  describeActivationCodesWithOptions(request: DescribeActivationCodesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodesResponse>;
24766
25052
  /**
24767
- * 查询激活码列表
25053
+ * Queries a list of activation codes.
24768
25054
  *
24769
25055
  * @param request - DescribeActivationCodesRequest
24770
25056
  * @returns DescribeActivationCodesResponse
@@ -24966,11 +25252,10 @@ export default class Client extends OpenApi {
24966
25252
  */
24967
25253
  describeDBClusterEndpoints(request: DescribeDBClusterEndpointsRequest): Promise<DescribeDBClusterEndpointsResponse>;
24968
25254
  /**
24969
- * Queries the migration status of PolarDB clusters.
25255
+ * The ID of the synchronous task.
24970
25256
  *
24971
25257
  * @remarks
24972
- * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](https://help.aliyun.com/document_detail/121582.html).
24973
- * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
25258
+ * The ID of the request.
24974
25259
  *
24975
25260
  * @param request - DescribeDBClusterMigrationRequest
24976
25261
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24978,11 +25263,10 @@ export default class Client extends OpenApi {
24978
25263
  */
24979
25264
  describeDBClusterMigrationWithOptions(request: DescribeDBClusterMigrationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterMigrationResponse>;
24980
25265
  /**
24981
- * Queries the migration status of PolarDB clusters.
25266
+ * The ID of the synchronous task.
24982
25267
  *
24983
25268
  * @remarks
24984
- * You can call this operation to query the status of data migration from an ApsaraDB RDS instance to a PolarDB cluster. For more information, see [Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click](https://help.aliyun.com/document_detail/121582.html).
24985
- * * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
25269
+ * The ID of the request.
24986
25270
  *
24987
25271
  * @param request - DescribeDBClusterMigrationRequest
24988
25272
  * @returns DescribeDBClusterMigrationResponse
@@ -25395,7 +25679,7 @@ export default class Client extends OpenApi {
25395
25679
  */
25396
25680
  describeLicenseOrderDetails(request: DescribeLicenseOrderDetailsRequest): Promise<DescribeLicenseOrderDetailsResponse>;
25397
25681
  /**
25398
- * 查询License订单列表
25682
+ * Queries a list of license orders.
25399
25683
  *
25400
25684
  * @param request - DescribeLicenseOrdersRequest
25401
25685
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25403,7 +25687,7 @@ export default class Client extends OpenApi {
25403
25687
  */
25404
25688
  describeLicenseOrdersWithOptions(request: DescribeLicenseOrdersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrdersResponse>;
25405
25689
  /**
25406
- * 查询License订单列表
25690
+ * Queries a list of license orders.
25407
25691
  *
25408
25692
  * @param request - DescribeLicenseOrdersRequest
25409
25693
  * @returns DescribeLicenseOrdersResponse
@@ -26573,7 +26857,7 @@ export default class Client extends OpenApi {
26573
26857
  */
26574
26858
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
26575
26859
  /**
26576
- * Temporarily changes the node configurations of a cluster.
26860
+ * Temporarily changes the node configurations.
26577
26861
  *
26578
26862
  * @param request - TempModifyDBNodeRequest
26579
26863
  * @param runtime - runtime options for this request RuntimeOptions
@@ -26581,7 +26865,7 @@ export default class Client extends OpenApi {
26581
26865
  */
26582
26866
  tempModifyDBNodeWithOptions(request: TempModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<TempModifyDBNodeResponse>;
26583
26867
  /**
26584
- * Temporarily changes the node configurations of a cluster.
26868
+ * Temporarily changes the node configurations.
26585
26869
  *
26586
26870
  * @param request - TempModifyDBNodeRequest
26587
26871
  * @returns TempModifyDBNodeResponse