@alicloud/polardb20170801 5.2.1 → 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,10 @@ 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
+ */
4138
4236
  accountName?: string;
4139
4237
  /**
4140
4238
  * @remarks
@@ -4154,10 +4252,10 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4154
4252
  requestId?: string;
4155
4253
  /**
4156
4254
  * @remarks
4157
- * The state of the PolarDB for AI feature. Valid values:
4255
+ * The status of the PolarDB for AI feature. Valid values:
4158
4256
  *
4159
- * * **1**: The feature is enabled.
4160
- * * **2**: The feature is disabled.
4257
+ * * **1**: enabled.
4258
+ * * **2**: disabled.
4161
4259
  *
4162
4260
  * @example
4163
4261
  * 1
@@ -4165,7 +4263,7 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4165
4263
  status?: string;
4166
4264
  /**
4167
4265
  * @remarks
4168
- * The state description of the PolarDB for AI feature.
4266
+ * The description of the status of the PolarDB for AI feature.
4169
4267
  *
4170
4268
  * @example
4171
4269
  * Closed State
@@ -4424,6 +4522,8 @@ export declare class DescribeActivationCodeDetailsResponse extends $tea.Model {
4424
4522
  export declare class DescribeActivationCodesRequest extends $tea.Model {
4425
4523
  /**
4426
4524
  * @remarks
4525
+ * The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
4526
+ *
4427
4527
  * This parameter is required.
4428
4528
  *
4429
4529
  * @example
@@ -4433,11 +4533,17 @@ export declare class DescribeActivationCodesRequest extends $tea.Model {
4433
4533
  ownerAccount?: string;
4434
4534
  ownerId?: number;
4435
4535
  /**
4536
+ * @remarks
4537
+ * The page number.
4538
+ *
4436
4539
  * @example
4437
4540
  * 1
4438
4541
  */
4439
4542
  pageNumber?: number;
4440
4543
  /**
4544
+ * @remarks
4545
+ * The number of entries per page.
4546
+ *
4441
4547
  * @example
4442
4548
  * 30
4443
4549
  */
@@ -4455,26 +4561,39 @@ export declare class DescribeActivationCodesRequest extends $tea.Model {
4455
4561
  });
4456
4562
  }
4457
4563
  export declare class DescribeActivationCodesResponseBody extends $tea.Model {
4564
+ /**
4565
+ * @remarks
4566
+ * The queried activation codes.
4567
+ */
4458
4568
  items?: DescribeActivationCodesResponseBodyItems[];
4459
4569
  /**
4570
+ * @remarks
4571
+ * The page number.
4572
+ *
4460
4573
  * @example
4461
4574
  * 1
4462
4575
  */
4463
4576
  pageNumber?: number;
4464
4577
  /**
4578
+ * @remarks
4579
+ * The number of entries returned on the current page.
4580
+ *
4465
4581
  * @example
4466
4582
  * 1
4467
4583
  */
4468
4584
  pageRecordCount?: number;
4469
4585
  /**
4470
4586
  * @remarks
4471
- * Id of the request
4587
+ * The request ID.
4472
4588
  *
4473
4589
  * @example
4474
4590
  * 65D7ACE6-4A61-4B6E-B357-8CB24A******
4475
4591
  */
4476
4592
  requestId?: string;
4477
4593
  /**
4594
+ * @remarks
4595
+ * The total number of entries returned.
4596
+ *
4478
4597
  * @example
4479
4598
  * 1
4480
4599
  */
@@ -4518,7 +4637,7 @@ export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
4518
4637
  ownerId?: number;
4519
4638
  /**
4520
4639
  * @remarks
4521
- * 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.
4522
4641
  *
4523
4642
  * @example
4524
4643
  * 1
@@ -4526,7 +4645,7 @@ export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
4526
4645
  pageNumber?: number;
4527
4646
  /**
4528
4647
  * @remarks
4529
- * 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.
4530
4649
  *
4531
4650
  * @example
4532
4651
  * 30
@@ -5221,6 +5340,7 @@ export declare class DescribeBackupsResponseBody extends $tea.Model {
5221
5340
  * 24A1990B-4F6E-482B-B8CB-75C612******
5222
5341
  */
5223
5342
  requestId?: string;
5343
+ totalLevel2BackupSize?: string;
5224
5344
  /**
5225
5345
  * @remarks
5226
5346
  * The total number of returned entries.
@@ -5618,6 +5738,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5618
5738
  * 5,242,880
5619
5739
  */
5620
5740
  blktagUsed?: number;
5741
+ burstingEnabled?: string;
5621
5742
  /**
5622
5743
  * @remarks
5623
5744
  * [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
@@ -6566,7 +6687,11 @@ export declare class DescribeDBClusterEndpointsResponse extends $tea.Model {
6566
6687
  export declare class DescribeDBClusterMigrationRequest extends $tea.Model {
6567
6688
  /**
6568
6689
  * @remarks
6569
- * 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)
6570
6695
  *
6571
6696
  * This parameter is required.
6572
6697
  *
@@ -6591,7 +6716,10 @@ export declare class DescribeDBClusterMigrationRequest extends $tea.Model {
6591
6716
  export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6592
6717
  /**
6593
6718
  * @remarks
6594
- * 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
6595
6723
  *
6596
6724
  * @example
6597
6725
  * test
@@ -6599,12 +6727,12 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6599
6727
  comment?: string;
6600
6728
  /**
6601
6729
  * @remarks
6602
- * The endpoints of the PolarDB cluster.
6730
+ * The port number.
6603
6731
  */
6604
6732
  DBClusterEndpointList?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointList[];
6605
6733
  /**
6606
6734
  * @remarks
6607
- * The ID of the cluster.
6735
+ * The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
6608
6736
  *
6609
6737
  * @example
6610
6738
  * pc-****************
@@ -6612,10 +6740,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6612
6740
  DBClusterId?: string;
6613
6741
  /**
6614
6742
  * @remarks
6615
- * The mode of the PolarDB cluster. Valid values:
6616
- *
6617
- * * **rw**: read and write mode
6618
- * * **ro**: read-only mode
6743
+ * Details about the endpoints.
6619
6744
  *
6620
6745
  * @example
6621
6746
  * ro
@@ -6623,7 +6748,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6623
6748
  DBClusterReadWriteMode?: string;
6624
6749
  /**
6625
6750
  * @remarks
6626
- * The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
6751
+ * The vSwitch ID.
6627
6752
  *
6628
6753
  * @example
6629
6754
  * 0
@@ -6631,7 +6756,11 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6631
6756
  delayedSeconds?: number;
6632
6757
  /**
6633
6758
  * @remarks
6634
- * 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)
6635
6764
  *
6636
6765
  * @example
6637
6766
  * dts**********618bs
@@ -6639,7 +6768,10 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6639
6768
  dtsInstanceId?: string;
6640
6769
  /**
6641
6770
  * @remarks
6642
- * 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
6643
6775
  *
6644
6776
  * @example
6645
6777
  * 2020-06-17T01:56:36Z
@@ -6647,15 +6779,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6647
6779
  expiredTime?: string;
6648
6780
  /**
6649
6781
  * @remarks
6650
- * The migration state of the PolarDB cluster. Valid values:
6651
- *
6652
- * * **NO_MIGRATION**: No migration task is running.
6653
- * * **RDS2POLARDB_CLONING**: Data is being replicated.
6654
- * * **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.
6655
- * * **SWITCHING**: Databases are being switched.
6656
- * * **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.
6657
- * * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
6658
- * * **CLOSING_MIGRATION**: The migration task is being terminated.
6782
+ * The endpoint.
6659
6783
  *
6660
6784
  * @example
6661
6785
  * RDS2POLARDB_SYNCING
@@ -6663,15 +6787,12 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6663
6787
  migrationStatus?: string;
6664
6788
  /**
6665
6789
  * @remarks
6666
- * The endpoints of the ApsaraDB RDS instance.
6790
+ * The port number.
6667
6791
  */
6668
6792
  rdsEndpointList?: DescribeDBClusterMigrationResponseBodyRdsEndpointList[];
6669
6793
  /**
6670
6794
  * @remarks
6671
- * The mode of the source ApsaraDB RDS instance. Valid values:
6672
- *
6673
- * * **rw**: read and write mode
6674
- * * **ro**: read-only mode
6795
+ * The ID of the synchronous task.
6675
6796
  *
6676
6797
  * @example
6677
6798
  * rw
@@ -6679,7 +6800,7 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6679
6800
  rdsReadWriteMode?: string;
6680
6801
  /**
6681
6802
  * @remarks
6682
- * The ID of the request.
6803
+ * The ID of the source ApsaraDB RDS instance.
6683
6804
  *
6684
6805
  * @example
6685
6806
  * F2A9EFA7-915F-4572-8299-85A307******
@@ -6687,29 +6808,28 @@ export declare class DescribeDBClusterMigrationResponseBody extends $tea.Model {
6687
6808
  requestId?: string;
6688
6809
  /**
6689
6810
  * @remarks
6690
- * The ID of the source ApsaraDB RDS instance.
6811
+ * The endpoints of the ApsaraDB RDS instance.
6691
6812
  *
6692
6813
  * @example
6693
6814
  * rm-************
6694
6815
  */
6695
6816
  sourceRDSDBInstanceId?: string;
6696
6817
  /**
6697
- * @remarks
6698
- * The type of the source database. Valid values:
6699
- *
6700
- * * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
6701
- * * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
6702
- *
6703
6818
  * @example
6704
6819
  * PolarDBMySQL
6705
6820
  */
6706
6821
  srcDbType?: string;
6707
6822
  /**
6708
6823
  * @remarks
6709
- * The synchronization direction. Valid values:
6824
+ * The migration state of the PolarDB cluster. Valid values:
6710
6825
  *
6711
- * * **RDS2POLARDB**: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster.
6712
- * * **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.
6713
6833
  *
6714
6834
  * @example
6715
6835
  * RDS2POLARDB
@@ -8507,9 +8627,7 @@ export declare class DescribeDBProxyPerformanceRequest extends $tea.Model {
8507
8627
  DBEndpointId?: string;
8508
8628
  /**
8509
8629
  * @remarks
8510
- * Database instance node ID.
8511
- *
8512
- * > 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.
8513
8631
  *
8514
8632
  * @example
8515
8633
  * pi-******************
@@ -9620,6 +9738,9 @@ export declare class DescribeLicenseOrderDetailsResponse extends $tea.Model {
9620
9738
  }
9621
9739
  export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9622
9740
  /**
9741
+ * @remarks
9742
+ * The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
9743
+ *
9623
9744
  * @example
9624
9745
  * 239618016570503
9625
9746
  */
@@ -9627,27 +9748,49 @@ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9627
9748
  ownerAccount?: string;
9628
9749
  ownerId?: number;
9629
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
+ *
9630
9760
  * @example
9631
9761
  * single_node_subscribe
9632
9762
  */
9633
9763
  packageType?: string;
9634
9764
  /**
9765
+ * @remarks
9766
+ * The page number.
9767
+ *
9635
9768
  * @example
9636
9769
  * 1
9637
9770
  */
9638
9771
  pageNumber?: number;
9639
9772
  /**
9773
+ * @remarks
9774
+ * The number of entries per page.
9775
+ *
9640
9776
  * @example
9641
9777
  * 30
9642
9778
  */
9643
9779
  pageSize?: number;
9644
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
+ *
9645
9784
  * @example
9646
9785
  * aliyun_market
9647
9786
  */
9648
9787
  purchaseChannel?: string;
9649
9788
  resourceOwnerAccount?: string;
9650
9789
  resourceOwnerId?: number;
9790
+ /**
9791
+ * @remarks
9792
+ * Specifies whether to query only virtual orders.
9793
+ */
9651
9794
  virtualOrder?: boolean;
9652
9795
  static names(): {
9653
9796
  [key: string]: string;
@@ -9660,23 +9803,39 @@ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
9660
9803
  });
9661
9804
  }
9662
9805
  export declare class DescribeLicenseOrdersResponseBody extends $tea.Model {
9806
+ /**
9807
+ * @remarks
9808
+ * The queried orders.
9809
+ */
9663
9810
  items?: DescribeLicenseOrdersResponseBodyItems[];
9664
9811
  /**
9812
+ * @remarks
9813
+ * The page number.
9814
+ *
9665
9815
  * @example
9666
9816
  * 1
9667
9817
  */
9668
9818
  pageNumber?: number;
9669
9819
  /**
9820
+ * @remarks
9821
+ * The number of entries returned on the current page.
9822
+ *
9670
9823
  * @example
9671
9824
  * 12
9672
9825
  */
9673
9826
  pageRecordCount?: number;
9674
9827
  /**
9828
+ * @remarks
9829
+ * The request ID.
9830
+ *
9675
9831
  * @example
9676
9832
  * 34458CD3-33E0-4624-BFEF-840C15******
9677
9833
  */
9678
9834
  requestId?: string;
9679
9835
  /**
9836
+ * @remarks
9837
+ * The total number of entries returned.
9838
+ *
9680
9839
  * @example
9681
9840
  * 50
9682
9841
  */
@@ -12045,9 +12204,9 @@ export declare class EvaluateRegionResourceRequest extends $tea.Model {
12045
12204
  * @remarks
12046
12205
  * The cluster link type. The backend randomly selects the default value. Valid values:
12047
12206
  *
12048
- * * **lvs** :Linux virtual server
12049
- * * **proxy**: proxy server
12050
- * * **dns**: domain name system
12207
+ * * **lvs**: Linux virtual server.
12208
+ * * **proxy**: proxy server.
12209
+ * * **dns**: domain name system.
12051
12210
  *
12052
12211
  * @example
12053
12212
  * lvs
@@ -12117,9 +12276,9 @@ export declare class EvaluateRegionResourceRequest extends $tea.Model {
12117
12276
  dispenseMode?: string;
12118
12277
  /**
12119
12278
  * @remarks
12120
- * Specifies whether Maxscale is created. Default value: true. Valid values:
12279
+ * Specifies whether to create Maxscale. Valid values:
12121
12280
  *
12122
- * * **true**
12281
+ * * **true** (default)
12123
12282
  * * **false**
12124
12283
  *
12125
12284
  * This parameter is required.
@@ -13237,6 +13396,22 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
13237
13396
  * 0
13238
13397
  */
13239
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
+ */
13240
13415
  imciAutoIndex?: string;
13241
13416
  ownerAccount?: string;
13242
13417
  ownerId?: number;
@@ -13822,10 +13997,10 @@ export declare class ModifyDBClusterDescriptionResponse extends $tea.Model {
13822
13997
  export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13823
13998
  /**
13824
13999
  * @remarks
13825
- * 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:
13826
14001
  *
13827
- * * **Enable**
13828
- * * **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.
13829
14004
  *
13830
14005
  * @example
13831
14006
  * Enable
@@ -13861,60 +14036,74 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13861
14036
  DBEndpointId?: string;
13862
14037
  /**
13863
14038
  * @remarks
13864
- * 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.
13865
14040
  *
13866
- * * 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:
13867
14042
  *
13868
- * * **0**: connections-based load balancing
14043
+ * * **0** (default): connections-based load balancing
13869
14044
  * * **1**: active requests-based load balancing
13870
14045
  *
13871
- * * 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:
13872
14047
  *
13873
- * * **on**
13874
- * * **off**
14048
+ * * **on** (default): allows the primary node to accept read requests.
14049
+ * * **off**: does not allow the primary node to accept read requests.
13875
14050
  *
13876
- * * 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:
13877
14052
  *
13878
- * * **on**
13879
- * * **off**
14053
+ * * **on** (default): enables the transaction splitting feature.
14054
+ * * **off**: disables the transaction splitting feature.
13880
14055
  *
13881
- * * 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:
13882
14057
  *
13883
14058
  * * **0**: eventual consistency (weak)
13884
- * * **1**: session consistency (medium)
14059
+ * * **1** (default): session consistency (medium)
13885
14060
  * * **2**: global consistency (strong)
13886
14061
  *
13887
- * * 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.
13888
14063
  *
13889
- * * **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.
13890
14074
  * * **Session**: enables the session-level connection pool.
13891
14075
  * * **Transaction**: enables the transaction-level connection pool.
13892
14076
  *
13893
- * * 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:
13894
14078
  *
13895
- * * **on**
13896
- * * **off**
14079
+ * * **on**: enables the parallel query feature.
14080
+ * * **off** (default): disables the parallel query feature.
13897
14081
  *
13898
- * * 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:
13899
14083
  *
13900
- * * **on**
13901
- * * **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.
13902
14086
  *
13903
- * * 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:
13904
14088
  *
13905
- * * **on**
13906
- * * **off**
14089
+ * * **on**: enables the overload protection feature.
14090
+ * * **off** (default): disables the overload protection feature.
13907
14091
  *
13908
14092
  * >
13909
14093
  *
13910
- * * 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**.
13911
14099
  *
13912
- * * 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.
13913
- * * 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.
13914
14100
  * * Only PolarDB for MySQL supports global consistency.
13915
- * * If the **ReadWriteMode** parameter is set to **ReadOnly**, the consistency level must be **0**.
13916
- * * 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\\"}`.
13917
- * * 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.
13918
14107
  *
13919
14108
  * @example
13920
14109
  * {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
@@ -13943,7 +14132,24 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13943
14132
  nodes?: string;
13944
14133
  ownerAccount?: string;
13945
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
+ */
13946
14145
  polarSccTimeoutAction?: string;
14146
+ /**
14147
+ * @remarks
14148
+ * Global consistency timeout.
14149
+ *
14150
+ * @example
14151
+ * 100
14152
+ */
13947
14153
  polarSccWaitTimeout?: string;
13948
14154
  /**
13949
14155
  * @remarks
@@ -13958,6 +14164,21 @@ export declare class ModifyDBClusterEndpointRequest extends $tea.Model {
13958
14164
  readWriteMode?: string;
13959
14165
  resourceOwnerAccount?: string;
13960
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
+ */
13961
14182
  sccMode?: string;
13962
14183
  static names(): {
13963
14184
  [key: string]: string;
@@ -17989,8 +18210,11 @@ export declare class UpgradeDBClusterVersionRequest extends $tea.Model {
17989
18210
  * @remarks
17990
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.
17991
18212
  *
17992
- * > * 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`.
17993
- * >* 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.
17994
18218
  *
17995
18219
  * @example
17996
18220
  * 2021-01-14T09:00:00Z
@@ -18408,46 +18632,73 @@ export declare class DescribeAccountsResponseBodyAccounts extends $tea.Model {
18408
18632
  }
18409
18633
  export declare class DescribeActivationCodesResponseBodyItems extends $tea.Model {
18410
18634
  /**
18635
+ * @remarks
18636
+ * The time when the activation code takes effect.
18637
+ *
18411
18638
  * @example
18412
18639
  * 2024-10-16 16:46:20
18413
18640
  */
18414
18641
  activateAt?: string;
18415
18642
  /**
18643
+ * @remarks
18644
+ * The description of the activation code.
18645
+ *
18416
18646
  * @example
18417
18647
  * testCode
18418
18648
  */
18419
18649
  description?: string;
18420
18650
  /**
18651
+ * @remarks
18652
+ * The time when the activation code expires.
18653
+ *
18421
18654
  * @example
18422
18655
  * 2054-10-16 16:46:20
18423
18656
  */
18424
18657
  expireAt?: string;
18425
18658
  /**
18659
+ * @remarks
18660
+ * The time when the activation code was generated.
18661
+ *
18426
18662
  * @example
18427
18663
  * 2024-10-16 16:46:20
18428
18664
  */
18429
18665
  gmtCreated?: string;
18430
18666
  /**
18667
+ * @remarks
18668
+ * The time when the activation code was updated.
18669
+ *
18431
18670
  * @example
18432
18671
  * 2024-10-16 16:46:20
18433
18672
  */
18434
18673
  gmtModified?: string;
18435
18674
  /**
18675
+ * @remarks
18676
+ * The activation code ID.
18677
+ *
18436
18678
  * @example
18437
18679
  * 123
18438
18680
  */
18439
18681
  id?: number;
18440
18682
  /**
18683
+ * @remarks
18684
+ * The media access control (MAC) address used in the generation of the activation code.
18685
+ *
18441
18686
  * @example
18442
18687
  * 12:34:56:78:98:00
18443
18688
  */
18444
18689
  macAddress?: string;
18445
18690
  /**
18691
+ * @remarks
18692
+ * The name of the activation code.
18693
+ *
18446
18694
  * @example
18447
18695
  * testName
18448
18696
  */
18449
18697
  name?: string;
18450
18698
  /**
18699
+ * @remarks
18700
+ * The unique identifier of the database.
18701
+ *
18451
18702
  * @example
18452
18703
  * 1234567890123456
18453
18704
  */
@@ -18940,6 +19191,7 @@ export declare class DescribeClassListResponseBodyItems extends $tea.Model {
18940
19191
  * 8
18941
19192
  */
18942
19193
  cpu?: string;
19194
+ essdMaxStorageCapacity?: string;
18943
19195
  /**
18944
19196
  * @remarks
18945
19197
  * The maximum number of concurrent connections in the cluster.
@@ -18996,6 +19248,7 @@ export declare class DescribeClassListResponseBodyItems extends $tea.Model {
18996
19248
  * 1000000
18997
19249
  */
18998
19250
  pl3MaxIOPS?: string;
19251
+ polarStoreMaxStorageCapacity?: string;
18999
19252
  /**
19000
19253
  * @remarks
19001
19254
  * The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.
@@ -19182,6 +19435,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
19182
19435
  * polar.mysql.x4.large
19183
19436
  */
19184
19437
  DBNodeClass?: string;
19438
+ DBNodeDescription?: string;
19185
19439
  /**
19186
19440
  * @remarks
19187
19441
  * Node ID.
@@ -19701,7 +19955,10 @@ export declare class DescribeDBClusterEndpointsResponseBodyItems extends $tea.Mo
19701
19955
  export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems extends $tea.Model {
19702
19956
  /**
19703
19957
  * @remarks
19704
- * The endpoint.
19958
+ * Indicates whether SSL encryption is enabled. Valid values:
19959
+ *
19960
+ * * **Enabled**
19961
+ * * **Disabled**
19705
19962
  *
19706
19963
  * @example
19707
19964
  * pc-**************.rwlb.rds.aliyuncs.com
@@ -19709,7 +19966,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19709
19966
  connectionString?: string;
19710
19967
  /**
19711
19968
  * @remarks
19712
- * 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.
19713
19970
  *
19714
19971
  * @example
19715
19972
  * 192.***.***.10
@@ -19717,11 +19974,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19717
19974
  IPAddress?: string;
19718
19975
  /**
19719
19976
  * @remarks
19720
- * The network type of the endpoint. Valid values:
19721
- *
19722
- * * **Public**: the public endpoint
19723
- * * **Private**: the internal endpoint (VPC)
19724
- * * **Inner**: the internal endpoint (classic network)
19977
+ * The ID of the endpoint.
19725
19978
  *
19726
19979
  * @example
19727
19980
  * Private
@@ -19729,7 +19982,11 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19729
19982
  netType?: string;
19730
19983
  /**
19731
19984
  * @remarks
19732
- * 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
19733
19990
  *
19734
19991
  * @example
19735
19992
  * 3306
@@ -19737,10 +19994,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19737
19994
  port?: string;
19738
19995
  /**
19739
19996
  * @remarks
19740
- * Indicates whether SSL encryption is enabled. Valid values:
19741
- *
19742
- * * **Enabled**
19743
- * * **Disabled**
19997
+ * The ID of the request.
19744
19998
  *
19745
19999
  * @example
19746
20000
  * Enabled
@@ -19748,7 +20002,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19748
20002
  SSLEnabled?: string;
19749
20003
  /**
19750
20004
  * @remarks
19751
- * 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.
19752
20009
  *
19753
20010
  * @example
19754
20011
  * vpc-**********
@@ -19756,7 +20013,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19756
20013
  VPCId?: string;
19757
20014
  /**
19758
20015
  * @remarks
19759
- * The vSwitch ID.
20016
+ * The IP address of the endpoint.
19760
20017
  *
19761
20018
  * @example
19762
20019
  * vsw-**********
@@ -19775,12 +20032,12 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19775
20032
  export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends $tea.Model {
19776
20033
  /**
19777
20034
  * @remarks
19778
- * Details about the endpoints.
20035
+ * The VPC ID.
19779
20036
  */
19780
20037
  addressItems?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems[];
19781
20038
  /**
19782
20039
  * @remarks
19783
- * 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.
19784
20041
  *
19785
20042
  * @example
19786
20043
  * pe-***********
@@ -19788,11 +20045,7 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19788
20045
  DBEndpointId?: string;
19789
20046
  /**
19790
20047
  * @remarks
19791
- * The type of the endpoint. Valid values:
19792
- *
19793
- * * **Cluster**: the default cluster endpoint
19794
- * * **Primary**: the primary endpoint
19795
- * * **Custom**: the custom endpoint
20048
+ * The ID of the cluster.
19796
20049
  *
19797
20050
  * @example
19798
20051
  * Cluster
@@ -19800,10 +20053,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19800
20053
  endpointType?: string;
19801
20054
  /**
19802
20055
  * @remarks
19803
- * The read/write mode. Valid values:
20056
+ * The synchronization direction. Valid values:
19804
20057
  *
19805
- * * ReadWrite: receives and forwards read and write requests (automatic read-write splitting).
19806
- * * 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.
19807
20060
  *
19808
20061
  * @example
19809
20062
  * ReadOnly
@@ -19822,7 +20075,10 @@ export declare class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList
19822
20075
  export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems extends $tea.Model {
19823
20076
  /**
19824
20077
  * @remarks
19825
- * The endpoint.
20078
+ * Indicates whether SSL encryption is enabled. Valid values:
20079
+ *
20080
+ * * **Enabled**
20081
+ * * **Disabled**
19826
20082
  *
19827
20083
  * @example
19828
20084
  * rm-***********.mysql.rds.aliyuncs.com
@@ -19830,7 +20086,10 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19830
20086
  connectionString?: string;
19831
20087
  /**
19832
20088
  * @remarks
19833
- * 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.
19834
20093
  *
19835
20094
  * @example
19836
20095
  * 172.***.***.173
@@ -19838,11 +20097,7 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19838
20097
  IPAddress?: string;
19839
20098
  /**
19840
20099
  * @remarks
19841
- * The network type of the endpoint. Valid values:
19842
- *
19843
- * * **Public**: the public endpoint
19844
- * * **Private**: the internal endpoint (VPC)
19845
- * * **Inner**: the internal endpoint (classic network)
20100
+ * The ID of the endpoint.
19846
20101
  *
19847
20102
  * @example
19848
20103
  * Private
@@ -19850,26 +20105,23 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19850
20105
  netType?: string;
19851
20106
  /**
19852
20107
  * @remarks
19853
- * The port number.
20108
+ * The type of the endpoint. Valid values:
20109
+ *
20110
+ * * **Normal**: the standard endpoint
20111
+ * * **ReadWriteSplitting**: the read/write splitting endpoint
19854
20112
  *
19855
20113
  * @example
19856
20114
  * 3306
19857
20115
  */
19858
20116
  port?: string;
19859
20117
  /**
19860
- * @remarks
19861
- * Indicates whether SSL encryption is enabled. Valid values:
19862
- *
19863
- * * **Enabled**
19864
- * * **Disabled**
19865
- *
19866
20118
  * @example
19867
20119
  * Enabled
19868
20120
  */
19869
20121
  SSLEnabled?: string;
19870
20122
  /**
19871
20123
  * @remarks
19872
- * The VPC ID.
20124
+ * The instance type.
19873
20125
  *
19874
20126
  * @example
19875
20127
  * vpc-************
@@ -19877,7 +20129,7 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19877
20129
  VPCId?: string;
19878
20130
  /**
19879
20131
  * @remarks
19880
- * The vSwitch ID.
20132
+ * The IP address of the endpoint.
19881
20133
  *
19882
20134
  * @example
19883
20135
  * vsw-**************
@@ -19896,13 +20148,10 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddres
19896
20148
  export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.Model {
19897
20149
  /**
19898
20150
  * @remarks
19899
- * Details about the endpoints.
20151
+ * The VPC ID.
19900
20152
  */
19901
20153
  addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
19902
20154
  /**
19903
- * @remarks
19904
- * The role of the source database instance.
19905
- *
19906
20155
  * @example
19907
20156
  * ReadOnly
19908
20157
  * Maxscale
@@ -19910,20 +20159,11 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
19910
20159
  */
19911
20160
  custinsType?: string;
19912
20161
  /**
19913
- * @remarks
19914
- * The ID of the endpoint.
19915
- *
19916
20162
  * @example
19917
20163
  * rm-************-normal
19918
20164
  */
19919
20165
  DBEndpointId?: string;
19920
20166
  /**
19921
- * @remarks
19922
- * The type of the endpoint. Valid values:
19923
- *
19924
- * * **Normal**: the standard endpoint
19925
- * * **ReadWriteSplitting**: the read/write splitting endpoint
19926
- *
19927
20167
  * @example
19928
20168
  * Normal
19929
20169
  */
@@ -22416,66 +22656,111 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecu
22416
22656
  }
22417
22657
  export declare class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
22418
22658
  /**
22659
+ * @remarks
22660
+ * The number of generated activation codes.
22661
+ *
22419
22662
  * @example
22420
22663
  * 10
22421
22664
  */
22422
22665
  activatedCodeCount?: number;
22423
22666
  /**
22667
+ * @remarks
22668
+ * The maximum number of activation codes that you can apply for.
22669
+ *
22424
22670
  * @example
22425
22671
  * 10
22426
22672
  */
22427
22673
  activationCodeQuota?: number;
22428
22674
  /**
22675
+ * @remarks
22676
+ * The ID of the Alibaba Cloud order. The ID of a virtual order may be returned.
22677
+ *
22429
22678
  * @example
22430
22679
  * 227638319690519
22431
22680
  */
22432
22681
  aliyunOrderId?: string;
22433
22682
  /**
22683
+ * @remarks
22684
+ * Indicates whether the SystemIdentifier parameter can be left empty when the system generates an activation code.
22685
+ *
22434
22686
  * @example
22435
22687
  * false
22436
22688
  */
22437
22689
  allowEmptySystemIdentifier?: boolean;
22438
22690
  /**
22691
+ * @remarks
22692
+ * The engine of the PolarDB cluster. Valid values: PG, Oracle, and MySQL.
22693
+ *
22439
22694
  * @example
22440
22695
  * PG
22441
22696
  */
22442
22697
  engine?: string;
22443
22698
  /**
22699
+ * @remarks
22700
+ * The time when the order was created.
22701
+ *
22444
22702
  * @example
22445
22703
  * 2022-02-11 03:14:15
22446
22704
  */
22447
22705
  gmtCreated?: string;
22448
22706
  /**
22707
+ * @remarks
22708
+ * The time when the order was updated.
22709
+ *
22449
22710
  * @example
22450
22711
  * 2022-02-11 03:14:15
22451
22712
  */
22452
22713
  gmtModified?: string;
22453
22714
  /**
22715
+ * @remarks
22716
+ * Indicates whether the order is a virtual order. Pre-generation of activation codes is allowed for virtual orders.
22717
+ *
22454
22718
  * @example
22455
22719
  * false
22456
22720
  */
22457
22721
  isVirtualOrder?: boolean;
22458
22722
  /**
22723
+ * @remarks
22724
+ * Indicates whether the virtual order is frozen. Generation of activation codes is not allowed for frozen virtual orders.
22725
+ *
22459
22726
  * @example
22460
22727
  * false
22461
22728
  */
22462
22729
  isVirtualOrderFrozen?: boolean;
22463
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
+ *
22464
22740
  * @example
22465
22741
  * single_node_subscribe
22466
22742
  */
22467
22743
  packageType?: string;
22468
22744
  /**
22745
+ * @remarks
22746
+ * The validity period of the package. Valid values: 1 year and 30 years.
22747
+ *
22469
22748
  * @example
22470
22749
  * 1 year
22471
22750
  */
22472
22751
  packageValidity?: string;
22473
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
+ *
22474
22756
  * @example
22475
22757
  * aliyun_public
22476
22758
  */
22477
22759
  purchaseChannel?: string;
22478
22760
  /**
22761
+ * @remarks
22762
+ * The ID of the virtual order.
22763
+ *
22479
22764
  * @example
22480
22765
  * 227638319690519
22481
22766
  */
@@ -24203,7 +24488,7 @@ export default class Client extends OpenApi {
24203
24488
  */
24204
24489
  createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
24205
24490
  /**
24206
- * 生成轻量化版本激活码
24491
+ * Generates a lightweight license activation code.
24207
24492
  *
24208
24493
  * @param request - CreateActivationCodeRequest
24209
24494
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24211,7 +24496,7 @@ export default class Client extends OpenApi {
24211
24496
  */
24212
24497
  createActivationCodeWithOptions(request: CreateActivationCodeRequest, runtime: $Util.RuntimeOptions): Promise<CreateActivationCodeResponse>;
24213
24498
  /**
24214
- * 生成轻量化版本激活码
24499
+ * Generates a lightweight license activation code.
24215
24500
  *
24216
24501
  * @param request - CreateActivationCodeRequest
24217
24502
  * @returns CreateActivationCodeResponse
@@ -24414,7 +24699,7 @@ export default class Client extends OpenApi {
24414
24699
  */
24415
24700
  createGlobalSecurityIPGroup(request: CreateGlobalSecurityIPGroupRequest): Promise<CreateGlobalSecurityIPGroupResponse>;
24416
24701
  /**
24417
- * 创建或获取虚拟证书订单
24702
+ * Creates or obtains a virtual license order.
24418
24703
  *
24419
24704
  * @param request - CreateOrGetVirtualLicenseOrderRequest
24420
24705
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24422,7 +24707,7 @@ export default class Client extends OpenApi {
24422
24707
  */
24423
24708
  createOrGetVirtualLicenseOrderWithOptions(request: CreateOrGetVirtualLicenseOrderRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrGetVirtualLicenseOrderResponse>;
24424
24709
  /**
24425
- * 创建或获取虚拟证书订单
24710
+ * Creates or obtains a virtual license order.
24426
24711
  *
24427
24712
  * @param request - CreateOrGetVirtualLicenseOrderRequest
24428
24713
  * @returns CreateOrGetVirtualLicenseOrderResponse
@@ -24757,7 +25042,7 @@ export default class Client extends OpenApi {
24757
25042
  */
24758
25043
  describeActivationCodeDetails(request: DescribeActivationCodeDetailsRequest): Promise<DescribeActivationCodeDetailsResponse>;
24759
25044
  /**
24760
- * 查询激活码列表
25045
+ * Queries a list of activation codes.
24761
25046
  *
24762
25047
  * @param request - DescribeActivationCodesRequest
24763
25048
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24765,7 +25050,7 @@ export default class Client extends OpenApi {
24765
25050
  */
24766
25051
  describeActivationCodesWithOptions(request: DescribeActivationCodesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodesResponse>;
24767
25052
  /**
24768
- * 查询激活码列表
25053
+ * Queries a list of activation codes.
24769
25054
  *
24770
25055
  * @param request - DescribeActivationCodesRequest
24771
25056
  * @returns DescribeActivationCodesResponse
@@ -24967,11 +25252,10 @@ export default class Client extends OpenApi {
24967
25252
  */
24968
25253
  describeDBClusterEndpoints(request: DescribeDBClusterEndpointsRequest): Promise<DescribeDBClusterEndpointsResponse>;
24969
25254
  /**
24970
- * Queries the migration status of PolarDB clusters.
25255
+ * The ID of the synchronous task.
24971
25256
  *
24972
25257
  * @remarks
24973
- * 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).
24974
- * * 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.
24975
25259
  *
24976
25260
  * @param request - DescribeDBClusterMigrationRequest
24977
25261
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24979,11 +25263,10 @@ export default class Client extends OpenApi {
24979
25263
  */
24980
25264
  describeDBClusterMigrationWithOptions(request: DescribeDBClusterMigrationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterMigrationResponse>;
24981
25265
  /**
24982
- * Queries the migration status of PolarDB clusters.
25266
+ * The ID of the synchronous task.
24983
25267
  *
24984
25268
  * @remarks
24985
- * 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).
24986
- * * 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.
24987
25270
  *
24988
25271
  * @param request - DescribeDBClusterMigrationRequest
24989
25272
  * @returns DescribeDBClusterMigrationResponse
@@ -25396,7 +25679,7 @@ export default class Client extends OpenApi {
25396
25679
  */
25397
25680
  describeLicenseOrderDetails(request: DescribeLicenseOrderDetailsRequest): Promise<DescribeLicenseOrderDetailsResponse>;
25398
25681
  /**
25399
- * 查询License订单列表
25682
+ * Queries a list of license orders.
25400
25683
  *
25401
25684
  * @param request - DescribeLicenseOrdersRequest
25402
25685
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25404,7 +25687,7 @@ export default class Client extends OpenApi {
25404
25687
  */
25405
25688
  describeLicenseOrdersWithOptions(request: DescribeLicenseOrdersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrdersResponse>;
25406
25689
  /**
25407
- * 查询License订单列表
25690
+ * Queries a list of license orders.
25408
25691
  *
25409
25692
  * @param request - DescribeLicenseOrdersRequest
25410
25693
  * @returns DescribeLicenseOrdersResponse
@@ -26574,7 +26857,7 @@ export default class Client extends OpenApi {
26574
26857
  */
26575
26858
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
26576
26859
  /**
26577
- * Temporarily changes the node configurations of a cluster.
26860
+ * Temporarily changes the node configurations.
26578
26861
  *
26579
26862
  * @param request - TempModifyDBNodeRequest
26580
26863
  * @param runtime - runtime options for this request RuntimeOptions
@@ -26582,7 +26865,7 @@ export default class Client extends OpenApi {
26582
26865
  */
26583
26866
  tempModifyDBNodeWithOptions(request: TempModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<TempModifyDBNodeResponse>;
26584
26867
  /**
26585
- * Temporarily changes the node configurations of a cluster.
26868
+ * Temporarily changes the node configurations.
26586
26869
  *
26587
26870
  * @param request - TempModifyDBNodeRequest
26588
26871
  * @returns TempModifyDBNodeResponse