@alicloud/polardb20170801 5.1.13 → 5.2.1

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
@@ -609,17 +609,18 @@ export declare class CreateAccountRequest extends $tea.Model {
609
609
  * @remarks
610
610
  * The permissions that are granted to the account. Valid values:
611
611
  *
612
- * * **ReadWrite**: read and write permissions
613
- * * **ReadOnly**: read-only permissions
614
- * * **DMLOnly**: the permissions to execute only DML statements
615
- * * **DDLOnly**: the permissions to execute only DDL statements
616
- * * **ReadIndex**: the read and index permissions
612
+ * * **ReadWrite**: read and write permissions.
613
+ * * **ReadOnly**: read-only permissions.
614
+ * * **DMLOnly**: the permissions to execute only DML statements.
615
+ * * **DDLOnly**: the permissions to execute only DDL statements.
616
+ * * **ReadIndex**: the read-only and index permissions.
617
617
  *
618
618
  * >
619
619
  *
620
- * * The `AccountPrivilege` parameter is valid only after you specify the `DBName` parameter.
620
+ * * `AccountPrivilege` is valid only after you specify `DBName`.
621
+ *
622
+ * * If multiple database names are specified by the `DBName` parameter, you must grant permissions on the databases. Separate multiple permissions with commas (,), and make sure that the length of the value of `AccountPrivilege` does not exceed 900. For example, if you want to grant the account the read and write permissions on DB1 and the read-only permissions on DB2, set `DBName` to `DB1,DB2` and set `AccountPrivilege` to `ReadWrite,ReadOnly`.
621
623
  *
622
- * * If multiple database names are specified by the `DBName` parameter, you must grant permissions on the databases. Separate multiple permissions with commas (,). For example, if you want to grant the account the read and write permissions on DB1 and the read-only permissions on DB2, set `DBName` to `DB1,DB2`, and set `AccountPrivilege` to `ReadWrite,ReadOnly`.
623
624
  * * This parameter is valid only for standard accounts of PolarDB for MySQL clusters.
624
625
  *
625
626
  * @example
@@ -666,7 +667,7 @@ export declare class CreateAccountRequest extends $tea.Model {
666
667
  * @remarks
667
668
  * The name of the database that can be accessed by the account. To enter multiple database names, separate the names with commas (,).
668
669
  *
669
- * > This parameter is valid only for standard accounts of PolarDB for MySQL clusters.
670
+ * > This parameter is valid only for standard accounts of PolarDB for MySQL clusters.
670
671
  *
671
672
  * @example
672
673
  * testdb
@@ -674,6 +675,16 @@ export declare class CreateAccountRequest extends $tea.Model {
674
675
  DBName?: string;
675
676
  ownerAccount?: string;
676
677
  ownerId?: number;
678
+ /**
679
+ * @remarks
680
+ * Specifies whether to grant the specified account required permissions on all existing databases in the current cluster and databases that will be further created for the current cluster. Valid values:
681
+ *
682
+ * * **0 or unspecified**: does not grant required permissions.
683
+ * * **1**: grants required permissions.
684
+ *
685
+ * @example
686
+ * 0
687
+ */
677
688
  privForAllDB?: string;
678
689
  resourceOwnerAccount?: string;
679
690
  resourceOwnerId?: number;
@@ -722,6 +733,140 @@ export declare class CreateAccountResponse extends $tea.Model {
722
733
  [key: string]: any;
723
734
  });
724
735
  }
736
+ export declare class CreateActivationCodeRequest extends $tea.Model {
737
+ /**
738
+ * @remarks
739
+ * This parameter is required.
740
+ *
741
+ * @example
742
+ * 2233****445566
743
+ */
744
+ aliyunOrderId?: string;
745
+ /**
746
+ * @example
747
+ * testCode
748
+ */
749
+ description?: string;
750
+ /**
751
+ * @remarks
752
+ * This parameter is required.
753
+ *
754
+ * @example
755
+ * 12:34:56:78:98:00
756
+ */
757
+ macAddress?: string;
758
+ /**
759
+ * @remarks
760
+ * This parameter is required.
761
+ *
762
+ * @example
763
+ * testName
764
+ */
765
+ name?: string;
766
+ ownerAccount?: string;
767
+ ownerId?: number;
768
+ resourceOwnerAccount?: string;
769
+ resourceOwnerId?: number;
770
+ /**
771
+ * @example
772
+ * 1234567890123456
773
+ */
774
+ systemIdentifier?: string;
775
+ static names(): {
776
+ [key: string]: string;
777
+ };
778
+ static types(): {
779
+ [key: string]: any;
780
+ };
781
+ constructor(map?: {
782
+ [key: string]: any;
783
+ });
784
+ }
785
+ export declare class CreateActivationCodeResponseBody extends $tea.Model {
786
+ /**
787
+ * @example
788
+ * 2024-10-16 16:46:20
789
+ */
790
+ activateAt?: string;
791
+ /**
792
+ * @example
793
+ * AAEAA******AAA=
794
+ */
795
+ certContentB64?: string;
796
+ /**
797
+ * @example
798
+ * testCode
799
+ */
800
+ description?: string;
801
+ /**
802
+ * @example
803
+ * 2054-10-09 16:46:20
804
+ */
805
+ expireAt?: string;
806
+ /**
807
+ * @example
808
+ * 2024-10-16 16:46:20
809
+ */
810
+ gmtCreated?: string;
811
+ /**
812
+ * @example
813
+ * 2024-10-16 16:46:20
814
+ */
815
+ gmtModified?: string;
816
+ /**
817
+ * @example
818
+ * 123
819
+ */
820
+ id?: number;
821
+ /**
822
+ * @example
823
+ * 12:34:56:78:98:00
824
+ */
825
+ macAddress?: string;
826
+ /**
827
+ * @example
828
+ * testName
829
+ */
830
+ name?: string;
831
+ /**
832
+ * @remarks
833
+ * Id of the request
834
+ *
835
+ * @example
836
+ * 4CE6DF97-AEA4-484F-906F-C407EE******
837
+ */
838
+ requestId?: string;
839
+ /**
840
+ * @example
841
+ * 1234567890123456
842
+ */
843
+ systemIdentifier?: string;
844
+ static names(): {
845
+ [key: string]: string;
846
+ };
847
+ static types(): {
848
+ [key: string]: any;
849
+ };
850
+ constructor(map?: {
851
+ [key: string]: any;
852
+ });
853
+ }
854
+ export declare class CreateActivationCodeResponse extends $tea.Model {
855
+ headers?: {
856
+ [key: string]: string;
857
+ };
858
+ statusCode?: number;
859
+ body?: CreateActivationCodeResponseBody;
860
+ static names(): {
861
+ [key: string]: string;
862
+ };
863
+ static types(): {
864
+ [key: string]: any;
865
+ };
866
+ constructor(map?: {
867
+ [key: string]: any;
868
+ });
869
+ }
725
870
  export declare class CreateBackupRequest extends $tea.Model {
726
871
  /**
727
872
  * @remarks
@@ -800,17 +945,25 @@ export declare class CreateBackupResponse extends $tea.Model {
800
945
  }
801
946
  export declare class CreateColdStorageInstanceRequest extends $tea.Model {
802
947
  /**
948
+ * @remarks
949
+ * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
950
+ *
803
951
  * @example
804
952
  * 6000170000591aed949d0f5********************
805
953
  */
806
954
  clientToken?: string;
807
955
  /**
956
+ * @remarks
957
+ * The description of the cluster. The description cannot exceed 256 characters in length.
958
+ *
808
959
  * @example
809
960
  * xxxxxxxxx
810
961
  */
811
962
  coldStorageInstanceDescription?: string;
812
963
  /**
813
964
  * @remarks
965
+ * The cluster ID. > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters within your account, such as cluster IDs.
966
+ *
814
967
  * This parameter is required.
815
968
  *
816
969
  * @example
@@ -820,6 +973,9 @@ export declare class CreateColdStorageInstanceRequest extends $tea.Model {
820
973
  ownerAccount?: string;
821
974
  ownerId?: number;
822
975
  /**
976
+ * @remarks
977
+ * The ID of the resource group.
978
+ *
823
979
  * @example
824
980
  * rg-************
825
981
  */
@@ -838,11 +994,17 @@ export declare class CreateColdStorageInstanceRequest extends $tea.Model {
838
994
  }
839
995
  export declare class CreateColdStorageInstanceResponseBody extends $tea.Model {
840
996
  /**
997
+ * @remarks
998
+ * The cluster ID.
999
+ *
841
1000
  * @example
842
1001
  * pcs_2zeth2gf4i83e578t
843
1002
  */
844
1003
  coldStorageInstanceId?: string;
845
1004
  /**
1005
+ * @remarks
1006
+ * The request ID.
1007
+ *
846
1008
  * @example
847
1009
  * F6EBB4ED-D12F-5F49-824C-9DD9C0EC4CF2
848
1010
  */
@@ -876,12 +1038,13 @@ export declare class CreateColdStorageInstanceResponse extends $tea.Model {
876
1038
  export declare class CreateDBClusterRequest extends $tea.Model {
877
1039
  /**
878
1040
  * @remarks
879
- * Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values:
1041
+ * Whether to enable idle pause. Values:
880
1042
  *
881
- * * **true**
882
- * * **false**
1043
+ * - **true**: Enabled
1044
+ *
1045
+ * - **false**: Disabled (default)
883
1046
  *
884
- * > This parameter is valid only for serverless clusters.
1047
+ * > Only supported by Serverless clusters.
885
1048
  *
886
1049
  * @example
887
1050
  * true
@@ -889,10 +1052,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
889
1052
  allowShutDown?: string;
890
1053
  /**
891
1054
  * @remarks
892
- * The CPU architecture. Valid values:
893
- *
894
- * * X86
895
- * * ARM
1055
+ * CPU architecture. Available values include:
1056
+ * - X86
1057
+ * - ARM
896
1058
  *
897
1059
  * @example
898
1060
  * X86
@@ -900,14 +1062,14 @@ export declare class CreateDBClusterRequest extends $tea.Model {
900
1062
  architecture?: string;
901
1063
  /**
902
1064
  * @remarks
903
- * Specifies whether to enable automatic renewal. Valid values:
1065
+ * Whether to enable auto-renewal, with available values as follows:
904
1066
  *
905
- * * **true**
906
- * * **false**
1067
+ * - **true**: Auto-renew.
1068
+ * - **false**: Do not auto-renew.
907
1069
  *
908
- * Default value: **false**.
1070
+ * The default is **false**.
909
1071
  *
910
- * > This parameter is valid only when the **PayType** parameter is set to **Prepaid**.
1072
+ * > This parameter takes effect only when **PayType** is set to **Prepaid**.
911
1073
  *
912
1074
  * @example
913
1075
  * true
@@ -915,19 +1077,14 @@ export declare class CreateDBClusterRequest extends $tea.Model {
915
1077
  autoRenew?: boolean;
916
1078
  /**
917
1079
  * @remarks
918
- * The retention policy for the backup sets when you delete the cluster. Valid values:
919
- *
920
- * * **ALL**: permanently retains all backups.
921
- * * **LATEST**: permanently retains the last backup. A backup is automatically created before you delete the cluster.
922
- * * **NONE**: No backup sets are retained after the cluster is deleted.
923
- *
924
- * The default value is **NONE** after you create a cluster.
925
- *
926
- * >
927
- *
928
- * * This parameter is valid only when the **DBType** parameter is set to **MySQL**.
1080
+ * Backup retention policy upon cluster deletion, with valid values as follows:
1081
+ * * **ALL**: Permanently retain all backups.
1082
+ * * **LATEST**: Permanently retain the latest backup (automatically backed up before deletion).
1083
+ * * **NONE**: Do not retain backup sets upon cluster deletion.
929
1084
  *
930
- * * This parameter is invalid for serverless clusters.
1085
+ * By default, the value is set to **NONE**, indicating no backup sets are retained upon cluster deletion.
1086
+ * > This parameter applies only when **DBType** is **MySQL**.
1087
+ * > Serverless clusters do not support this parameter.
931
1088
  *
932
1089
  * @example
933
1090
  * NONE
@@ -935,7 +1092,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
935
1092
  backupRetentionPolicyOnClusterDeletion?: string;
936
1093
  /**
937
1094
  * @remarks
938
- * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.
1095
+ * Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.
939
1096
  *
940
1097
  * @example
941
1098
  * 6000170000591aed949d0f5********************
@@ -943,15 +1100,15 @@ export declare class CreateDBClusterRequest extends $tea.Model {
943
1100
  clientToken?: string;
944
1101
  /**
945
1102
  * @remarks
946
- * The point in time when you want to clone data. Valid values:
1103
+ * The point in time to clone data, with the following options:
947
1104
  *
948
- * * **LATEST**: The data of the latest point in time is cloned.
949
- * * **BackupID**: You can specify the ID of a backup set. In this case, data is cloned based on the specified backup set.
950
- * * **Timestamp**: You can specify a point in time in the past in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
1105
+ * - **LATEST**: Data from the latest time point.
1106
+ * - **BackupID**: Historical backup set ID, please enter the specific backup set ID.
1107
+ * - **Timestamp**: Historical time point, please enter the specific time in the format `YYYY-MM-DDThh:mm:ssZ` (UTC time).
951
1108
  *
952
- * Default value: **LATEST**.
1109
+ * The default value is **LATEST**.
953
1110
  *
954
- * > If the **CreationOption** parameter is set to **CloneFromRDS**, the value of this parameter must be **LATEST**.
1111
+ * > If **CreationOption** is **CloneFromRDS**, this parameter can only be set to **LATEST**.
955
1112
  *
956
1113
  * @example
957
1114
  * LATEST
@@ -959,7 +1116,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
959
1116
  cloneDataPoint?: string;
960
1117
  /**
961
1118
  * @remarks
962
- * The network type of the cluster. Only virtual private clouds (VPCs) are supported. Set the value to **VPC**.
1119
+ * Cluster network type, currently only VPC is supported, with a fixed value of **VPC**.
963
1120
  *
964
1121
  * @example
965
1122
  * VPC
@@ -967,20 +1124,18 @@ export declare class CreateDBClusterRequest extends $tea.Model {
967
1124
  clusterNetworkType?: string;
968
1125
  /**
969
1126
  * @remarks
970
- * The edition of the cluster. Default value: Normal. Valid values:
971
- *
972
- * * **Normal**: Cluster Edition
973
- * * **Basic**: Single Node Edition
974
- * * **ArchiveNormal**: X-Engine Edition
975
- * * **NormalMultimaster**: Multi-master Cluster Edition
976
- *
977
- * >
1127
+ * Product series, with valid values as follows:
1128
+ * * **Normal**: Cluster Edition (default)
1129
+ * * **Basic**: Single-node
1130
+ * * **ArchiveNormal**: High Compression Engine (X-Engine)
1131
+ * * **NormalMultimaster**: Multi-master Cluster Edition
1132
+ * * **SENormal**: Standard Edition
978
1133
  *
979
- * * Only when the **DBType** parameter is set to **MySQL** and **the DBVersion** parameter is set to **5.6**, **5.7**, or **8.0**, you can set this parameter to **Basic**.
1134
+ * > * **MySQL** **5.6**, **5.7**, **8.0**, **PostgreSQL** **14**, and **Oracle Syntax Compatible 2.0** support **Basic**.
1135
+ * > * **MySQL** **8.0** supports **ArchiveNormal** and **NormalMultimaster**.
1136
+ * > * **MySQL** **5.6**, **5.7**, **8.0**, and **PostgreSQL** **14** support **SENormal**.
980
1137
  *
981
- * * Only when the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**, you can set this parameter to **ArchiveNormal** or **NormalMultimaster**.
982
- *
983
- * For more information, see [Product editions](https://help.aliyun.com/document_detail/183258.html).
1138
+ * For more information about product series, see [Product Series](https://help.aliyun.com/document_detail/183258.html).
984
1139
  *
985
1140
  * @example
986
1141
  * Normal
@@ -988,33 +1143,34 @@ export declare class CreateDBClusterRequest extends $tea.Model {
988
1143
  creationCategory?: string;
989
1144
  /**
990
1145
  * @remarks
991
- * The method that is used to create a cluster. Valid values:
992
- *
993
- * * **Normal**: creates a PolarDB cluster. For more information about how to perform this operation in the console, see the following topics:
994
- *
995
- * * [Create a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/58769.html)
996
- * * [Create a PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/118063.html)
997
- * * [Create a PolarDB for Oracle cluster](https://help.aliyun.com/document_detail/118182.html)
1146
+ * Creation method, with the following values supported:
998
1147
  *
999
- * * **CloneFromPolarDB**: clones data from an existing PolarDB cluster to a new PolarDB cluster. For more information about how to perform this operation in the console, see the following topics:
1148
+ * * **Normal**: Creates a brand new PolarDB cluster. For console operations, refer to the following documents:
1149
+ * * [Create a PolarDB MySQL Edition Database Cluster](https://help.aliyun.com/document_detail/58769.html)
1150
+ * * [Create a PolarDB PostgreSQL Edition Database Cluster](https://help.aliyun.com/document_detail/118063.html)
1151
+ * * [Create a PolarDB PostgreSQL Edition (Oracle Compatible) Database Cluster](https://help.aliyun.com/document_detail/118182.html)
1000
1152
  *
1001
- * * [Clone a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/87966.html)
1002
- * * [Clone a PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/118108.html)
1003
- * * [Clone a PolarDB for Oracle cluster](https://help.aliyun.com/document_detail/118221.html)
1153
+ * * **CloneFromPolarDB**: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:
1154
+ * * [Clone a PolarDB MySQL Edition Cluster](https://help.aliyun.com/document_detail/87966.html)
1155
+ * * [Clone a PolarDB PostgreSQL Edition Cluster](https://help.aliyun.com/document_detail/118108.html)
1156
+ * * [Clone a PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](https://help.aliyun.com/document_detail/118221.html)
1004
1157
  *
1005
- * * **CloneFromRDS**: clones data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB for MySQL cluster. For more information about how to perform this operation in the console, see [Create a PolarDB for MySQL cluster by cloning an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/121812.html).
1158
+ * * **RecoverFromRecyclebin**: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:
1159
+ * * [Restore a Released PolarDB MySQL Edition Cluster](https://help.aliyun.com/document_detail/164880.html)
1160
+ * * [Restore a Released PolarDB PostgreSQL Edition Cluster](https://help.aliyun.com/document_detail/432844.html)
1161
+ * * [Restore a Released PolarDB PostgreSQL Edition (Oracle Compatible) Cluster](https://help.aliyun.com/document_detail/424632.html)
1006
1162
  *
1007
- * * **MigrationFromRDS**: migrates data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB for MySQL cluster. By default, the created PolarDB cluster is in read-only mode, and the binary logging feature is enabled. For more information about how to perform this operation in the console, see [Create a PolarDB for MySQL cluster from an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/121582.html).
1163
+ * * **CloneFromRDS**: Clones data from an existing RDS instance to a new PolarDB cluster. Console operation guide is available at [One-click Clone from RDS MySQL to PolarDB MySQL Edition](https://help.aliyun.com/document_detail/121812.html).
1008
1164
  *
1009
- * * **CreateGdnStandby**: creates a secondary cluster. For more information about how to perform this operation in the console, see [Add a secondary cluster](https://help.aliyun.com/document_detail/160381.html).
1165
+ * * **MigrationFromRDS**: Migrates data from an existing RDS instance to a new PolarDB cluster. The created PolarDB cluster operates in read-only mode with Binlog enabled by default. Console operation guide is at [One-click Upgrade from RDS MySQL to PolarDB MySQL Edition](https://help.aliyun.com/document_detail/121582.html).
1010
1166
  *
1011
- * Default value: **Normal**.
1167
+ * * **CreateGdnStandby**: Creates a standby cluster. Console operation guide can be found at [Add Standby Cluster](https://help.aliyun.com/document_detail/160381.html).
1012
1168
  *
1013
- * >
1169
+ * * **UpgradeFromPolarDB**: Upgrades and migrates from PolarDB. Console operation guide is detailed in [Major Version Upgrade](https://help.aliyun.com/document_detail/459712.html).
1014
1170
  *
1015
- * * If the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **5.6** or **5.7**, this parameter can be set to **CloneFromRDS** or **MigrationFromRDS**.
1171
+ * The default value is **Normal**.
1016
1172
  *
1017
- * * If the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**, this parameter can be set to **CreateGdnStandby**.
1173
+ * > When **DBType** is **MySQL** and **DBVersion** is **8.0**, this parameter can also take the value **CreateGdnStandby**.
1018
1174
  *
1019
1175
  * @example
1020
1176
  * Normal
@@ -1022,10 +1178,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1022
1178
  creationOption?: string;
1023
1179
  /**
1024
1180
  * @remarks
1025
- * The name of the cluster. The name must meet the following requirements:
1026
- *
1027
- * * It cannot start with `http://` or `https://`.
1028
- * * It must be 2 to 256 characters in length.
1181
+ * Cluster name, which must meet the following requirements:
1182
+ * * Cannot start with `http://` or `https://`.
1183
+ * * Length should be between 2 and 256 characters.
1029
1184
  *
1030
1185
  * @example
1031
1186
  * test
@@ -1033,12 +1188,12 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1033
1188
  DBClusterDescription?: string;
1034
1189
  /**
1035
1190
  * @remarks
1036
- * The minor version of the database engine. Valid values:
1191
+ * Database engine minor version number. Valid values include:
1037
1192
  *
1038
- * * **8.0.2**
1039
- * * **8.0.1**
1193
+ * - **8.0.2**
1194
+ * - **8.0.1**
1040
1195
  *
1041
- * > This parameter is valid only when the **DBType** parameter is set to **MySQL** and the **DBVersion** parameter is set to **8.0**.
1196
+ * > This parameter takes effect only when **DBType** is **MySQL** and **DBVersion** is **8.0**.
1042
1197
  *
1043
1198
  * @example
1044
1199
  * 8.0.1
@@ -1046,30 +1201,41 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1046
1201
  DBMinorVersion?: string;
1047
1202
  /**
1048
1203
  * @remarks
1049
- * The specifications of the node.
1204
+ * Node specifications. For details, refer to the following documents:
1050
1205
  *
1051
- * * For more information about specifications supported by PolarDB for MySQL, see [Specifications of compute nodes](https://help.aliyun.com/document_detail/102542.html).
1052
- * * For information about node specifications supported by the Oracle database engine, see [Specifications of compute nodes](https://help.aliyun.com/document_detail/207921.html).
1053
- * * For information about node specifications supported by the PostgreSQL database engine, see [Specifications of compute nodes](https://help.aliyun.com/document_detail/209380.html).
1206
+ * - PolarDB MySQL Edition: [Compute Node Specifications](https://help.aliyun.com/document_detail/102542.html).
1207
+ * - PolarDB PostgreSQL Edition (Oracle Compatible): [Compute Node Specifications](https://help.aliyun.com/document_detail/207921.html).
1208
+ * - PolarDB PostgreSQL Edition: [Compute Node Specifications](https://help.aliyun.com/document_detail/209380.html).
1209
+ *
1210
+ * > - For a Serverless cluster in PolarDB MySQL, enter **polar.mysql.sl.small**.
1211
+ * <props="china">> - For a Serverless cluster in both PolarDB PostgreSQL (Oracle Compatible) and PolarDB PostgreSQL, enter **polar.pg.sl.small.c**.
1054
1212
  *
1055
1213
  * This parameter is required.
1056
1214
  *
1057
1215
  * @example
1058
- * polar.mysql.x2.medium
1216
+ * polar.mysql.x4.medium
1059
1217
  */
1060
1218
  DBNodeClass?: string;
1061
1219
  /**
1220
+ * @remarks
1221
+ * Number of standard edition nodes. Values are as follows:
1222
+ *
1223
+ * - **1** (default): Indicates there is only one read-write node.
1224
+ * - **2**: Indicates there is one read-only node and one read-write node.
1225
+ * > - Enterprise edition defaults to 2 nodes, while the standard edition defaults to 1 node.
1226
+ * > - Only supported by PolarDB MySQL edition.
1227
+ *
1062
1228
  * @example
1063
1229
  * 1
1064
1230
  */
1065
1231
  DBNodeNum?: number;
1066
1232
  /**
1067
1233
  * @remarks
1068
- * The type of the database engine. Valid values:
1234
+ * Database engine type, with available values as follows:
1069
1235
  *
1070
- * * **MySQL**
1071
- * * **PostgreSQL**
1072
- * * **Oracle**
1236
+ * - **MySQL**
1237
+ * - **PostgreSQL**
1238
+ * - **Oracle**
1073
1239
  *
1074
1240
  * This parameter is required.
1075
1241
  *
@@ -1079,20 +1245,23 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1079
1245
  DBType?: string;
1080
1246
  /**
1081
1247
  * @remarks
1082
- * The version of the database engine.
1083
- *
1084
- * * Valid values for the MySQL database engine:
1085
- *
1086
- * * **5.6**
1087
- * * **5.7**
1088
- * * **8.0**
1248
+ * Database engine version number.
1249
+ * * For MySQL, the version numbers are as follows:
1250
+ * * **5.6**
1251
+ * * **5.7**
1252
+ * * **8.0**
1253
+ * * For PostgreSQL, the version numbers are as follows:
1254
+ * * **11**
1255
+ * * **14**
1256
+ * * **15**
1257
+ * <props="china">
1089
1258
  *
1090
- * * Valid values for the PostgreSQL database engine:
1259
+ * > When creating a Serverless cluster in PolarDB PostgreSQL, only version **14** is supported.
1091
1260
  *
1092
- * * **11**
1093
- * * **14**
1094
1261
  *
1095
- * * Valid value for the Oracle database engine: **11**
1262
+ * * For Oracle, the version numbers are as follows:
1263
+ * * **11**
1264
+ * * **14**
1096
1265
  *
1097
1266
  * This parameter is required.
1098
1267
  *
@@ -1102,9 +1271,8 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1102
1271
  DBVersion?: string;
1103
1272
  /**
1104
1273
  * @remarks
1105
- * The time zone of the cluster. The time must be in UTC. You can set the parameter to a value that is on the hour from **-12:00 to +13:00**. Example: 00:00. Default value: **SYSTEM**, which means that the value is the same as the time zone of the region.
1106
- *
1107
- * > This parameter is valid only when the **DBType** parameter is set to **MySQL**.
1274
+ * Cluster timezone (UTC), with selectable values ranging from **-12:00** to **+13:00** at whole-hour intervals, e.g., **00:00**. The default value is **SYSTEM**, which matches the Region\\"s timezone.
1275
+ * > This parameter applies only when **DBType** is **MySQL**.
1108
1276
  *
1109
1277
  * @example
1110
1278
  * SYSTEM
@@ -1112,52 +1280,65 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1112
1280
  defaultTimeZone?: string;
1113
1281
  /**
1114
1282
  * @remarks
1115
- * The ID of the Global Database Network (GDN).
1283
+ * Global Database Network (GDN) ID.
1116
1284
  *
1117
- * > This parameter is required only when the **CreationOption** parameter is set to **CreateGdnStandby**.
1285
+ * > This parameter is required when **CreationOption** is **CreateGdnStandby**.
1118
1286
  *
1119
1287
  * @example
1120
1288
  * gdn-***********
1121
1289
  */
1122
1290
  GDNId?: string;
1123
1291
  /**
1292
+ * @remarks
1293
+ * Whether to enable the hot standby cluster. Values are as follows:
1294
+ *
1295
+ * - **ON** (default): Enables the hot standby cluster.
1296
+ * - **OFF**: Disables the hot standby cluster.
1297
+ * - **STANDBY**: Enables the hot standby cluster for the standard edition.
1298
+ * > The default value for standard edition clusters is **STANDBY**.
1299
+ *
1124
1300
  * @example
1125
1301
  * ON
1126
1302
  */
1127
1303
  hotStandbyCluster?: string;
1128
1304
  /**
1305
+ * @remarks
1306
+ * Enable Binlog feature, valid values are as follows:
1307
+ * - **ON**: Cluster enables the Binlog feature. - **OFF**: Cluster disables the Binlog feature. > This parameter takes effect only when the **DBType** parameter is set to **MySQL**.
1308
+ *
1129
1309
  * @example
1130
1310
  * ON
1131
1311
  */
1132
1312
  loosePolarLogBin?: string;
1133
1313
  /**
1134
1314
  * @remarks
1135
- * Specifies whether to enable X-Engine. Valid values:
1136
- *
1137
- * * **ON**
1138
- * * **OFF**
1315
+ * Enable the X-Engine storage engine feature, with valid values as follows:
1139
1316
  *
1140
- * > This parameter takes effect only if you do not set **CreationOption** to **CreateGdnStandby** and you set **DBType** to **MySQL** and **DBVersion** to **8.0**. To enable X-Engine on a node, make sure that the memory of the node is greater than or equal to 8 GB in size.
1317
+ * - **ON**: The cluster enables the X-Engine engine.
1318
+ * - **OFF**: The cluster disables the X-Engine engine.
1319
+ * > This parameter is effective only when **CreationOption** is not **CreateGdnStandby**, **DBType** is **MySQL**, and **DBVersion** is **8.0**. The memory specification of nodes that enable the X-Engine engine must be at least 8 GB.
1141
1320
  *
1142
1321
  * @example
1143
1322
  * ON
1144
1323
  */
1145
1324
  looseXEngine?: string;
1146
1325
  /**
1326
+ * @remarks
1327
+ * Set the ratio for enabling the X-Engine storage engine, with a range of integers from 10 to 90.
1328
+ * > This parameter takes effect only when **LooseXEngine** is **ON**.
1329
+ *
1147
1330
  * @example
1148
1331
  * 50
1149
1332
  */
1150
1333
  looseXEngineUseMemoryPct?: string;
1151
1334
  /**
1152
1335
  * @remarks
1153
- * Specifies whether the table names are case-sensitive. Valid values:
1154
- *
1155
- * * **1**: The table names are case-insensitive.
1156
- * * **0**: The table names are case-sensitive.
1336
+ * Whether table names are case-sensitive, with valid values as follows:
1337
+ * * **1**: Case-insensitive
1338
+ * * **0**: Case-sensitive
1157
1339
  *
1158
- * Default value: **1**.
1159
- *
1160
- * > This parameter is valid only when the **DBType** parameter is set to **MySQL**.
1340
+ * The default value is **1**.
1341
+ * > This parameter applies only when **DBType** is **MySQL**.
1161
1342
  *
1162
1343
  * @example
1163
1344
  * 1
@@ -1167,9 +1348,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1167
1348
  ownerId?: number;
1168
1349
  /**
1169
1350
  * @remarks
1170
- * The ID of the parameter template.
1351
+ * Parameter template ID.
1171
1352
  *
1172
- * > You can call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
1353
+ * > You can view the list of parameter templates in the target region, including the parameter template ID, by calling the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) interface.
1173
1354
  *
1174
1355
  * @example
1175
1356
  * pcpg-**************
@@ -1177,10 +1358,10 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1177
1358
  parameterGroupId?: string;
1178
1359
  /**
1179
1360
  * @remarks
1180
- * The billing method. Valid values:
1361
+ * Payment type, with available values as follows:
1181
1362
  *
1182
- * * **Postpaid**: pay-as-you-go
1183
- * * **Prepaid**: subscription
1363
+ * - **Postpaid**: Pay-as-you-go.
1364
+ * - **Prepaid**: Subscription (monthly or yearly).
1184
1365
  *
1185
1366
  * This parameter is required.
1186
1367
  *
@@ -1190,10 +1371,10 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1190
1371
  payType?: string;
1191
1372
  /**
1192
1373
  * @remarks
1193
- * The subscription type of the subscription cluster. This parameter is required only when the PayType parameter is set to **Prepaid**. Valid values:
1374
+ * If the payment type is **Prepaid**, this parameter is required. It specifies whether the prepaid cluster is on a monthly or yearly basis.
1194
1375
  *
1195
- * * **Year**: annual subscription. Unit: years.
1196
- * * **Month**: monthly subscription. Unit: months.
1376
+ * - **Year**: Yearly subscription.
1377
+ * - **Month**: Monthly subscription.
1197
1378
  *
1198
1379
  * @example
1199
1380
  * Month
@@ -1201,31 +1382,48 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1201
1382
  period?: string;
1202
1383
  /**
1203
1384
  * @remarks
1204
- * The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}
1205
- *
1206
- * Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}
1207
- *
1208
- * > This parameter is available only if the StorageType parameter is set to ESSDAUTOPL.
1385
+ * <p id="p_wyg_t4a_glm">The provisioned read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity-Baseline Performance}.</p>
1386
+ * <p id="p_6de_jxy_k2g">Baseline Performance = min{1,800+50*capacity, 50000}.</p>
1387
+ * <note id="note_7kj_j0o_rgs">This parameter is supported only when StorageType is ESSDAUTOPL.</note>
1209
1388
  *
1210
1389
  * @example
1211
1390
  * 1000
1212
1391
  */
1213
1392
  provisionedIops?: number;
1214
1393
  /**
1394
+ * @remarks
1395
+ * Standard edition database proxy specifications. Values are as follows:
1396
+ *
1397
+ * - **polar.maxscale.g2.medium.c**: 2 cores.
1398
+ * - **polar.maxscale.g2.large.c**: 4 cores.
1399
+ * - **polar.maxscale.g2.xlarge.c**: 8 cores.
1400
+ * - **polar.maxscale.g2.2xlarge.c**: 16 cores.
1401
+ * - **polar.maxscale.g2.3xlarge.c**: 24 cores.
1402
+ * - **polar.maxscale.g2.4xlarge.c**: 32 cores.
1403
+ * - **polar.maxscale.g2.8xlarge.c**: 64 cores.
1404
+ *
1215
1405
  * @example
1216
1406
  * polar.maxscale.g2.medium.c
1217
1407
  */
1218
1408
  proxyClass?: string;
1219
1409
  /**
1410
+ * @remarks
1411
+ * Database proxy type, with values including:
1412
+ * - **EXCLUSIVE**: Enterprise Exclusive Edition
1413
+ * - **GENERAL**: Enterprise General Purpose Edition
1414
+ * > The proxy type must match the type of the cluster\\"s node specifications, i.e.,
1415
+ * >- If the node specification is general, the proxy type should be Enterprise General Purpose Edition;
1416
+ * >- If the node specification is dedicated, the proxy type should be Enterprise Exclusive Edition.
1417
+ *
1220
1418
  * @example
1221
1419
  * Exclusive
1222
1420
  */
1223
1421
  proxyType?: string;
1224
1422
  /**
1225
1423
  * @remarks
1226
- * The region ID of the cluster.
1424
+ * Region ID.
1227
1425
  *
1228
- * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available regions.
1426
+ * > You can view available regions through the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) interface.
1229
1427
  *
1230
1428
  * This parameter is required.
1231
1429
  *
@@ -1235,7 +1433,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1235
1433
  regionId?: string;
1236
1434
  /**
1237
1435
  * @remarks
1238
- * The ID of the resource group.
1436
+ * Resource group ID.
1239
1437
  *
1240
1438
  * @example
1241
1439
  * rg-************
@@ -1245,9 +1443,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1245
1443
  resourceOwnerId?: number;
1246
1444
  /**
1247
1445
  * @remarks
1248
- * The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
1446
+ * Maximum scaling limit for a single node. The value range is: 1 PCU~32 PCU.
1249
1447
  *
1250
- * > This parameter is valid only for serverless clusters.
1448
+ * > Only supported by Serverless clusters.
1251
1449
  *
1252
1450
  * @example
1253
1451
  * 3
@@ -1255,9 +1453,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1255
1453
  scaleMax?: string;
1256
1454
  /**
1257
1455
  * @remarks
1258
- * The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
1456
+ * Minimum scaling limit for a single node. The value range is: 1 PCU~31 PCU.
1259
1457
  *
1260
- * > This parameter is valid only for serverless clusters.
1458
+ * > Only supported by Serverless clusters.
1261
1459
  *
1262
1460
  * @example
1263
1461
  * 1
@@ -1265,9 +1463,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1265
1463
  scaleMin?: string;
1266
1464
  /**
1267
1465
  * @remarks
1268
- * The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
1466
+ * Maximum scaling limit for the number of read-only nodes. The value range is: 0~15.
1269
1467
  *
1270
- * > This parameter is valid only for serverless clusters.
1468
+ * > Only supported by Serverless clusters.
1271
1469
  *
1272
1470
  * @example
1273
1471
  * 4
@@ -1275,9 +1473,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1275
1473
  scaleRoNumMax?: string;
1276
1474
  /**
1277
1475
  * @remarks
1278
- * The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
1476
+ * Minimum scaling limit for the number of read-only nodes. The value range is: 0~15.
1279
1477
  *
1280
- * > This parameter is valid only for serverless clusters.
1478
+ * > Only supported by Serverless clusters.
1281
1479
  *
1282
1480
  * @example
1283
1481
  * 2
@@ -1285,9 +1483,8 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1285
1483
  scaleRoNumMin?: string;
1286
1484
  /**
1287
1485
  * @remarks
1288
- * The IP whitelist of the cluster.
1289
- *
1290
- * > The whitelist can contain multiple IP addresses. Separate multiple IP addresses with commas (,).
1486
+ * PolarDB cluster whitelist IP address.
1487
+ * > Supports configuring multiple whitelist IP addresses, with English commas separating multiple IP addresses.
1291
1488
  *
1292
1489
  * @example
1293
1490
  * 10.***.***.***
@@ -1295,9 +1492,8 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1295
1492
  securityIPList?: string;
1296
1493
  /**
1297
1494
  * @remarks
1298
- * The type of the serverless cluster. Set the value to **AgileServerless**.
1299
- *
1300
- * > This parameter is valid only for serverless clusters.
1495
+ * Serverless type. The current value is fixed to **AgileServerless** (sensitive mode).
1496
+ * > This parameter is only supported by Serverless clusters.
1301
1497
  *
1302
1498
  * @example
1303
1499
  * AgileServerless
@@ -1305,33 +1501,54 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1305
1501
  serverlessType?: string;
1306
1502
  /**
1307
1503
  * @remarks
1308
- * The ID of the source ApsaraDB RDS instance or PolarDB cluster. This parameter is required only when the **CreationOption** parameter is set to **MigrationFromRDS**, **CloneFromRDS**, or **CloneFromPolarDB**.
1504
+ * Source RDS instance ID or source PolarDB cluster ID. This parameter is mandatory only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.
1505
+ * * If **CreationOption** is **MigrationFromRDS** or **CloneFromRDS**, you need to input the source RDS instance ID. The source RDS instance version must be RDS MySQL 5.6, 5.7, or 8.0 High Availability edition.
1506
+ *
1507
+ * * If **CreationOption** is **CloneFromPolarDB**, you need to input the source PolarDB cluster ID. The DBType of the cloned cluster will default to match the source cluster. For example, if the source cluster is MySQL 8.0, the cloned cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.
1309
1508
  *
1310
- * * If the **CreationOption** parameter is set to **MigrationFromRDS** or **CloneFromRDS**, you must set this parameter to the ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must use ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 High-availability Edition.
1311
- * * If the **CreationOption** parameter is set to **CloneFromPolarDB**, you must set this parameter to the ID of the source PolarDB cluster. By default, the value of DBType of the destination cluster must be the same as that of the source cluster. For example, if a MySQL 8.0 cluster is used as the source cluster, you must set the **DBType** parameter to **MySQL** and the **DBVersion** parameter to **8.0** for the destination cluster.
1509
+ * * If **CreationOption** is **RecoverFromRecyclebin**, you need to input the released source PolarDB cluster ID. The DBType of the cluster being recovered from the recycle bin must match the source cluster. For example, if the source cluster was MySQL 8.0, the recovered cluster must also have **DBType** set to **MySQL** and **DBVersion** to **8.0**.
1312
1510
  *
1313
1511
  * @example
1314
1512
  * rm-*************
1315
1513
  */
1316
1514
  sourceResourceId?: string;
1317
1515
  /**
1516
+ * @remarks
1517
+ * The availability zone where the hot standby cluster is stored. Applicable to the standard edition 3AZ scenario.
1518
+ *
1519
+ * > This parameter takes effect only when multi-zone data strong consistency is enabled.
1520
+ *
1318
1521
  * @example
1319
1522
  * cn-hangzhou-g
1320
1523
  */
1321
1524
  standbyAZ?: string;
1322
1525
  /**
1526
+ * @remarks
1527
+ * Whether to enable automatic storage expansion for standard edition clusters, with valid values as follows:
1528
+ *
1529
+ * - Enable: Enables automatic storage expansion.
1530
+ * - Disable: Disables automatic storage expansion.
1531
+ *
1323
1532
  * @example
1324
1533
  * Enable
1325
1534
  */
1326
1535
  storageAutoScale?: string;
1327
1536
  /**
1537
+ * @remarks
1538
+ * The storage billing type, with valid values as follows:
1539
+ *
1540
+ * - Postpaid: Pay-as-you-go (hourly).
1541
+ * - Prepaid: Pay-per-use based on space (subscription).
1542
+ *
1328
1543
  * @example
1329
1544
  * Prepaid
1330
1545
  */
1331
1546
  storagePayType?: string;
1332
1547
  /**
1333
1548
  * @remarks
1334
- * The storage space that uses the subscription billing method. Unit: GB.
1549
+ * Storage space for pay-by-space (subscription) billing. Unit: GB.
1550
+ * > - For PolarDB MySQL Standard Edition, the storage space range is 20 to 32000.
1551
+ * > - When the Standard Edition storage type is ESSDAUTOPL, the storage space range is 40 to 64000, with a minimum step size of 10, meaning you can only enter values like 40, 50, 60, and so on.
1335
1552
  *
1336
1553
  * @example
1337
1554
  * 50
@@ -1339,35 +1556,38 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1339
1556
  storageSpace?: number;
1340
1557
  /**
1341
1558
  * @remarks
1342
- * The storage type. Valid values for Enterprise Edition:
1343
- *
1344
- * * **PSL5**
1345
- * * **PSL4**
1559
+ * Enterprise edition storage types include:
1560
+ * - **PSL5**
1561
+ * - **PSL4**
1346
1562
  *
1347
- * Valid values for Standard Edition:
1348
- * * **ESSDPL0**
1349
- * * **ESSDPL1**
1350
- * * **ESSDPL2**
1351
- * * **ESSDPL3**
1352
- * * **ESSDAUTOPL**
1353
- *
1354
- * > This parameter is invalid for serverless clusters.
1563
+ * Standard edition storage types include:
1564
+ * - **ESSDPL0**
1565
+ * - **ESSDPL1**
1566
+ * - **ESSDPL2**
1567
+ * - **ESSDPL3**
1568
+ * - **ESSDAUTOPL**
1355
1569
  *
1356
1570
  * @example
1357
1571
  * PSL4
1358
1572
  */
1359
1573
  storageType?: string;
1360
1574
  /**
1575
+ * @remarks
1576
+ * Set the upper limit for automatic storage expansion of standard edition clusters, in GB.
1577
+ *
1578
+ * > The maximum value is 32000.
1579
+ *
1361
1580
  * @example
1362
1581
  * 800
1363
1582
  */
1364
1583
  storageUpperBound?: number;
1365
1584
  /**
1366
1585
  * @remarks
1367
- * Specifies whether to enable multi-zone data consistency. Valid values:
1586
+ * Whether the cluster has enabled strong data consistency across multiple zones. Values are as follows:
1587
+ *
1588
+ * - **ON**: Indicates strong data consistency across multiple zones is enabled, applicable to the standard edition 3AZ scenario.
1368
1589
  *
1369
- * * **ON**: enables multi-zone data consistency. Set this parameter to ON for Standard Edition clusters of Multi-zone Edition.
1370
- * * **OFF**: disables multi-zone data consistency.
1590
+ * - **OFF**: Indicates strong data consistency across multiple zones is not enabled.
1371
1591
  *
1372
1592
  * @example
1373
1593
  * ON
@@ -1375,17 +1595,14 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1375
1595
  strictConsistency?: string;
1376
1596
  /**
1377
1597
  * @remarks
1378
- * Specifies whether to enable transparent data encryption (TDE). Default value: false. Valid values:
1379
- *
1380
- * * **true**
1381
- * * **false**
1382
- *
1383
- * >
1598
+ * Enables TDE encryption. Valid values are as follows:
1384
1599
  *
1385
- * * This parameter is valid only when the **DBType** parameter is set to **PostgreSQL** or **Oracle**.
1600
+ * - **true**: Enabled.
1601
+ * - **false**: Disabled (default).
1386
1602
  *
1387
- * * You can call the [ModifyDBClusterTDE](https://help.aliyun.com/document_detail/167982.html) operation to enable TDE for a PolarDB for MySQL cluster.
1388
- * * TDE cannot be disabled after it is enabled.
1603
+ * > * This parameter takes effect only when **DBType** is **PostgreSQL** or **Oracle**.
1604
+ * > * You can call the [ModifyDBClusterTDE](https://help.aliyun.com/document_detail/167982.html) interface to enable TDE encryption for a PolarDB MySQL cluster.
1605
+ * > * Once the TDE feature is enabled, it cannot be disabled.
1389
1606
  *
1390
1607
  * @example
1391
1608
  * true
@@ -1393,13 +1610,14 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1393
1610
  TDEStatus?: boolean;
1394
1611
  /**
1395
1612
  * @remarks
1396
- * 1
1613
+ * List of tags.
1397
1614
  */
1398
1615
  tag?: CreateDBClusterRequestTag[];
1399
1616
  /**
1400
1617
  * @remarks
1401
- * * If the **Period** parameter is set to **Month**, the **UsedTime** parameter can be set to `1, 2, 3, 4, 5, 6, 7, 8, or 9`.
1402
- * * If the **Period** parameter is set to **Year**, the **UsedTime** parameter can be set to `1, 2, or 3`.
1618
+ * If the payment type is **Prepaid**, this parameter is required.
1619
+ * - When **Period** is **Month**, **UsedTime** should be an integer within `[1-9]`.
1620
+ * - When **Period** is **Year**, **UsedTime** should be an integer within `[1-3]`.
1403
1621
  *
1404
1622
  * @example
1405
1623
  * 1
@@ -1407,7 +1625,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1407
1625
  usedTime?: string;
1408
1626
  /**
1409
1627
  * @remarks
1410
- * The virtual private cloud (VPC) ID of the cluster.
1628
+ * VPC ID.
1411
1629
  *
1412
1630
  * @example
1413
1631
  * vpc-**********
@@ -1415,9 +1633,9 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1415
1633
  VPCId?: string;
1416
1634
  /**
1417
1635
  * @remarks
1418
- * The vSwitch ID of the cluster.
1636
+ * Virtual switch ID.
1419
1637
  *
1420
- * > If the VPCId parameter is specified, the VSwitchId parameter is required.
1638
+ * > If VPCId has been selected, VSwitchId is mandatory.
1421
1639
  *
1422
1640
  * @example
1423
1641
  * vsw-**********
@@ -1425,12 +1643,12 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1425
1643
  vSwitchId?: string;
1426
1644
  /**
1427
1645
  * @remarks
1428
- * The zone ID of the cluster.
1646
+ * Availability Zone ID.
1429
1647
  *
1430
- * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available zones.
1648
+ * > You can view the available zones through the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) interface.
1431
1649
  *
1432
1650
  * @example
1433
- * cn-hangzhou-g
1651
+ * cn-hangzhou-j
1434
1652
  */
1435
1653
  zoneId?: string;
1436
1654
  static names(): {
@@ -1446,7 +1664,7 @@ export declare class CreateDBClusterRequest extends $tea.Model {
1446
1664
  export declare class CreateDBClusterResponseBody extends $tea.Model {
1447
1665
  /**
1448
1666
  * @remarks
1449
- * The ID of cluster.
1667
+ * Cluster ID.
1450
1668
  *
1451
1669
  * @example
1452
1670
  * pc-bp1s826a1up******
@@ -1454,7 +1672,7 @@ export declare class CreateDBClusterResponseBody extends $tea.Model {
1454
1672
  DBClusterId?: string;
1455
1673
  /**
1456
1674
  * @remarks
1457
- * The ID of the order.
1675
+ * Order ID.
1458
1676
  *
1459
1677
  * @example
1460
1678
  * 211454967******
@@ -1462,7 +1680,7 @@ export declare class CreateDBClusterResponseBody extends $tea.Model {
1462
1680
  orderId?: string;
1463
1681
  /**
1464
1682
  * @remarks
1465
- * The ID of the request.
1683
+ * Request ID.
1466
1684
  *
1467
1685
  * @example
1468
1686
  * E56531A4-E552-40BA-9C58-137B80******
@@ -1470,7 +1688,7 @@ export declare class CreateDBClusterResponseBody extends $tea.Model {
1470
1688
  requestId?: string;
1471
1689
  /**
1472
1690
  * @remarks
1473
- * The ID of the resource group.
1691
+ * Resource group ID.
1474
1692
  *
1475
1693
  * @example
1476
1694
  * rg-***************
@@ -1505,12 +1723,10 @@ export declare class CreateDBClusterResponse extends $tea.Model {
1505
1723
  export declare class CreateDBClusterEndpointRequest extends $tea.Model {
1506
1724
  /**
1507
1725
  * @remarks
1508
- * Specifies whether to automatically associate newly added nodes with the cluster endpoint. Valid values:
1509
- *
1510
- * * **Enable**: Newly added nodes are automatically associated with the cluster endpoint.
1511
- * * **Disable**: Newly added nodes are not automatically associated with the cluster endpoint.
1726
+ * Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
1512
1727
  *
1513
- * Default value: **Disable**.
1728
+ * * **Enable**: enables automatic association of newly added nodes with the cluster endpoint.
1729
+ * * **Disable** (default): disables automatic association of newly added nodes with the cluster endpoint.
1514
1730
  *
1515
1731
  * @example
1516
1732
  * Disable
@@ -1605,7 +1821,23 @@ export declare class CreateDBClusterEndpointRequest extends $tea.Model {
1605
1821
  nodes?: string;
1606
1822
  ownerAccount?: string;
1607
1823
  ownerId?: number;
1824
+ /**
1825
+ * @remarks
1826
+ * Global consistency timeout strategy. The value range is as follows:
1827
+ * - **0**: Send the request to the primary node
1828
+ * - **2**: Timeout degradation, when a global consistency read times out, the query operation will automatically degrade to an inconsistent read, and the client will not receive an error message
1829
+ *
1830
+ * @example
1831
+ * 0
1832
+ */
1608
1833
  polarSccTimeoutAction?: string;
1834
+ /**
1835
+ * @remarks
1836
+ * Global consistency timeout
1837
+ *
1838
+ * @example
1839
+ * 100
1840
+ */
1609
1841
  polarSccWaitTimeout?: string;
1610
1842
  /**
1611
1843
  * @remarks
@@ -1622,6 +1854,14 @@ export declare class CreateDBClusterEndpointRequest extends $tea.Model {
1622
1854
  readWriteMode?: string;
1623
1855
  resourceOwnerAccount?: string;
1624
1856
  resourceOwnerId?: number;
1857
+ /**
1858
+ * @remarks
1859
+ * Whether the node has enabled the global consistency (high-performance mode) feature. The value range is as follows:
1860
+ * - **ON**: Enabled - **OFF**: Disabled
1861
+ *
1862
+ * @example
1863
+ * on
1864
+ */
1625
1865
  sccMode?: string;
1626
1866
  static names(): {
1627
1867
  [key: string]: string;
@@ -2401,56 +2641,174 @@ export declare class CreateGlobalSecurityIPGroupRequest extends $tea.Model {
2401
2641
  * This parameter is required.
2402
2642
  *
2403
2643
  * @example
2404
- * test_123
2644
+ * test_123
2645
+ */
2646
+ globalIgName?: string;
2647
+ ownerAccount?: string;
2648
+ ownerId?: number;
2649
+ /**
2650
+ * @remarks
2651
+ * The region ID.
2652
+ *
2653
+ * This parameter is required.
2654
+ *
2655
+ * @example
2656
+ * cn-hangzhou
2657
+ */
2658
+ regionId?: string;
2659
+ /**
2660
+ * @remarks
2661
+ * The ID of the resource group.
2662
+ *
2663
+ * @example
2664
+ * rg-************
2665
+ */
2666
+ resourceGroupId?: string;
2667
+ resourceOwnerAccount?: string;
2668
+ resourceOwnerId?: number;
2669
+ securityToken?: string;
2670
+ static names(): {
2671
+ [key: string]: string;
2672
+ };
2673
+ static types(): {
2674
+ [key: string]: any;
2675
+ };
2676
+ constructor(map?: {
2677
+ [key: string]: any;
2678
+ });
2679
+ }
2680
+ export declare class CreateGlobalSecurityIPGroupResponseBody extends $tea.Model {
2681
+ /**
2682
+ * @remarks
2683
+ * The details of the global IP whitelist template.
2684
+ */
2685
+ globalSecurityIPGroup?: CreateGlobalSecurityIPGroupResponseBodyGlobalSecurityIPGroup[];
2686
+ /**
2687
+ * @remarks
2688
+ * The ID of the request.
2689
+ *
2690
+ * @example
2691
+ * 9B7BFB11-C077-4FE3-B051-F69CEB******
2692
+ */
2693
+ requestId?: string;
2694
+ static names(): {
2695
+ [key: string]: string;
2696
+ };
2697
+ static types(): {
2698
+ [key: string]: any;
2699
+ };
2700
+ constructor(map?: {
2701
+ [key: string]: any;
2702
+ });
2703
+ }
2704
+ export declare class CreateGlobalSecurityIPGroupResponse extends $tea.Model {
2705
+ headers?: {
2706
+ [key: string]: string;
2707
+ };
2708
+ statusCode?: number;
2709
+ body?: CreateGlobalSecurityIPGroupResponseBody;
2710
+ static names(): {
2711
+ [key: string]: string;
2712
+ };
2713
+ static types(): {
2714
+ [key: string]: any;
2715
+ };
2716
+ constructor(map?: {
2717
+ [key: string]: any;
2718
+ });
2719
+ }
2720
+ export declare class CreateOrGetVirtualLicenseOrderRequest extends $tea.Model {
2721
+ /**
2722
+ * @remarks
2723
+ * This parameter is required.
2724
+ *
2725
+ * @example
2726
+ * PG
2727
+ */
2728
+ engine?: string;
2729
+ ownerAccount?: string;
2730
+ ownerId?: number;
2731
+ resourceOwnerAccount?: string;
2732
+ resourceOwnerId?: number;
2733
+ static names(): {
2734
+ [key: string]: string;
2735
+ };
2736
+ static types(): {
2737
+ [key: string]: any;
2738
+ };
2739
+ constructor(map?: {
2740
+ [key: string]: any;
2741
+ });
2742
+ }
2743
+ export declare class CreateOrGetVirtualLicenseOrderResponseBody extends $tea.Model {
2744
+ /**
2745
+ * @example
2746
+ * 1
2747
+ */
2748
+ activatedCodeCount?: number;
2749
+ /**
2750
+ * @example
2751
+ * 10
2752
+ */
2753
+ activationCodeQuota?: number;
2754
+ /**
2755
+ * @example
2756
+ * 2233****445566
2757
+ */
2758
+ aliyunOrderId?: string;
2759
+ /**
2760
+ * @example
2761
+ * false
2762
+ */
2763
+ allowEmptySystemIdentifier?: boolean;
2764
+ /**
2765
+ * @example
2766
+ * 2024-10-16 16:46:20
2767
+ */
2768
+ gmtCreated?: string;
2769
+ /**
2770
+ * @example
2771
+ * 2024-10-16 16:46:20
2772
+ */
2773
+ gmtModified?: string;
2774
+ /**
2775
+ * @example
2776
+ * true
2777
+ */
2778
+ isVirtualOrder?: boolean;
2779
+ /**
2780
+ * @example
2781
+ * false
2405
2782
  */
2406
- globalIgName?: string;
2407
- ownerAccount?: string;
2408
- ownerId?: number;
2783
+ isVirtualOrderFrozen?: boolean;
2409
2784
  /**
2410
- * @remarks
2411
- * The region ID.
2412
- *
2413
- * This parameter is required.
2414
- *
2415
2785
  * @example
2416
- * cn-hangzhou
2786
+ * pre_generation_long_term
2417
2787
  */
2418
- regionId?: string;
2788
+ packageType?: string;
2419
2789
  /**
2420
- * @remarks
2421
- * The ID of the resource group.
2422
- *
2423
2790
  * @example
2424
- * rg-************
2791
+ * 30 years
2425
2792
  */
2426
- resourceGroupId?: string;
2427
- resourceOwnerAccount?: string;
2428
- resourceOwnerId?: number;
2429
- securityToken?: string;
2430
- static names(): {
2431
- [key: string]: string;
2432
- };
2433
- static types(): {
2434
- [key: string]: any;
2435
- };
2436
- constructor(map?: {
2437
- [key: string]: any;
2438
- });
2439
- }
2440
- export declare class CreateGlobalSecurityIPGroupResponseBody extends $tea.Model {
2793
+ packageValidity?: string;
2441
2794
  /**
2442
- * @remarks
2443
- * The details of the global IP whitelist template.
2795
+ * @example
2796
+ * aliyun_market
2444
2797
  */
2445
- globalSecurityIPGroup?: CreateGlobalSecurityIPGroupResponseBodyGlobalSecurityIPGroup[];
2798
+ purchaseChannel?: string;
2446
2799
  /**
2447
2800
  * @remarks
2448
- * The ID of the request.
2801
+ * Id of the request
2449
2802
  *
2450
2803
  * @example
2451
- * 9B7BFB11-C077-4FE3-B051-F69CEB******
2804
+ * 45D24263-7E3A-4140-9472-************
2452
2805
  */
2453
2806
  requestId?: string;
2807
+ /**
2808
+ * @example
2809
+ * 2024********483
2810
+ */
2811
+ virtualOrderId?: string;
2454
2812
  static names(): {
2455
2813
  [key: string]: string;
2456
2814
  };
@@ -2461,12 +2819,12 @@ export declare class CreateGlobalSecurityIPGroupResponseBody extends $tea.Model
2461
2819
  [key: string]: any;
2462
2820
  });
2463
2821
  }
2464
- export declare class CreateGlobalSecurityIPGroupResponse extends $tea.Model {
2822
+ export declare class CreateOrGetVirtualLicenseOrderResponse extends $tea.Model {
2465
2823
  headers?: {
2466
2824
  [key: string]: string;
2467
2825
  };
2468
2826
  statusCode?: number;
2469
- body?: CreateGlobalSecurityIPGroupResponseBody;
2827
+ body?: CreateOrGetVirtualLicenseOrderResponseBody;
2470
2828
  static names(): {
2471
2829
  [key: string]: string;
2472
2830
  };
@@ -2932,11 +3290,11 @@ export declare class DeleteBackupResponse extends $tea.Model {
2932
3290
  export declare class DeleteDBClusterRequest extends $tea.Model {
2933
3291
  /**
2934
3292
  * @remarks
2935
- * The retention policy for the backup sets when you delete the cluster. Valid values:
3293
+ * The retention policy applied to the backup sets when the cluster is released. Valid values:
2936
3294
  *
2937
- * * **ALL**: permanently retains all backups.
2938
- * * **LATEST**: permanently retains the most recent backup. A backup is automatically created before you delete the cluster.
2939
- * * **NONE**: No backup sets are retained after you delete the cluster.
3295
+ * * **ALL**: permanently retains all backup sets.
3296
+ * * **LATEST**: permanently retains the most recent backup set that is automatically created before the cluster is released.
3297
+ * * **NONE**: does not retain backup sets.
2940
3298
  *
2941
3299
  * @example
2942
3300
  * NONE
@@ -3777,6 +4135,7 @@ export declare class DescribeAITaskStatusRequest extends $tea.Model {
3777
4135
  });
3778
4136
  }
3779
4137
  export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
4138
+ accountName?: string;
3780
4139
  /**
3781
4140
  * @remarks
3782
4141
  * The cluster ID.
@@ -3807,6 +4166,9 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
3807
4166
  /**
3808
4167
  * @remarks
3809
4168
  * The state description of the PolarDB for AI feature.
4169
+ *
4170
+ * @example
4171
+ * Closed State
3810
4172
  */
3811
4173
  statusName?: string;
3812
4174
  static names(): {
@@ -3946,6 +4308,203 @@ export declare class DescribeAccountsResponse extends $tea.Model {
3946
4308
  [key: string]: any;
3947
4309
  });
3948
4310
  }
4311
+ export declare class DescribeActivationCodeDetailsRequest extends $tea.Model {
4312
+ /**
4313
+ * @example
4314
+ * 123
4315
+ */
4316
+ activationCodeId?: number;
4317
+ /**
4318
+ * @remarks
4319
+ * This parameter is required.
4320
+ *
4321
+ * @example
4322
+ * 2233****445566
4323
+ */
4324
+ aliyunOrderId?: string;
4325
+ ownerAccount?: string;
4326
+ ownerId?: number;
4327
+ resourceOwnerAccount?: string;
4328
+ resourceOwnerId?: number;
4329
+ static names(): {
4330
+ [key: string]: string;
4331
+ };
4332
+ static types(): {
4333
+ [key: string]: any;
4334
+ };
4335
+ constructor(map?: {
4336
+ [key: string]: any;
4337
+ });
4338
+ }
4339
+ export declare class DescribeActivationCodeDetailsResponseBody extends $tea.Model {
4340
+ /**
4341
+ * @example
4342
+ * 2024-10-16 16:46:20
4343
+ */
4344
+ activateAt?: string;
4345
+ /**
4346
+ * @example
4347
+ * AAEAA******AAA=
4348
+ */
4349
+ certContentB64?: string;
4350
+ /**
4351
+ * @example
4352
+ * testCode
4353
+ */
4354
+ description?: string;
4355
+ /**
4356
+ * @example
4357
+ * 2054-10-09 16:46:20
4358
+ */
4359
+ expireAt?: string;
4360
+ /**
4361
+ * @example
4362
+ * 2024-10-16 16:46:20
4363
+ */
4364
+ gmtCreated?: string;
4365
+ /**
4366
+ * @example
4367
+ * 2024-10-16 16:46:20
4368
+ */
4369
+ gmtModified?: string;
4370
+ /**
4371
+ * @example
4372
+ * 123
4373
+ */
4374
+ id?: number;
4375
+ /**
4376
+ * @example
4377
+ * 12:34:56:78:98:00
4378
+ */
4379
+ macAddress?: string;
4380
+ /**
4381
+ * @example
4382
+ * testName
4383
+ */
4384
+ name?: string;
4385
+ /**
4386
+ * @remarks
4387
+ * Id of the request
4388
+ *
4389
+ * @example
4390
+ * F2A9EFA7-915F-4572-8299-85A307******
4391
+ */
4392
+ requestId?: string;
4393
+ /**
4394
+ * @example
4395
+ * 1234567890123456
4396
+ */
4397
+ systemIdentifier?: string;
4398
+ static names(): {
4399
+ [key: string]: string;
4400
+ };
4401
+ static types(): {
4402
+ [key: string]: any;
4403
+ };
4404
+ constructor(map?: {
4405
+ [key: string]: any;
4406
+ });
4407
+ }
4408
+ export declare class DescribeActivationCodeDetailsResponse extends $tea.Model {
4409
+ headers?: {
4410
+ [key: string]: string;
4411
+ };
4412
+ statusCode?: number;
4413
+ body?: DescribeActivationCodeDetailsResponseBody;
4414
+ static names(): {
4415
+ [key: string]: string;
4416
+ };
4417
+ static types(): {
4418
+ [key: string]: any;
4419
+ };
4420
+ constructor(map?: {
4421
+ [key: string]: any;
4422
+ });
4423
+ }
4424
+ export declare class DescribeActivationCodesRequest extends $tea.Model {
4425
+ /**
4426
+ * @remarks
4427
+ * This parameter is required.
4428
+ *
4429
+ * @example
4430
+ * 2233****445566
4431
+ */
4432
+ aliyunOrderId?: string;
4433
+ ownerAccount?: string;
4434
+ ownerId?: number;
4435
+ /**
4436
+ * @example
4437
+ * 1
4438
+ */
4439
+ pageNumber?: number;
4440
+ /**
4441
+ * @example
4442
+ * 30
4443
+ */
4444
+ pageSize?: number;
4445
+ resourceOwnerAccount?: string;
4446
+ resourceOwnerId?: number;
4447
+ static names(): {
4448
+ [key: string]: string;
4449
+ };
4450
+ static types(): {
4451
+ [key: string]: any;
4452
+ };
4453
+ constructor(map?: {
4454
+ [key: string]: any;
4455
+ });
4456
+ }
4457
+ export declare class DescribeActivationCodesResponseBody extends $tea.Model {
4458
+ items?: DescribeActivationCodesResponseBodyItems[];
4459
+ /**
4460
+ * @example
4461
+ * 1
4462
+ */
4463
+ pageNumber?: number;
4464
+ /**
4465
+ * @example
4466
+ * 1
4467
+ */
4468
+ pageRecordCount?: number;
4469
+ /**
4470
+ * @remarks
4471
+ * Id of the request
4472
+ *
4473
+ * @example
4474
+ * 65D7ACE6-4A61-4B6E-B357-8CB24A******
4475
+ */
4476
+ requestId?: string;
4477
+ /**
4478
+ * @example
4479
+ * 1
4480
+ */
4481
+ totalRecordCount?: number;
4482
+ static names(): {
4483
+ [key: string]: string;
4484
+ };
4485
+ static types(): {
4486
+ [key: string]: any;
4487
+ };
4488
+ constructor(map?: {
4489
+ [key: string]: any;
4490
+ });
4491
+ }
4492
+ export declare class DescribeActivationCodesResponse extends $tea.Model {
4493
+ headers?: {
4494
+ [key: string]: string;
4495
+ };
4496
+ statusCode?: number;
4497
+ body?: DescribeActivationCodesResponseBody;
4498
+ static names(): {
4499
+ [key: string]: string;
4500
+ };
4501
+ static types(): {
4502
+ [key: string]: any;
4503
+ };
4504
+ constructor(map?: {
4505
+ [key: string]: any;
4506
+ });
4507
+ }
3949
4508
  export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
3950
4509
  /**
3951
4510
  * @remarks
@@ -4982,9 +5541,8 @@ export declare class DescribeDBClusterAccessWhitelistResponse extends $tea.Model
4982
5541
  export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
4983
5542
  /**
4984
5543
  * @remarks
4985
- * The ID of cluster.
4986
- *
4987
- * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.
5544
+ * Cluster ID.
5545
+ * > You can view detailed information about all clusters under your account, including the cluster ID, through the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) interface.
4988
5546
  *
4989
5547
  * This parameter is required.
4990
5548
  *
@@ -4994,7 +5552,7 @@ export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
4994
5552
  DBClusterId?: string;
4995
5553
  /**
4996
5554
  * @remarks
4997
- * Specifies whether to query information about AI-related nodes.
5555
+ * Whether to obtain information about AI-related nodes.
4998
5556
  *
4999
5557
  * @example
5000
5558
  * AI
@@ -5016,29 +5574,37 @@ export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
5016
5574
  }
5017
5575
  export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5018
5576
  /**
5577
+ * @remarks
5578
+ * Start time for free AI activation
5579
+ *
5019
5580
  * @example
5020
5581
  * 2024-03-13T01:20:28Z
5021
5582
  */
5022
5583
  aiCreatingTime?: string;
5023
5584
  /**
5024
5585
  * @remarks
5025
- * The information status of the AI node. Valid values:
5586
+ * Types of AI nodes. Values include:
5026
5587
  *
5027
- * * SearchNode: search node.
5028
- * * DLNode: AI node
5588
+ * - **SearchNode**: Search node.
5589
+ * - **DLNode**: AI node.
5029
5590
  *
5030
5591
  * @example
5031
5592
  * DLNode
5032
5593
  */
5033
5594
  aiType?: string;
5034
5595
  /**
5596
+ * @remarks
5597
+ * CPU architecture. Available options are:
5598
+ * - **X86**
5599
+ * - **ARM**
5600
+ *
5035
5601
  * @example
5036
5602
  * X86
5037
5603
  */
5038
5604
  architecture?: string;
5039
5605
  /**
5040
5606
  * @remarks
5041
- * Maximum blktags in file system.
5607
+ * Maximum number of blktags in the file system.
5042
5608
  *
5043
5609
  * @example
5044
5610
  * 7,864,320
@@ -5046,7 +5612,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5046
5612
  blktagTotal?: number;
5047
5613
  /**
5048
5614
  * @remarks
5049
- * The current blktag usage.
5615
+ * Current blktag usage.
5050
5616
  *
5051
5617
  * @example
5052
5618
  * 5,242,880
@@ -5054,35 +5620,43 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5054
5620
  blktagUsed?: number;
5055
5621
  /**
5056
5622
  * @remarks
5057
- * [The edition of PolarDB](https://help.aliyun.com/document_detail/183258.html). Valid values:
5058
- *
5059
- * * **Normal**: Cluster Edition.
5060
- * * **Basic**: Single Node Edition.
5061
- * * **Archive**: X-Engine Edition.
5062
- * * **NormalMultimaster**: Multi-master Cluster Edition.
5063
- * * **SENormal**: Standard Edition.
5623
+ * [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
5624
+ * * **Normal**: Cluster Edition
5625
+ * * **Basic**: Single Node
5626
+ * * **Archive**: High Compression Engine (X-Engine)
5627
+ * * **NormalMultimaster**: Multi-Master Cluster Edition
5628
+ * * **SENormal**: Standard Edition
5064
5629
  *
5065
- * >- Only PolarDB for MySQL supports Single Node Edition.
5066
- * >- Only PolarDB for MySQL 8.0.1 supports Standard Edition.
5067
- * >- Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster Edition.
5630
+ * > * PolarDB PostgreSQL version 11 does not support single-node.
5631
+ * >* PolarDB MySQL versions 8.0 and 5.7, and PolarDB PostgreSQL version 14 support the Standard Edition.
5632
+ * >* PolarDB MySQL version 8.0 supports High Compression Engine (X-Engine) and Multi-Master Cluster Edition.
5068
5633
  *
5069
5634
  * @example
5070
5635
  * Normal
5071
5636
  */
5072
5637
  category?: string;
5073
5638
  /**
5639
+ * @remarks
5640
+ * Whether storage compression is enabled. Values are as follows:
5641
+ * - ON: Enabled
5642
+ * - OFF: Disabled
5643
+ *
5074
5644
  * @example
5075
5645
  * ON
5076
5646
  */
5077
5647
  compressStorageMode?: string;
5078
5648
  /**
5649
+ * @remarks
5650
+ * Compressed storage data size.
5651
+ * > This parameter is supported only when the cluster\\"s storage compression feature is enabled.
5652
+ *
5079
5653
  * @example
5080
5654
  * 15529410560
5081
5655
  */
5082
5656
  compressStorageUsed?: number;
5083
5657
  /**
5084
5658
  * @remarks
5085
- * The time when the cluster was created.
5659
+ * Cluster creation time.
5086
5660
  *
5087
5661
  * @example
5088
5662
  * 2020-08-14T05:58:42Z
@@ -5090,7 +5664,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5090
5664
  creationTime?: string;
5091
5665
  /**
5092
5666
  * @remarks
5093
- * The description of the cluster.
5667
+ * Cluster description.
5094
5668
  *
5095
5669
  * @example
5096
5670
  * test
@@ -5098,7 +5672,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5098
5672
  DBClusterDescription?: string;
5099
5673
  /**
5100
5674
  * @remarks
5101
- * The ID of cluster.
5675
+ * Cluster ID.
5102
5676
  *
5103
5677
  * @example
5104
5678
  * pc-*****************
@@ -5106,7 +5680,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5106
5680
  DBClusterId?: string;
5107
5681
  /**
5108
5682
  * @remarks
5109
- * The network type of the cluster.
5683
+ * Network type of the cluster.
5110
5684
  *
5111
5685
  * @example
5112
5686
  * VPC
@@ -5114,7 +5688,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5114
5688
  DBClusterNetworkType?: string;
5115
5689
  /**
5116
5690
  * @remarks
5117
- * The status of the cluster. For information about the valid values, see [Cluster states](https://help.aliyun.com/document_detail/99286.html).
5691
+ * Cluster status. For the full list of values, refer to [Cluster Status Table](https://help.aliyun.com/document_detail/99286.html).
5118
5692
  *
5119
5693
  * @example
5120
5694
  * Running
@@ -5127,7 +5701,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5127
5701
  DBNodes?: DescribeDBClusterAttributeResponseBodyDBNodes[];
5128
5702
  /**
5129
5703
  * @remarks
5130
- * The type of the database engine.
5704
+ * Database engine type.
5131
5705
  *
5132
5706
  * @example
5133
5707
  * MySQL
@@ -5135,7 +5709,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5135
5709
  DBType?: string;
5136
5710
  /**
5137
5711
  * @remarks
5138
- * The version of the database engine.
5712
+ * Database engine version.
5139
5713
  *
5140
5714
  * @example
5141
5715
  * 8.0
@@ -5146,10 +5720,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5146
5720
  * The status of the minor version. Valid values:
5147
5721
  *
5148
5722
  * * **Stable**: The minor version is stable.
5149
- * * **Old**: The minor version is outdated. We recommend that you upgrade the cluster to the latest version.
5150
- * * **HighRisk**: The minor version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.
5723
+ * * **Old**: The minor version is outdated. We recommend that you update it to the latest version.
5724
+ * * **HighRisk**: The minor version has critical defects. We recommend that you immediately update it to the latest version.
5725
+ * * **Beta**: The minor version is a Beta version.
5151
5726
  *
5152
- * > For more information about how to upgrade the minor version, see [Upgrade versions](https://help.aliyun.com/document_detail/158572.html).
5727
+ * > For information about how to update the minor version, see [Minor version update](https://help.aliyun.com/document_detail/158572.html).
5153
5728
  *
5154
5729
  * @example
5155
5730
  * Stable
@@ -5157,7 +5732,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5157
5732
  DBVersionStatus?: string;
5158
5733
  /**
5159
5734
  * @remarks
5160
- * The total physical storage of level-1 backups (snapshots). Unit: bytes.
5735
+ * Total size of Level 1 backups (snapshots), in bytes.
5161
5736
  *
5162
5737
  * @example
5163
5738
  * 74448896
@@ -5165,7 +5740,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5165
5740
  dataLevel1BackupChainSize?: number;
5166
5741
  /**
5167
5742
  * @remarks
5168
- * Indicates the rule of data replication. Valid values: AsyncSync: asynchronous. SemiSync: semi-synchronous.
5743
+ * Data replication relationship mode. Values are as follows:
5744
+ * - **AsyncSync**: Asynchronous
5745
+ * - **SemiSync**: Semi-synchronous
5169
5746
  *
5170
5747
  * @example
5171
5748
  * AsyncSync
@@ -5173,10 +5750,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5173
5750
  dataSyncMode?: string;
5174
5751
  /**
5175
5752
  * @remarks
5176
- * Indicates whether the cluster is locked and can be deleted. Valid values:
5177
- *
5178
- * * **0**: The cluster is not locked and can be deleted.
5179
- * * **1**: The cluster is locked and cannot be deleted.
5753
+ * Lock status for cluster deletion, with values as follows:
5754
+ * * **0**: Unlocked, cluster can be deleted.
5755
+ * * **1**: Locked, cluster cannot be deleted.
5180
5756
  *
5181
5757
  * @example
5182
5758
  * 0
@@ -5184,7 +5760,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5184
5760
  deletionLock?: number;
5185
5761
  /**
5186
5762
  * @remarks
5187
- * The database type.
5763
+ * Cluster engine.
5188
5764
  *
5189
5765
  * @example
5190
5766
  * POLARDB
@@ -5192,9 +5768,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5192
5768
  engine?: string;
5193
5769
  /**
5194
5770
  * @remarks
5195
- * The time when the cluster expires.
5771
+ * Cluster expiration time.
5196
5772
  *
5197
- * > A specific value will be returned only for subscription (**Prepaid**) clusters. For pay-as-you-go (**Postpaid**) clusters, an empty string will be returned.
5773
+ * > Only clusters with **Prepaid** (subscription) payment methods return specific parameter values; **Postpaid** (pay-as-you-go) clusters return empty values.
5198
5774
  *
5199
5775
  * @example
5200
5776
  * 2020-11-14T16:00:00Z
@@ -5202,9 +5778,8 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5202
5778
  expireTime?: string;
5203
5779
  /**
5204
5780
  * @remarks
5205
- * Indicates whether the cluster has expired. Valid values:
5206
- *
5207
- * > This parameter is returned only for subscription (**Prepaid**) clusters.
5781
+ * Whether the cluster has expired.
5782
+ * > This parameter is only supported for clusters with **Prepaid** (Subscription) payment methods.
5208
5783
  *
5209
5784
  * @example
5210
5785
  * false
@@ -5212,20 +5787,28 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5212
5787
  expired?: string;
5213
5788
  /**
5214
5789
  * @remarks
5215
- * Indicates whether to replenish resources for the primary database after a cross-zone switchover. Valid values: true false
5790
+ * Whether to replenish resources for the new primary after cross-AZ switch. Values are as follows:
5791
+ * - **true**: Yes
5792
+ * - **false**: No
5216
5793
  *
5217
5794
  * @example
5218
5795
  * false
5219
5796
  */
5220
5797
  hasCompleteStandbyRes?: boolean;
5221
5798
  /**
5799
+ * @remarks
5800
+ * Whether to enable storage hot backup cluster (and Standby compute nodes). Values are as follows:
5801
+ * - **StandbyClusterON**: Enable storage hot backup/Enable storage hot backup and Standby compute nodes.
5802
+ * - **StandbyClusterOFF**: Disable storage hot backup/Disable storage hot backup and Standby compute nodes.
5803
+ *
5222
5804
  * @example
5223
5805
  * StandbyClusterON
5224
5806
  */
5225
5807
  hotStandbyCluster?: string;
5808
+ imciAutoIndex?: string;
5226
5809
  /**
5227
5810
  * @remarks
5228
- * Maximum inodes in file system.
5811
+ * Maximum number of inodes in the file system.
5229
5812
  *
5230
5813
  * @example
5231
5814
  * 6,291,456
@@ -5233,7 +5816,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5233
5816
  inodeTotal?: number;
5234
5817
  /**
5235
5818
  * @remarks
5236
- * The current inode usage.
5819
+ * Current inode usage.
5237
5820
  *
5238
5821
  * @example
5239
5822
  * 4,194,304
@@ -5241,10 +5824,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5241
5824
  inodeUsed?: number;
5242
5825
  /**
5243
5826
  * @remarks
5244
- * Indicates whether the kernel is of the latest version. Valid values:
5827
+ * Indicates whether it is the latest kernel version. Values are as follows:
5245
5828
  *
5246
- * * **true**
5247
- * * **false**
5829
+ * - **true**: Yes
5830
+ *
5831
+ * - **false**: No
5248
5832
  *
5249
5833
  * @example
5250
5834
  * false
@@ -5252,10 +5836,10 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5252
5836
  isLatestVersion?: boolean;
5253
5837
  /**
5254
5838
  * @remarks
5255
- * Indicates whether PolarProxy uses the latest version. Valid values:
5839
+ * Indicates whether it is the latest version of the database proxy, with possible values as follows:
5256
5840
  *
5257
- * * **true**
5258
- * * **false**
5841
+ * - **true**: Yes
5842
+ * - **false**: No
5259
5843
  *
5260
5844
  * @example
5261
5845
  * false
@@ -5263,11 +5847,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5263
5847
  isProxyLatestVersion?: boolean;
5264
5848
  /**
5265
5849
  * @remarks
5266
- * The lock mode. Valid values:
5850
+ * Lock mode. Possible values are as follows:
5267
5851
  *
5268
- * * **Unlock**: The cluster is not locked.
5269
- * * **ManualLock**: The cluster is manually locked.
5270
- * * **LockByExpiration**: The cluster is automatically locked due to cluster expiration.
5852
+ * - **Unlock**: Unlocked.
5853
+ * - **ManualLock**: Manually triggered lock.
5854
+ * - **LockByExpiration**: Automatic cluster lock upon expiration.
5271
5855
  *
5272
5856
  * @example
5273
5857
  * Unlock
@@ -5275,36 +5859,46 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5275
5859
  lockMode?: string;
5276
5860
  /**
5277
5861
  * @remarks
5278
- * The maintenance window of the cluster. The format is `HH:mmZ-HH:mmZ`. The time is displayed in UTC. For example, the value `16:00Z-17:00Z` indicates that the cluster can be maintained from 00:00 to 01:00 (UTC+08:00).
5862
+ * The maintenance window for the cluster, formatted as `HH:mmZ-HH:mmZ` (UTC time). For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 0:00 to 1:00 (UTC+08:00).
5279
5863
  *
5280
5864
  * @example
5281
5865
  * 18:00Z-19:00Z
5282
5866
  */
5283
5867
  maintainTime?: string;
5284
5868
  /**
5869
+ * @remarks
5870
+ * Orca function with possible values as follows:
5871
+ *
5872
+ * - **on**: Enabled
5873
+ *
5874
+ * - **off**: Disabled
5875
+ *
5285
5876
  * @example
5286
5877
  * ON
5287
5878
  */
5288
5879
  orca?: string;
5289
5880
  /**
5290
5881
  * @remarks
5291
- * The billing method of the cluster. Valid values:
5882
+ * Payment type. Possible values are:
5292
5883
  *
5293
- * * **Postpaid**: pay-as-you-go.
5294
- * * **Prepaid**: subscription
5884
+ * - **Postpaid**: Pay-As-You-Go
5885
+ * - **Prepaid**: Prepaid (Subscription).
5295
5886
  *
5296
5887
  * @example
5297
5888
  * Prepaid
5298
5889
  */
5299
5890
  payType?: string;
5300
5891
  /**
5892
+ * @remarks
5893
+ * Describes the preconfigured read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity - baseline performance}.<br>Baseline performance = min{1,800 + 50*capacity, 50000}.<br>Note: This parameter is supported only when StorageType is ESSDAUTOPL.
5894
+ *
5301
5895
  * @example
5302
5896
  * 2500
5303
5897
  */
5304
5898
  provisionedIops?: string;
5305
5899
  /**
5306
5900
  * @remarks
5307
- * The number of CPU cores for PolarProxy.
5901
+ * Number of CPU cores for the database proxy.
5308
5902
  *
5309
5903
  * @example
5310
5904
  * 4
@@ -5312,7 +5906,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5312
5906
  proxyCpuCores?: string;
5313
5907
  /**
5314
5908
  * @remarks
5315
- * The type of the serverless PolarProxy. Valid value: AgileServerless.
5909
+ * Serverless type for the database proxy. Currently, the value is fixed to AgileServerless.
5316
5910
  *
5317
5911
  * @example
5318
5912
  * AgileServerless
@@ -5320,7 +5914,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5320
5914
  proxyServerlessType?: string;
5321
5915
  /**
5322
5916
  * @remarks
5323
- * The number of CPU cores for PolarProxy Standard Enterprise Edition.
5917
+ * Standard configuration CPU cores for the database proxy.
5324
5918
  *
5325
5919
  * @example
5326
5920
  * 2
@@ -5328,19 +5922,19 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5328
5922
  proxyStandardCpuCores?: string;
5329
5923
  /**
5330
5924
  * @remarks
5331
- * The status of PolarProxy. Valid values:
5925
+ * Status of the database proxy. Possible values include:
5332
5926
  *
5333
- * * **Creating**: PolarProxy is being created.
5334
- * * **Running**: PolarProxy is running.
5335
- * * **Deleting**: PolarProxy is being released.
5336
- * * **Rebooting**: PolarProxy is restarting.
5337
- * * **DBNodeCreating**: PolarProxy is being added.
5338
- * * **DBNodeDeleting**: PolarProxy is being deleted.
5339
- * * **ClassChanging**: The specifications of PolarProxy are being changed.
5340
- * * **NetAddressCreating**: The network connection is being created.
5341
- * * **NetAddressDeleting**: The network connection is being deleted.
5342
- * * **NetAddressModifying**: The network connection is being modified.
5343
- * * **Deleted**: PolarProxy is released.
5927
+ * - **Creating**: Creating
5928
+ * - **Running**: Running
5929
+ * - **Deleting**: Releasing
5930
+ * - **Rebooting**: Restarting
5931
+ * - **DBNodeCreating**: Adding nodes
5932
+ * - **DBNodeDeleting**: Deleting nodes
5933
+ * - **ClassChanging**: Changing node specifications
5934
+ * - **NetAddressCreating**: Creating network connections
5935
+ * - **NetAddressDeleting**: Deleting network connections
5936
+ * - **NetAddressModifying**: Modifying network connections
5937
+ * - **Deleted**: Released
5344
5938
  *
5345
5939
  * @example
5346
5940
  * Running
@@ -5348,10 +5942,10 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5348
5942
  proxyStatus?: string;
5349
5943
  /**
5350
5944
  * @remarks
5351
- * The type of PolarProxy. Valid values:
5945
+ * Database proxy types, with the following values:
5352
5946
  *
5353
- * * **Exclusive**: Dedicated Enterprise Edition
5354
- * * **General**: Standard Enterprise Edition
5947
+ * - **Exclusive**: Enterprise Exclusive Edition
5948
+ * - **General**: Enterprise General Purpose Edition
5355
5949
  *
5356
5950
  * @example
5357
5951
  * Exclusive
@@ -5359,7 +5953,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5359
5953
  proxyType?: string;
5360
5954
  /**
5361
5955
  * @remarks
5362
- * The region ID of the security group.
5956
+ * Region ID.
5363
5957
  *
5364
5958
  * @example
5365
5959
  * cn-hangzhou
@@ -5367,7 +5961,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5367
5961
  regionId?: string;
5368
5962
  /**
5369
5963
  * @remarks
5370
- * The ID of the request.
5964
+ * Request ID.
5371
5965
  *
5372
5966
  * @example
5373
5967
  * 074467EF-86B9-4C23-ACBF-E9B81A******
@@ -5375,25 +5969,34 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5375
5969
  requestId?: string;
5376
5970
  /**
5377
5971
  * @remarks
5378
- * The ID of your Alibaba Cloud resource group.
5972
+ * Resource group ID.
5379
5973
  *
5380
5974
  * @example
5381
5975
  * rg-***************
5382
5976
  */
5383
5977
  resourceGroupId?: string;
5384
5978
  /**
5979
+ * @remarks
5980
+ * If RestoreType is **RestoreByTime** or **RestoreByTimeOss**, this value represents the recovery time point. If RestoreType is **RestoreByBackupSet** or **RestoreByBackupSetOss**, this value indicates the ID of the backup set on which the recovery is based.
5981
+ * <note>Only clusters restored from a backup set or time point after June 1, 2024, support this parameter.</note>
5982
+ *
5385
5983
  * @example
5386
5984
  * 2179639137
5387
5985
  */
5388
5986
  restoreDataPoint?: string;
5389
5987
  /**
5988
+ * @remarks
5989
+ * Cluster recovery method, with possible values:
5990
+ * * **RestoreByTime**: Restore from a time point based on primary backup. * **RestoreByBackupSet**: Restore from a backup set based on primary backup. * **RestoreByTimeOss**: Restore from a time point based on secondary backup. * **RestoreByBackupSetOss**: Restore from a backup set based on secondary backup. * **CloneFromSourceCluster**: Clone from the source cluster.
5991
+ * <note>This parameter is only supported for clusters restored from a backup set or time point after June 1, 2024.</note>
5992
+ *
5390
5993
  * @example
5391
5994
  * RestoreByTime
5392
5995
  */
5393
5996
  restoreType?: string;
5394
5997
  /**
5395
5998
  * @remarks
5396
- * The storage of SQL. Unit: bytes. If the value is -1, no data is stored.
5999
+ * Storage amount of SQL, in bytes. If the value is -1, it indicates no data.
5397
6000
  *
5398
6001
  * @example
5399
6002
  * 0
@@ -5401,21 +6004,37 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5401
6004
  SQLSize?: number;
5402
6005
  /**
5403
6006
  * @remarks
5404
- * The type of the serverless cluster. Only **AgileServerless** can be returned.
6007
+ * Serverless type. Valid values are as follows:
6008
+ * - AgileServerless: Agile - SteadyServerless: Stable
5405
6009
  *
5406
6010
  * @example
5407
6011
  * AgileServerless
5408
6012
  */
5409
6013
  serverlessType?: string;
5410
6014
  /**
6015
+ * @remarks
6016
+ * Source cluster ID. <note>Clusters restored from backup sets or specific points in time after June 1, 2024, support this parameter.</note>
6017
+ *
5411
6018
  * @example
5412
6019
  * pc-pz51ziv48317b2880
5413
6020
  */
5414
6021
  sourceDBCluster?: string;
6022
+ /**
6023
+ * @remarks
6024
+ * The region ID of the source cluster.
6025
+ *
6026
+ * > This parameter is returned only if the source cluster ID exists.
6027
+ *
6028
+ * @example
6029
+ * cn-beijing
6030
+ */
5415
6031
  sourceRegionId?: string;
5416
6032
  /**
5417
6033
  * @remarks
5418
- * Indicates whether the cross-zone disaster recovery feature is enabled. Valid values: ON OFF 0: Customer Drill Mode
6034
+ * Cross-AZ disaster recovery mode. Values are as follows:
6035
+ * - **ON**: Enable cross-AZ disaster recovery mode.
6036
+ * - **OFF**: Disable cross-AZ disaster recovery mode.
6037
+ * - **0**: Customer drill mode.
5419
6038
  *
5420
6039
  * @example
5421
6040
  * OFF
@@ -5423,7 +6042,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5423
6042
  standbyHAMode?: string;
5424
6043
  /**
5425
6044
  * @remarks
5426
- * The maximum storage capacity of the current cluster specification. Unit: bytes.
6045
+ * The maximum storage capacity of the current cluster specification, in bytes.
5427
6046
  *
5428
6047
  * @example
5429
6048
  * 10995116277760
@@ -5431,10 +6050,8 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5431
6050
  storageMax?: number;
5432
6051
  /**
5433
6052
  * @remarks
5434
- * The billing method of the storage. Valid values:
5435
- *
5436
- * * **Postpaid**: pay-as-you-go
5437
- * * **Prepaid**: subscription.
6053
+ * Storage billing type. Valid values are as follows:
6054
+ * - **Postpaid**:Pay-as-you-go (by capacity). - **Prepaid**:Subscription (by space).
5438
6055
  *
5439
6056
  * @example
5440
6057
  * Prepaid
@@ -5442,7 +6059,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5442
6059
  storagePayType?: string;
5443
6060
  /**
5444
6061
  * @remarks
5445
- * The storage space that uses the subscription billing method. Unit: bytes.
6062
+ * Storage space for pay-by-space (subscription) billing. Unit: Byte.
5446
6063
  *
5447
6064
  * @example
5448
6065
  * 50
@@ -5450,7 +6067,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5450
6067
  storageSpace?: number;
5451
6068
  /**
5452
6069
  * @remarks
5453
- * The storage type. Set the value to **HighPerformance**.
6070
+ * Storage type, with a fixed value of **HighPerformance**.
5454
6071
  *
5455
6072
  * @example
5456
6073
  * HighPerformance
@@ -5458,7 +6075,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5458
6075
  storageType?: string;
5459
6076
  /**
5460
6077
  * @remarks
5461
- * The storage space consumed by the cluster. Unit: bytes.
6078
+ * Amount of used storage space, in bytes.
5462
6079
  *
5463
6080
  * @example
5464
6081
  * 3012558848
@@ -5466,10 +6083,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5466
6083
  storageUsed?: number;
5467
6084
  /**
5468
6085
  * @remarks
5469
- * Indicates whether the multi-zone data consistency feature is enabled for the cluster. Valid values:
5470
- *
5471
- * * **ON**: Multi-zone data consistency is enabled, which is suitable for Standard Edition clusters that run Multi-zone Edition.
5472
- * * **OFF**
6086
+ * Indicates whether multi-AZ data strong consistency is enabled for the cluster. The value ranges are as follows:
6087
+ * - **ON**: Indicates that multi-AZ data strong consistency is enabled, applicable to the Standard 3AZ scenario.
6088
+ * - **OFF**: Indicates that multi-AZ data strong consistency is not enabled.
5473
6089
  *
5474
6090
  * @example
5475
6091
  * ON
@@ -5477,26 +6093,32 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5477
6093
  strictConsistency?: string;
5478
6094
  /**
5479
6095
  * @remarks
5480
- * The specification type of the compute node. Valid values:
5481
- *
5482
- * * **Exclusive**: dedicated.
5483
- * * **General**: general-purpose.
6096
+ * Specification type of compute nodes, with possible values as follows:
6097
+ * * **Exclusive**: Dedicated specification
6098
+ * * **General**: General-purpose specification
5484
6099
  *
5485
- * > This parameter is supported only for PolarDB for MySQL clusters of Cluster Edition.
6100
+ * > This parameter is supported only for PolarDB MySQL Edition with the product series set to Cluster Edition.
5486
6101
  *
5487
6102
  * @example
5488
6103
  * Exclusive
5489
6104
  */
5490
6105
  subCategory?: string;
6106
+ /**
6107
+ * @remarks
6108
+ * Indicates whether the failover with hot replica feature is supported if the cluster has In-Memory Column Index (IMCI) nodes.
6109
+ *
6110
+ * @example
6111
+ * ON
6112
+ */
5491
6113
  supportInstantSwitchWithImci?: string;
5492
6114
  /**
5493
6115
  * @remarks
5494
- * Details about the tags.
6116
+ * Details of tags.
5495
6117
  */
5496
6118
  tags?: DescribeDBClusterAttributeResponseBodyTags[];
5497
6119
  /**
5498
6120
  * @remarks
5499
- * The VPC ID of the cluster.
6121
+ * VPC ID.
5500
6122
  *
5501
6123
  * @example
5502
6124
  * vpc-*******************
@@ -5504,7 +6126,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5504
6126
  VPCId?: string;
5505
6127
  /**
5506
6128
  * @remarks
5507
- * The vSwitch ID of the cluster.
6129
+ * VSwitch ID.
5508
6130
  *
5509
6131
  * @example
5510
6132
  * vsw-*********************
@@ -5512,7 +6134,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
5512
6134
  vSwitchId?: string;
5513
6135
  /**
5514
6136
  * @remarks
5515
- * The zone ID of the cluster.
6137
+ * Availability Zone IDs.
5516
6138
  *
5517
6139
  * @example
5518
6140
  * cn-hangzhou-i,cn-hangzhou-g
@@ -5904,7 +6526,7 @@ export declare class DescribeDBClusterEndpointsRequest extends $tea.Model {
5904
6526
  export declare class DescribeDBClusterEndpointsResponseBody extends $tea.Model {
5905
6527
  /**
5906
6528
  * @remarks
5907
- * The details of the endpoints.
6529
+ * The information about the endpoints.
5908
6530
  */
5909
6531
  items?: DescribeDBClusterEndpointsResponseBodyItems[];
5910
6532
  /**
@@ -6372,6 +6994,13 @@ export declare class DescribeDBClusterPerformanceRequest extends $tea.Model {
6372
6994
  * 2020-09-23T01:01Z
6373
6995
  */
6374
6996
  startTime?: string;
6997
+ /**
6998
+ * @remarks
6999
+ * The Query Type
7000
+ *
7001
+ * @example
7002
+ * orca
7003
+ */
6375
7004
  type?: string;
6376
7005
  static names(): {
6377
7006
  [key: string]: string;
@@ -6696,6 +7325,19 @@ export declare class DescribeDBClusterTDERequest extends $tea.Model {
6696
7325
  });
6697
7326
  }
6698
7327
  export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
7328
+ /**
7329
+ * @remarks
7330
+ * Indicates whether automatic key rotation is allowed. Valid values:
7331
+ *
7332
+ * * **Enabled**: Automatic key rotation is allowed.
7333
+ * * **Disabled**: Automatic key rotation is not allowed.
7334
+ *
7335
+ * > This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.
7336
+ *
7337
+ * @example
7338
+ * Enabled
7339
+ */
7340
+ automaticRotation?: string;
6699
7341
  /**
6700
7342
  * @remarks
6701
7343
  * The ID of the cluster.
@@ -6711,6 +7353,8 @@ export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
6711
7353
  * * **ON**
6712
7354
  * * **OFF**
6713
7355
  *
7356
+ * > This parameter is returned only for a PolarDB for MySQL cluster.
7357
+ *
6714
7358
  * @example
6715
7359
  * ON
6716
7360
  */
@@ -6731,6 +7375,18 @@ export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
6731
7375
  * E37D1508-EC3B-4E06-A24A-C7AC31******
6732
7376
  */
6733
7377
  requestId?: string;
7378
+ /**
7379
+ * @remarks
7380
+ * The automatic key rotation period configured in Key Management Service (KMS). If no automatic key rotation period is configured, 0s is returned. Unit: seconds.
7381
+ *
7382
+ * For example, if the rotation period is set to 7 days, 604800s is returned.
7383
+ *
7384
+ * > This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster whose AutomaticRotation parameter is set to Enabled.
7385
+ *
7386
+ * @example
7387
+ * 604800s
7388
+ */
7389
+ rotationInterval?: string;
6734
7390
  /**
6735
7391
  * @remarks
6736
7392
  * The region where the TDE key resides.
@@ -6852,6 +7508,10 @@ export declare class DescribeDBClusterVersionResponseBody extends $tea.Model {
6852
7508
  * 8.0.1.1.7
6853
7509
  */
6854
7510
  DBRevisionVersion?: string;
7511
+ /**
7512
+ * @remarks
7513
+ * The versions to which the cluster can be upgraded.
7514
+ */
6855
7515
  DBRevisionVersionList?: DescribeDBClusterVersionResponseBodyDBRevisionVersionList[];
6856
7516
  /**
6857
7517
  * @remarks
@@ -7060,7 +7720,7 @@ export declare class DescribeDBClustersRequest extends $tea.Model {
7060
7720
  ownerId?: number;
7061
7721
  /**
7062
7722
  * @remarks
7063
- * The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.
7723
+ * The page number. The value must be an integer that is greater than 0. Default value: **1**.
7064
7724
  *
7065
7725
  * @example
7066
7726
  * 10
@@ -7068,7 +7728,7 @@ export declare class DescribeDBClustersRequest extends $tea.Model {
7068
7728
  pageNumber?: number;
7069
7729
  /**
7070
7730
  * @remarks
7071
- * The number of entries per page. Valid values: **30**, **50**, or **100**.
7731
+ * The number of entries per page. Valid values: **30**, **50**, and **100**.
7072
7732
  *
7073
7733
  * Default value: **30**.
7074
7734
  *
@@ -7845,6 +8505,15 @@ export declare class DescribeDBProxyPerformanceRequest extends $tea.Model {
7845
8505
  * pe-****************
7846
8506
  */
7847
8507
  DBEndpointId?: string;
8508
+ /**
8509
+ * @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.
8513
+ *
8514
+ * @example
8515
+ * pi-******************
8516
+ */
7848
8517
  DBNodeId?: string;
7849
8518
  /**
7850
8519
  * @remarks
@@ -8458,6 +9127,13 @@ export declare class DescribeGlobalDatabaseNetworkResponseBody extends $tea.Mode
8458
9127
  * active
8459
9128
  */
8460
9129
  GDNStatus?: string;
9130
+ /**
9131
+ * @remarks
9132
+ * The global domain name.
9133
+ *
9134
+ * @example
9135
+ * [gdnid].gdn.rds.aliyuncs.com
9136
+ */
8461
9137
  globalDomainName?: string;
8462
9138
  /**
8463
9139
  * @remarks
@@ -8632,12 +9308,186 @@ export declare class DescribeGlobalDatabaseNetworksResponseBody extends $tea.Mod
8632
9308
  [key: string]: any;
8633
9309
  });
8634
9310
  }
8635
- export declare class DescribeGlobalDatabaseNetworksResponse extends $tea.Model {
9311
+ export declare class DescribeGlobalDatabaseNetworksResponse extends $tea.Model {
9312
+ headers?: {
9313
+ [key: string]: string;
9314
+ };
9315
+ statusCode?: number;
9316
+ body?: DescribeGlobalDatabaseNetworksResponseBody;
9317
+ static names(): {
9318
+ [key: string]: string;
9319
+ };
9320
+ static types(): {
9321
+ [key: string]: any;
9322
+ };
9323
+ constructor(map?: {
9324
+ [key: string]: any;
9325
+ });
9326
+ }
9327
+ export declare class DescribeGlobalSecurityIPGroupRequest extends $tea.Model {
9328
+ /**
9329
+ * @remarks
9330
+ * The ID of the IP whitelist template.
9331
+ *
9332
+ * @example
9333
+ * g-zsldxfiwjmti0kcm****
9334
+ */
9335
+ globalSecurityGroupId?: string;
9336
+ ownerAccount?: string;
9337
+ ownerId?: number;
9338
+ /**
9339
+ * @remarks
9340
+ * The region ID of the IP whitelist template.
9341
+ *
9342
+ * This parameter is required.
9343
+ *
9344
+ * @example
9345
+ * cn-hangzhou
9346
+ */
9347
+ regionId?: string;
9348
+ /**
9349
+ * @remarks
9350
+ * The ID of the resource group.
9351
+ *
9352
+ * @example
9353
+ * rg-************
9354
+ */
9355
+ resourceGroupId?: string;
9356
+ resourceOwnerAccount?: string;
9357
+ resourceOwnerId?: number;
9358
+ securityToken?: string;
9359
+ static names(): {
9360
+ [key: string]: string;
9361
+ };
9362
+ static types(): {
9363
+ [key: string]: any;
9364
+ };
9365
+ constructor(map?: {
9366
+ [key: string]: any;
9367
+ });
9368
+ }
9369
+ export declare class DescribeGlobalSecurityIPGroupResponseBody extends $tea.Model {
9370
+ /**
9371
+ * @remarks
9372
+ * The details of the global IP whitelist template.
9373
+ */
9374
+ globalSecurityIPGroup?: DescribeGlobalSecurityIPGroupResponseBodyGlobalSecurityIPGroup[];
9375
+ /**
9376
+ * @remarks
9377
+ * The ID of the request.
9378
+ *
9379
+ * @example
9380
+ * 9B7BFB11-C077-4FE3-B051-F69CEB******
9381
+ */
9382
+ requestId?: string;
9383
+ static names(): {
9384
+ [key: string]: string;
9385
+ };
9386
+ static types(): {
9387
+ [key: string]: any;
9388
+ };
9389
+ constructor(map?: {
9390
+ [key: string]: any;
9391
+ });
9392
+ }
9393
+ export declare class DescribeGlobalSecurityIPGroupResponse extends $tea.Model {
9394
+ headers?: {
9395
+ [key: string]: string;
9396
+ };
9397
+ statusCode?: number;
9398
+ body?: DescribeGlobalSecurityIPGroupResponseBody;
9399
+ static names(): {
9400
+ [key: string]: string;
9401
+ };
9402
+ static types(): {
9403
+ [key: string]: any;
9404
+ };
9405
+ constructor(map?: {
9406
+ [key: string]: any;
9407
+ });
9408
+ }
9409
+ export declare class DescribeGlobalSecurityIPGroupRelationRequest extends $tea.Model {
9410
+ /**
9411
+ * @remarks
9412
+ * The ID of cluster.
9413
+ *
9414
+ * This parameter is required.
9415
+ *
9416
+ * @example
9417
+ * pc-*****************
9418
+ */
9419
+ DBClusterId?: string;
9420
+ ownerAccount?: string;
9421
+ ownerId?: number;
9422
+ /**
9423
+ * @remarks
9424
+ * The region ID of the IP whitelist template.
9425
+ *
9426
+ * This parameter is required.
9427
+ *
9428
+ * @example
9429
+ * cn-hangzhou
9430
+ */
9431
+ regionId?: string;
9432
+ /**
9433
+ * @remarks
9434
+ * The ID of the resource group.
9435
+ *
9436
+ * @example
9437
+ * rg-**********
9438
+ */
9439
+ resourceGroupId?: string;
9440
+ resourceOwnerAccount?: string;
9441
+ resourceOwnerId?: number;
9442
+ securityToken?: string;
9443
+ static names(): {
9444
+ [key: string]: string;
9445
+ };
9446
+ static types(): {
9447
+ [key: string]: any;
9448
+ };
9449
+ constructor(map?: {
9450
+ [key: string]: any;
9451
+ });
9452
+ }
9453
+ export declare class DescribeGlobalSecurityIPGroupRelationResponseBody extends $tea.Model {
9454
+ /**
9455
+ * @remarks
9456
+ * The ID of cluster.
9457
+ *
9458
+ * @example
9459
+ * pc-*****************
9460
+ */
9461
+ DBClusterId?: string;
9462
+ /**
9463
+ * @remarks
9464
+ * The details of the global IP whitelist template.
9465
+ */
9466
+ globalSecurityIPGroupRel?: DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGroupRel[];
9467
+ /**
9468
+ * @remarks
9469
+ * The ID of the request.
9470
+ *
9471
+ * @example
9472
+ * 9B7BFB11-C077-4FE3-B051-F69CEB******
9473
+ */
9474
+ requestId?: string;
9475
+ static names(): {
9476
+ [key: string]: string;
9477
+ };
9478
+ static types(): {
9479
+ [key: string]: any;
9480
+ };
9481
+ constructor(map?: {
9482
+ [key: string]: any;
9483
+ });
9484
+ }
9485
+ export declare class DescribeGlobalSecurityIPGroupRelationResponse extends $tea.Model {
8636
9486
  headers?: {
8637
9487
  [key: string]: string;
8638
9488
  };
8639
9489
  statusCode?: number;
8640
- body?: DescribeGlobalDatabaseNetworksResponseBody;
9490
+ body?: DescribeGlobalSecurityIPGroupRelationResponseBody;
8641
9491
  static names(): {
8642
9492
  [key: string]: string;
8643
9493
  };
@@ -8648,38 +9498,19 @@ export declare class DescribeGlobalDatabaseNetworksResponse extends $tea.Model {
8648
9498
  [key: string]: any;
8649
9499
  });
8650
9500
  }
8651
- export declare class DescribeGlobalSecurityIPGroupRequest extends $tea.Model {
9501
+ export declare class DescribeLicenseOrderDetailsRequest extends $tea.Model {
8652
9502
  /**
8653
9503
  * @remarks
8654
- * The ID of the IP whitelist template.
9504
+ * This parameter is required.
8655
9505
  *
8656
9506
  * @example
8657
- * g-zsldxfiwjmti0kcm****
9507
+ * 239618016570503
8658
9508
  */
8659
- globalSecurityGroupId?: string;
9509
+ aliyunOrderId?: string;
8660
9510
  ownerAccount?: string;
8661
9511
  ownerId?: number;
8662
- /**
8663
- * @remarks
8664
- * The region ID of the IP whitelist template.
8665
- *
8666
- * This parameter is required.
8667
- *
8668
- * @example
8669
- * cn-hangzhou
8670
- */
8671
- regionId?: string;
8672
- /**
8673
- * @remarks
8674
- * The ID of the resource group.
8675
- *
8676
- * @example
8677
- * rg-************
8678
- */
8679
- resourceGroupId?: string;
8680
9512
  resourceOwnerAccount?: string;
8681
9513
  resourceOwnerId?: number;
8682
- securityToken?: string;
8683
9514
  static names(): {
8684
9515
  [key: string]: string;
8685
9516
  };
@@ -8690,20 +9521,77 @@ export declare class DescribeGlobalSecurityIPGroupRequest extends $tea.Model {
8690
9521
  [key: string]: any;
8691
9522
  });
8692
9523
  }
8693
- export declare class DescribeGlobalSecurityIPGroupResponseBody extends $tea.Model {
9524
+ export declare class DescribeLicenseOrderDetailsResponseBody extends $tea.Model {
8694
9525
  /**
8695
- * @remarks
8696
- * The details of the global IP whitelist template.
9526
+ * @example
9527
+ * 2
8697
9528
  */
8698
- globalSecurityIPGroup?: DescribeGlobalSecurityIPGroupResponseBodyGlobalSecurityIPGroup[];
9529
+ activatedCodeCount?: number;
8699
9530
  /**
8700
- * @remarks
8701
- * The ID of the request.
8702
- *
8703
9531
  * @example
8704
- * 9B7BFB11-C077-4FE3-B051-F69CEB******
9532
+ * 8
9533
+ */
9534
+ activationCodeQuota?: number;
9535
+ /**
9536
+ * @example
9537
+ * 239618016570503
9538
+ */
9539
+ aliyunOrderId?: string;
9540
+ /**
9541
+ * @example
9542
+ * false
9543
+ */
9544
+ allowEmptySystemIdentifier?: boolean;
9545
+ /**
9546
+ * @example
9547
+ * PG
9548
+ */
9549
+ engine?: string;
9550
+ /**
9551
+ * @example
9552
+ * 2021-10-19 01:13:45
9553
+ */
9554
+ gmtCreated?: string;
9555
+ /**
9556
+ * @example
9557
+ * 2024-10-16 16:46:20
9558
+ */
9559
+ gmtModified?: string;
9560
+ /**
9561
+ * @example
9562
+ * false
9563
+ */
9564
+ isVirtualOrder?: boolean;
9565
+ /**
9566
+ * @example
9567
+ * false
9568
+ */
9569
+ isVirtualOrderFrozen?: boolean;
9570
+ /**
9571
+ * @example
9572
+ * pre_generation_long_term
9573
+ */
9574
+ packageType?: string;
9575
+ /**
9576
+ * @example
9577
+ * 1 year
9578
+ */
9579
+ packageValidity?: string;
9580
+ /**
9581
+ * @example
9582
+ * aliyun_market
9583
+ */
9584
+ purchaseChannel?: string;
9585
+ /**
9586
+ * @example
9587
+ * 22C0ACF0-DD29-4B67-9190-B7A48C******
8705
9588
  */
8706
9589
  requestId?: string;
9590
+ /**
9591
+ * @example
9592
+ * 239618016570503
9593
+ */
9594
+ virtualOrderId?: string;
8707
9595
  static names(): {
8708
9596
  [key: string]: string;
8709
9597
  };
@@ -8714,12 +9602,12 @@ export declare class DescribeGlobalSecurityIPGroupResponseBody extends $tea.Mode
8714
9602
  [key: string]: any;
8715
9603
  });
8716
9604
  }
8717
- export declare class DescribeGlobalSecurityIPGroupResponse extends $tea.Model {
9605
+ export declare class DescribeLicenseOrderDetailsResponse extends $tea.Model {
8718
9606
  headers?: {
8719
9607
  [key: string]: string;
8720
9608
  };
8721
9609
  statusCode?: number;
8722
- body?: DescribeGlobalSecurityIPGroupResponseBody;
9610
+ body?: DescribeLicenseOrderDetailsResponseBody;
8723
9611
  static names(): {
8724
9612
  [key: string]: string;
8725
9613
  };
@@ -8730,40 +9618,37 @@ export declare class DescribeGlobalSecurityIPGroupResponse extends $tea.Model {
8730
9618
  [key: string]: any;
8731
9619
  });
8732
9620
  }
8733
- export declare class DescribeGlobalSecurityIPGroupRelationRequest extends $tea.Model {
9621
+ export declare class DescribeLicenseOrdersRequest extends $tea.Model {
8734
9622
  /**
8735
- * @remarks
8736
- * The ID of cluster.
8737
- *
8738
- * This parameter is required.
8739
- *
8740
9623
  * @example
8741
- * pc-*****************
9624
+ * 239618016570503
8742
9625
  */
8743
- DBClusterId?: string;
9626
+ aliyunOrderId?: string;
8744
9627
  ownerAccount?: string;
8745
9628
  ownerId?: number;
8746
9629
  /**
8747
- * @remarks
8748
- * The region ID of the IP whitelist template.
8749
- *
8750
- * This parameter is required.
8751
- *
8752
9630
  * @example
8753
- * cn-hangzhou
9631
+ * single_node_subscribe
8754
9632
  */
8755
- regionId?: string;
9633
+ packageType?: string;
8756
9634
  /**
8757
- * @remarks
8758
- * The ID of the resource group.
8759
- *
8760
9635
  * @example
8761
- * rg-**********
9636
+ * 1
8762
9637
  */
8763
- resourceGroupId?: string;
9638
+ pageNumber?: number;
9639
+ /**
9640
+ * @example
9641
+ * 30
9642
+ */
9643
+ pageSize?: number;
9644
+ /**
9645
+ * @example
9646
+ * aliyun_market
9647
+ */
9648
+ purchaseChannel?: string;
8764
9649
  resourceOwnerAccount?: string;
8765
9650
  resourceOwnerId?: number;
8766
- securityToken?: string;
9651
+ virtualOrder?: boolean;
8767
9652
  static names(): {
8768
9653
  [key: string]: string;
8769
9654
  };
@@ -8774,28 +9659,28 @@ export declare class DescribeGlobalSecurityIPGroupRelationRequest extends $tea.M
8774
9659
  [key: string]: any;
8775
9660
  });
8776
9661
  }
8777
- export declare class DescribeGlobalSecurityIPGroupRelationResponseBody extends $tea.Model {
9662
+ export declare class DescribeLicenseOrdersResponseBody extends $tea.Model {
9663
+ items?: DescribeLicenseOrdersResponseBodyItems[];
8778
9664
  /**
8779
- * @remarks
8780
- * The ID of cluster.
8781
- *
8782
9665
  * @example
8783
- * pc-*****************
9666
+ * 1
8784
9667
  */
8785
- DBClusterId?: string;
9668
+ pageNumber?: number;
8786
9669
  /**
8787
- * @remarks
8788
- * The details of the global IP whitelist template.
9670
+ * @example
9671
+ * 12
8789
9672
  */
8790
- globalSecurityIPGroupRel?: DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGroupRel[];
9673
+ pageRecordCount?: number;
8791
9674
  /**
8792
- * @remarks
8793
- * The ID of the request.
8794
- *
8795
9675
  * @example
8796
- * 9B7BFB11-C077-4FE3-B051-F69CEB******
9676
+ * 34458CD3-33E0-4624-BFEF-840C15******
8797
9677
  */
8798
9678
  requestId?: string;
9679
+ /**
9680
+ * @example
9681
+ * 50
9682
+ */
9683
+ totalRecordCount?: number;
8799
9684
  static names(): {
8800
9685
  [key: string]: string;
8801
9686
  };
@@ -8806,12 +9691,12 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBody extends $
8806
9691
  [key: string]: any;
8807
9692
  });
8808
9693
  }
8809
- export declare class DescribeGlobalSecurityIPGroupRelationResponse extends $tea.Model {
9694
+ export declare class DescribeLicenseOrdersResponse extends $tea.Model {
8810
9695
  headers?: {
8811
9696
  [key: string]: string;
8812
9697
  };
8813
9698
  statusCode?: number;
8814
- body?: DescribeGlobalSecurityIPGroupRelationResponseBody;
9699
+ body?: DescribeLicenseOrdersResponseBody;
8815
9700
  static names(): {
8816
9701
  [key: string]: string;
8817
9702
  };
@@ -10026,7 +10911,7 @@ export declare class DescribeScheduleTasksRequest extends $tea.Model {
10026
10911
  export declare class DescribeScheduleTasksResponseBody extends $tea.Model {
10027
10912
  /**
10028
10913
  * @remarks
10029
- * The result data that is returned.
10914
+ * The result data.
10030
10915
  */
10031
10916
  data?: DescribeScheduleTasksResponseBodyData;
10032
10917
  /**
@@ -10084,9 +10969,8 @@ export declare class DescribeScheduleTasksResponse extends $tea.Model {
10084
10969
  export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10085
10970
  /**
10086
10971
  * @remarks
10087
- * The ID of cluster.
10088
- *
10089
- * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.
10972
+ * Cluster ID.
10973
+ * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) interface to view all cluster information in the target region, including the Cluster ID.
10090
10974
  *
10091
10975
  * This parameter is required.
10092
10976
  *
@@ -10096,7 +10980,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10096
10980
  DBClusterId?: string;
10097
10981
  /**
10098
10982
  * @remarks
10099
- * The name of the database.
10983
+ * Database name.
10100
10984
  *
10101
10985
  * @example
10102
10986
  * testdb
@@ -10104,9 +10988,9 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10104
10988
  DBName?: string;
10105
10989
  /**
10106
10990
  * @remarks
10107
- * The end of the time range to query. The end time must be later than the start time. The interval between the start time and end time must be within 24 hours. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
10991
+ * End time of the query, which must be later than the start time, and the time interval between the start and end times must not exceed 24 hours. The format is `YYYY-MM-DDThh:mmZ` (UTC time).
10108
10992
  *
10109
- * > This parameter must be set to a time value in UTC (UTC+0 time zone). If your service resides in another time zone, convert the time value. For example, if the local time in the time zone where your service resides is 12:00 (UTC +8) and you want to query slow query logs at 08:00 (UTC +8) to 12:00, set this parameter to a time value that ranges from 00:00, set this parameter to 04:00.
10993
+ * > The input is UTC time (i.e., 0 timezone). If your service is currently in a different timezone, please perform a time conversion. For example, if the current timezone of your service is Beijing Time (UTC+8) at 12:00, and you need to query the slow logs between 08:00-12:00 Beijing Time, you should input 00:00-04:00.
10110
10994
  *
10111
10995
  * This parameter is required.
10112
10996
  *
@@ -10114,14 +10998,21 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10114
10998
  * 2022-11-16T04:00Z
10115
10999
  */
10116
11000
  endTime?: string;
11001
+ /**
11002
+ * @remarks
11003
+ * Node ID
11004
+ *
11005
+ * @example
11006
+ * pi-**********
11007
+ */
10117
11008
  nodeId?: string;
10118
11009
  ownerAccount?: string;
10119
11010
  ownerId?: number;
10120
11011
  /**
10121
11012
  * @remarks
10122
- * The number of the page to return. The value must be an integer that is larger than 0.
11013
+ * Page number, with a range greater than 0 and not exceeding the maximum value of Integer.
10123
11014
  *
10124
- * Default value: **1**.
11015
+ * The default value is **1**.
10125
11016
  *
10126
11017
  * @example
10127
11018
  * 1
@@ -10129,13 +11020,12 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10129
11020
  pageNumber?: number;
10130
11021
  /**
10131
11022
  * @remarks
10132
- * The number of entries to return on each page. Valid values:
10133
- *
10134
- * * **30**
10135
- * * **50**
10136
- * * **100**
11023
+ * Number of records per page, with the following options:
11024
+ * * **30**
11025
+ * * **50**
11026
+ * * **100**
10137
11027
  *
10138
- * Default value: **30**.
11028
+ * The default value is **30**.
10139
11029
  *
10140
11030
  * @example
10141
11031
  * 30
@@ -10143,9 +11033,9 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10143
11033
  pageSize?: number;
10144
11034
  /**
10145
11035
  * @remarks
10146
- * The region ID of the cluster.
11036
+ * Region ID.
10147
11037
  *
10148
- * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query all regions that are available for your account, such as the region ID.
11038
+ * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) interface to view the available regions under the target account, including the Region ID.
10149
11039
  *
10150
11040
  * This parameter is required.
10151
11041
  *
@@ -10157,7 +11047,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10157
11047
  resourceOwnerId?: number;
10158
11048
  /**
10159
11049
  * @remarks
10160
- * The unique ID of the SQL statement. The ID is used to obtain the slow query logs of the SQL statement.
11050
+ * Unique identifier of the SQL statement in the slow log statistics, which can be used to obtain the detailed slow logs for that SQL statement.
10161
11051
  *
10162
11052
  * @example
10163
11053
  * U2FsdGVk****
@@ -10165,13 +11055,10 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10165
11055
  SQLHASH?: string;
10166
11056
  /**
10167
11057
  * @remarks
10168
- * The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
11058
+ * Start time of the query. The format is `YYYY-MM-DDThh:mmZ` (UTC time).
10169
11059
  *
10170
- * >
10171
- *
10172
- * * You can specify a time range of up to 30 days.
10173
- *
10174
- * * This parameter must be set to a time value in UTC (UTC+0 time zone). If your service resides in another time zone, convert the time value. For example, if the local time in the time zone where your service resides is 12:00 (UTC +8) and you want to query slow query logs at 08:00 (UTC +8) to 12:00, set this parameter to a time value that ranges from 00:00, set this parameter to 04:00.
11060
+ * > * Supports viewing slow log information up to 30 days.
11061
+ * > * The input is UTC time (i.e., 0 timezone). If your service is currently in a different timezone, please perform a time conversion. For example, if the current timezone of your service is Beijing Time (UTC+8) at 12:00, and you need to query the slow logs between 08:00-12:00 Beijing Time, you should input 00:00-04:00.
10175
11062
  *
10176
11063
  * This parameter is required.
10177
11064
  *
@@ -10192,7 +11079,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
10192
11079
  export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10193
11080
  /**
10194
11081
  * @remarks
10195
- * The ID of cluster.
11082
+ * Cluster ID.
10196
11083
  *
10197
11084
  * @example
10198
11085
  * pc-*****************
@@ -10200,7 +11087,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10200
11087
  DBClusterId?: string;
10201
11088
  /**
10202
11089
  * @remarks
10203
- * The type of the database engine.
11090
+ * Database engine.
10204
11091
  *
10205
11092
  * @example
10206
11093
  * polardb_mysql
@@ -10208,12 +11095,12 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10208
11095
  engine?: string;
10209
11096
  /**
10210
11097
  * @remarks
10211
- * Details about slow query logs.
11098
+ * List of slow log details.
10212
11099
  */
10213
11100
  items?: DescribeSlowLogRecordsResponseBodyItems;
10214
11101
  /**
10215
11102
  * @remarks
10216
- * The number of the returned page.
11103
+ * Page number.
10217
11104
  *
10218
11105
  * @example
10219
11106
  * 1
@@ -10221,7 +11108,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10221
11108
  pageNumber?: number;
10222
11109
  /**
10223
11110
  * @remarks
10224
- * The number of entries returned per page.
11111
+ * Number of records on this page.
10225
11112
  *
10226
11113
  * @example
10227
11114
  * 1
@@ -10229,7 +11116,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10229
11116
  pageRecordCount?: number;
10230
11117
  /**
10231
11118
  * @remarks
10232
- * The ID of the request.
11119
+ * Request ID.
10233
11120
  *
10234
11121
  * @example
10235
11122
  * A7E6A8FD-C50B-46B2-BA85-D8B8D3******
@@ -10237,7 +11124,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
10237
11124
  requestId?: string;
10238
11125
  /**
10239
11126
  * @remarks
10240
- * The total number of SQL statements.
11127
+ * Total number of SQL statements.
10241
11128
  *
10242
11129
  * @example
10243
11130
  * 1
@@ -10519,7 +11406,7 @@ export declare class DescribeTasksRequest extends $tea.Model {
10519
11406
  * * **Running**: The task is running.
10520
11407
  * * **Finished**: The task is completed.
10521
11408
  * * **Closed**: The task is closed.
10522
- * * **Pause**: The task is suspended.
11409
+ * * **Pause**: The task is paused.
10523
11410
  * * **Stop**: The task is interrupted.
10524
11411
  *
10525
11412
  * >
@@ -11050,6 +11937,8 @@ export declare class EnableDBClusterServerlessResponse extends $tea.Model {
11050
11937
  export declare class EnableFirewallRulesRequest extends $tea.Model {
11051
11938
  /**
11052
11939
  * @remarks
11940
+ * The cluster ID.
11941
+ *
11053
11942
  * This parameter is required.
11054
11943
  *
11055
11944
  * @example
@@ -11057,6 +11946,14 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
11057
11946
  */
11058
11947
  DBClusterId?: string;
11059
11948
  /**
11949
+ * @remarks
11950
+ * Specifies whether to enable or disable the specified firewall rules. Valid values:
11951
+ *
11952
+ * * **true**: enables the specified firewall rules.
11953
+ * * **false**: disables the specified firewall rules.
11954
+ *
11955
+ * > This parameter is valid only when you specify the **RuleNameList** parameter.
11956
+ *
11060
11957
  * @example
11061
11958
  * true
11062
11959
  */
@@ -11067,6 +11964,10 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
11067
11964
  resourceOwnerId?: number;
11068
11965
  /**
11069
11966
  * @remarks
11967
+ * The name of the firewall rule that you want to enable for the cluster. You can specify multiple firewall rules at a time. Separate multiple rules with commas (,).
11968
+ *
11969
+ * > You can call the **DescribeFirewallRules** operation to query the details of all firewall rules that are applicable to a cluster, such as rule names.
11970
+ *
11070
11971
  * This parameter is required.
11071
11972
  *
11072
11973
  * @example
@@ -11085,6 +11986,11 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
11085
11986
  }
11086
11987
  export declare class EnableFirewallRulesResponseBody extends $tea.Model {
11087
11988
  /**
11989
+ * @remarks
11990
+ * The message that is returned for the request.
11991
+ *
11992
+ * > If the request was successful, Successful is returned. If the request failed, an error message that contains information such as an error code is returned.
11993
+ *
11088
11994
  * @example
11089
11995
  * Message
11090
11996
  */
@@ -11098,6 +12004,12 @@ export declare class EnableFirewallRulesResponseBody extends $tea.Model {
11098
12004
  */
11099
12005
  requestId?: string;
11100
12006
  /**
12007
+ * @remarks
12008
+ * Indicates whether the request was successful. Valid values:
12009
+ *
12010
+ * * **true**
12011
+ * * **false**
12012
+ *
11101
12013
  * @example
11102
12014
  * true
11103
12015
  */
@@ -11374,7 +12286,7 @@ export declare class FailoverDBClusterRequest extends $tea.Model {
11374
12286
  resourceOwnerId?: number;
11375
12287
  /**
11376
12288
  * @remarks
11377
- * Specifies whether to fail back to the original primary zone after a failover. Valid values:
12289
+ * Specifies whether to switch back services to the original primary zone when the original primary zone recovers.
11378
12290
  *
11379
12291
  * * true
11380
12292
  * * false
@@ -11394,6 +12306,16 @@ export declare class FailoverDBClusterRequest extends $tea.Model {
11394
12306
  * pi-***********
11395
12307
  */
11396
12308
  targetDBNodeId?: string;
12309
+ /**
12310
+ * @remarks
12311
+ * Whether it is a primary-standby switch within the primary availability zone, with the following values:
12312
+ *
12313
+ * Primary: Primary-standby switch within the primary availability zone.
12314
+ * Standby: Switch to the storage hot backup cluster.
12315
+ *
12316
+ * @example
12317
+ * Primary
12318
+ */
11397
12319
  targetZoneType?: string;
11398
12320
  static names(): {
11399
12321
  [key: string]: string;
@@ -11561,7 +12483,7 @@ export declare class ListTagResourcesRequest extends $tea.Model {
11561
12483
  regionId?: string;
11562
12484
  /**
11563
12485
  * @remarks
11564
- * The cluster ID. To query the tags of multiple clusters, click **Add** to add cluster IDs.
12486
+ * The IDs of the clusters. To query the tags of multiple clusters, click **Add** to add cluster IDs.
11565
12487
  *
11566
12488
  * >
11567
12489
  *
@@ -12036,13 +12958,13 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
12036
12958
  backupFrequency?: string;
12037
12959
  /**
12038
12960
  * @remarks
12039
- * Specifies whether to retain backups when you delete a cluster. Valid values:
12961
+ * Specifies whether to retain backups when a cluster is deleted. Valid values:
12040
12962
  *
12041
12963
  * * **ALL**: permanently retains all backups.
12042
- * * **LATEST**: permanently retains only the last backup.
12964
+ * * **LATEST**: permanently retains the most recent backup.
12043
12965
  * * **NONE**: does not retain backups.
12044
12966
  *
12045
- * > The default value is NONE.
12967
+ * > The default value of the parameter is NONE.
12046
12968
  *
12047
12969
  * @example
12048
12970
  * NONE
@@ -12130,7 +13052,7 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
12130
13052
  * * **30 to 7300**: Cross-region level-2 backups are retained for 30 to 7,300 days.
12131
13053
  * * **1**: Cross-region level-2 backups are permanently retained.
12132
13054
  *
12133
- * > The default value is **0**. By default, the cross-region level-2 backup feature is disabled when you create a cluster.
13055
+ * > The default value of the parameter is **0**.
12134
13056
  *
12135
13057
  * @example
12136
13058
  * 30
@@ -12161,10 +13083,10 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
12161
13083
  * The retention period of level-2 backups. Valid values:
12162
13084
  *
12163
13085
  * * **0**: The level-2 backup feature is disabled.
12164
- * * **30 to 7300**: Cross-region level-2 backups are retained for 30 to 7,300 days.
12165
- * * **1**: Cross-region level-2 backups are permanently retained.
13086
+ * * **30 to 7300**: Level-2 backups are retained for 30 to 7,300 days.
13087
+ * * **1**: Level-2 backups are permanently retained.
12166
13088
  *
12167
- * > The default value is **0**. By default, the level-2 backup feature is disabled when you create a cluster.
13089
+ * > The default value of this parameter is **0**.
12168
13090
  *
12169
13091
  * @example
12170
13092
  * 0
@@ -12249,7 +13171,7 @@ export declare class ModifyBackupPolicyResponse extends $tea.Model {
12249
13171
  export declare class ModifyDBClusterRequest extends $tea.Model {
12250
13172
  /**
12251
13173
  * @remarks
12252
- * Enable storage compression function. The value of this parameter is ON.
13174
+ * Specifies whether to enable storage compression. Set the value to **ON**.
12253
13175
  *
12254
13176
  * @example
12255
13177
  * ON
@@ -12267,6 +13189,15 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
12267
13189
  * pc-*************
12268
13190
  */
12269
13191
  DBClusterId?: string;
13192
+ /**
13193
+ * @remarks
13194
+ * The list of nodes for the drill.
13195
+ *
13196
+ * > You can specify only one node for a node-level disaster recovery drill. For a primary zone-level disaster recovery drill, you can either choose not to specify this parameter or specify all nodes.
13197
+ *
13198
+ * @example
13199
+ * pi-rwxxx
13200
+ */
12270
13201
  DBNodeCrashList?: string;
12271
13202
  /**
12272
13203
  * @remarks
@@ -12279,34 +13210,44 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
12279
13210
  * AsynSync
12280
13211
  */
12281
13212
  dataSyncMode?: string;
13213
+ /**
13214
+ * @remarks
13215
+ * The fault injection method. Valid values:
13216
+ *
13217
+ * * CrashSQLInjection: `Crash SQL`-based fault injection.
13218
+ *
13219
+ * @example
13220
+ * 0
13221
+ */
12282
13222
  faultInjectionType?: string;
12283
13223
  /**
12284
13224
  * @remarks
12285
- * The fault scenario that you want to simulate for the cluster.
13225
+ * The level of the disaster recovery drill. Valid values:
12286
13226
  *
12287
- * * Set the value to **0**. The value 0 indicates the scenario in which the primary zone of the cluster fails.
13227
+ * * `0` or `FaultInjection`: The primary zone level.
13228
+ * * `1`: The node level.
12288
13229
  *
12289
13230
  * >
12290
13231
  *
12291
- * * This parameter takes effect only when you set the `StandbyHAMode` parameter to 0.
13232
+ * * In **primary zone-level disaster recovery drill** scenarios, all compute nodes in the primary zone are unavailable. Data loss occurs during failovers in the scenarios.
12292
13233
  *
12293
- * * If you set this parameter to 0, all compute nodes deployed in the primary zone are unavailable. In this case, the switchover degrades the cluster performance.
13234
+ * * In **node-level disaster recovery drill** scenarios, you can specify only one compute node for the disaster recovery drill. You can use the `DBNodeCrashList` parameter to specify the name of the compute node that you want to use for the drill.
12294
13235
  *
12295
13236
  * @example
12296
13237
  * 0
12297
13238
  */
12298
13239
  faultSimulateMode?: string;
13240
+ imciAutoIndex?: string;
12299
13241
  ownerAccount?: string;
12300
13242
  ownerId?: number;
12301
13243
  resourceOwnerAccount?: string;
12302
13244
  resourceOwnerId?: number;
12303
13245
  /**
12304
13246
  * @remarks
12305
- * Specifies whether to enable the cross-zone automatic switchover mode. Valid values:
13247
+ * Specifies whether to enable cross-zone automatic switchover. Valid values:
12306
13248
  *
12307
- * * **ON**: Enable the cross-zone automatic switchover mode.
12308
- * * **OFF**: Disable the cross-zone automatic switchover mode.
12309
- * * **0**: Enable the customer drill mode.
13249
+ * * **ON**: enables cross-zone automatic switchover.
13250
+ * * **OFF**: disables cross-zone automatic switchover.
12310
13251
  *
12311
13252
  * @example
12312
13253
  * ON
@@ -12314,7 +13255,7 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
12314
13255
  standbyHAMode?: string;
12315
13256
  /**
12316
13257
  * @remarks
12317
- * Specifies whether to enable automatic storage scaling for the cluster of Standard Edition. Valid values:
13258
+ * Specifies whether to enable automatic storage scaling. This parameter is available only for Standard Edition clusters. Valid values:
12318
13259
  *
12319
13260
  * * Enable
12320
13261
  * * Disable
@@ -12353,11 +13294,17 @@ export declare class ModifyDBClusterResponseBody extends $tea.Model {
12353
13294
  */
12354
13295
  DBClusterId?: string;
12355
13296
  /**
13297
+ * @remarks
13298
+ * The order ID.
13299
+ *
12356
13300
  * @example
12357
13301
  * 2148126708*****
12358
13302
  */
12359
13303
  orderId?: string;
12360
13304
  /**
13305
+ * @remarks
13306
+ * The request ID.
13307
+ *
12361
13308
  * @example
12362
13309
  * CD3FA5F3-FAF3-44CA-AFFF-BAF869******
12363
13310
  */
@@ -13588,6 +14535,8 @@ export declare class ModifyDBClusterPrimaryZoneResponse extends $tea.Model {
13588
14535
  export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
13589
14536
  /**
13590
14537
  * @remarks
14538
+ * The cluster ID.
14539
+ *
13591
14540
  * This parameter is required.
13592
14541
  *
13593
14542
  * @example
@@ -13596,6 +14545,8 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
13596
14545
  DBClusterId?: string;
13597
14546
  /**
13598
14547
  * @remarks
14548
+ * The ID of the new resource group.
14549
+ *
13599
14550
  * This parameter is required.
13600
14551
  *
13601
14552
  * @example
@@ -13605,6 +14556,9 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
13605
14556
  ownerAccount?: string;
13606
14557
  ownerId?: number;
13607
14558
  /**
14559
+ * @remarks
14560
+ * The ID of the original resource group.
14561
+ *
13608
14562
  * @example
13609
14563
  * rg-**********
13610
14564
  */
@@ -13623,6 +14577,9 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
13623
14577
  }
13624
14578
  export declare class ModifyDBClusterResourceGroupResponseBody extends $tea.Model {
13625
14579
  /**
14580
+ * @remarks
14581
+ * The request ID.
14582
+ *
13626
14583
  * @example
13627
14584
  * 70656639-1416-479F-AF13-D08197******
13628
14585
  */
@@ -13783,6 +14740,14 @@ export declare class ModifyDBClusterServerlessConfRequest extends $tea.Model {
13783
14740
  * true
13784
14741
  */
13785
14742
  allowShutDown?: string;
14743
+ /**
14744
+ * @remarks
14745
+ * Cycle policy ID.
14746
+ *
14747
+ * @example
14748
+ * 143f8e9f-2566-4dff-be47-bed79f28fc78
14749
+ */
14750
+ crontabJobId?: string;
13786
14751
  /**
13787
14752
  * @remarks
13788
14753
  * The ID of the serverless cluster.
@@ -13876,18 +14841,48 @@ export declare class ModifyDBClusterServerlessConfRequest extends $tea.Model {
13876
14841
  * @example
13877
14842
  * 1
13878
14843
  */
13879
- scaleRoNumMin?: string;
14844
+ scaleRoNumMin?: string;
14845
+ /**
14846
+ * @remarks
14847
+ * The detection period for No-activity Suspension. Valid values: 5 to 1440. Unit: minutes. The detection duration must be a multiple of 5 minutes.
14848
+ *
14849
+ * @example
14850
+ * 10
14851
+ */
14852
+ secondsUntilAutoPause?: string;
14853
+ /**
14854
+ * @remarks
14855
+ * CPU burst threshold
14856
+ *
14857
+ * @example
14858
+ * 80
14859
+ */
14860
+ serverlessRuleCpuEnlargeThreshold?: string;
14861
+ /**
14862
+ * @remarks
14863
+ * CPU downscale threshold
14864
+ *
14865
+ * @example
14866
+ * 50
14867
+ */
14868
+ serverlessRuleCpuShrinkThreshold?: string;
14869
+ /**
14870
+ * @remarks
14871
+ * Elastic sensitivity. Values: - normal: standard - flexible: sensitive
14872
+ *
14873
+ * @example
14874
+ * normal
14875
+ * flexible
14876
+ */
14877
+ serverlessRuleMode?: string;
13880
14878
  /**
13881
14879
  * @remarks
13882
- * The detection period for No-activity Suspension. Valid values: 5 to 1440. Unit: minutes. The detection duration must be a multiple of 5 minutes.
14880
+ * Asynchronous task ID.
13883
14881
  *
13884
14882
  * @example
13885
- * 10
14883
+ * 143f8e9f-2566-4dff-be47-bed79f28fc78
13886
14884
  */
13887
- secondsUntilAutoPause?: string;
13888
- serverlessRuleCpuEnlargeThreshold?: string;
13889
- serverlessRuleCpuShrinkThreshold?: string;
13890
- serverlessRuleMode?: string;
14885
+ taskId?: string;
13891
14886
  static names(): {
13892
14887
  [key: string]: string;
13893
14888
  };
@@ -14080,6 +15075,19 @@ export declare class ModifyDBClusterTDERequest extends $tea.Model {
14080
15075
  * pc-************
14081
15076
  */
14082
15077
  DBClusterId?: string;
15078
+ /**
15079
+ * @remarks
15080
+ * Specifies whether to allow the TDE key of the cluster to be automatically rotated within the next maintenance window after a lapse of the rotation period when a change in the KMS key version is detected. This parameter is supported only for custom keys. Valid values:
15081
+ *
15082
+ * * **true**
15083
+ * * **false**
15084
+ *
15085
+ * > This parameter is supported only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.
15086
+ *
15087
+ * @example
15088
+ * false
15089
+ */
15090
+ enableAutomaticRotation?: string;
14083
15091
  /**
14084
15092
  * @remarks
14085
15093
  * Specifies whether to enable automatic encryption for new tables. Valid values:
@@ -14087,6 +15095,8 @@ export declare class ModifyDBClusterTDERequest extends $tea.Model {
14087
15095
  * * **ON**
14088
15096
  * * **OFF**
14089
15097
  *
15098
+ * > This parameter takes effect only for a PolarDB for MySQL cluster.
15099
+ *
14090
15100
  * @example
14091
15101
  * ON
14092
15102
  */
@@ -14890,15 +15900,22 @@ export declare class ModifyDBNodesParametersResponse extends $tea.Model {
14890
15900
  });
14891
15901
  }
14892
15902
  export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
15903
+ /**
15904
+ * @remarks
15905
+ * Create a global domain
15906
+ *
15907
+ * @example
15908
+ * false
15909
+ */
14893
15910
  enableGlobalDomainName?: boolean;
14894
15911
  /**
14895
15912
  * @remarks
14896
15913
  * The description of the GDN. The description must meet the following requirements:
14897
15914
  *
14898
- * * It cannot start with `http://` or `https://`.
14899
- * * It must start with a letter.
14900
- * * It can contain letters, digits, underscores (_), and hyphens (-).
14901
- * * It must be 2 to 126 characters in length.
15915
+ * * The description cannot start with http:// or https://.
15916
+ * * The description must start with a letter.
15917
+ * * The description can contain letters, digits, underscores (_), and hyphens (-).
15918
+ * * The description must be 2 to 126 characters in length.
14902
15919
  *
14903
15920
  * @example
14904
15921
  * GDN-fortest
@@ -14906,7 +15923,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
14906
15923
  GDNDescription?: string;
14907
15924
  /**
14908
15925
  * @remarks
14909
- * The ID of the GDN.
15926
+ * The GDN ID.
14910
15927
  *
14911
15928
  * This parameter is required.
14912
15929
  *
@@ -14918,7 +15935,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
14918
15935
  ownerId?: number;
14919
15936
  /**
14920
15937
  * @remarks
14921
- * The ID of the resource group.
15938
+ * The resource group ID.
14922
15939
  *
14923
15940
  * @example
14924
15941
  * rg-************
@@ -14940,7 +15957,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
14940
15957
  export declare class ModifyGlobalDatabaseNetworkResponseBody extends $tea.Model {
14941
15958
  /**
14942
15959
  * @remarks
14943
- * The ID of the request.
15960
+ * The request ID.
14944
15961
  *
14945
15962
  * @example
14946
15963
  * C61892A4-0850-4516-9E26-44D96C1782DE
@@ -15632,6 +16649,12 @@ export declare class OpenAITaskRequest extends $tea.Model {
15632
16649
  */
15633
16650
  DBClusterId?: string;
15634
16651
  /**
16652
+ * @remarks
16653
+ * The node type. Valid values:
16654
+ *
16655
+ * * **DLNode**: This node is an AI node.
16656
+ * * **SearchNode**: This node is a node for which the PolarDB for AI feature is enabled.
16657
+ *
15635
16658
  * @example
15636
16659
  * DLNode
15637
16660
  */
@@ -16461,6 +17484,8 @@ export declare class TagResourcesRequest extends $tea.Model {
16461
17484
  regionId?: string;
16462
17485
  /**
16463
17486
  * @remarks
17487
+ * The cluster ID.
17488
+ *
16464
17489
  * This parameter is required.
16465
17490
  *
16466
17491
  * @example
@@ -16481,6 +17506,8 @@ export declare class TagResourcesRequest extends $tea.Model {
16481
17506
  resourceType?: string;
16482
17507
  /**
16483
17508
  * @remarks
17509
+ * The tags.
17510
+ *
16484
17511
  * This parameter is required.
16485
17512
  */
16486
17513
  tag?: TagResourcesRequestTag[];
@@ -16567,9 +17594,9 @@ export declare class TempModifyDBNodeRequest extends $tea.Model {
16567
17594
  modifyType?: string;
16568
17595
  /**
16569
17596
  * @remarks
16570
- * The type of operation performed on the cluster. Valid values:
17597
+ * The operation type. Valid values:
16571
17598
  *
16572
- * * **Modify**: temporarily upgrade the configuration of the cluster.
17599
+ * * **Modify**: temporarily upgrades the configuration of the cluster.
16573
17600
  *
16574
17601
  * This parameter is required.
16575
17602
  *
@@ -16824,9 +17851,9 @@ export declare class TransformDBClusterPayTypeResponse extends $tea.Model {
16824
17851
  export declare class UntagResourcesRequest extends $tea.Model {
16825
17852
  /**
16826
17853
  * @remarks
16827
- * Specifies whether to unbinds all tags from the cluster. Valid values: **true** and **false**. Default value: **false**.
17854
+ * Specifies whether to detach all tags from the cluster. Valid values: **true** and **false**. Default value: **false**.
16828
17855
  *
16829
- * > This parameter takes effect only when the value of the `TagKey.n` parameter is empty.
17856
+ * > This parameter takes effect only if `TagKey.n` is empty.
16830
17857
  *
16831
17858
  * @example
16832
17859
  * true
@@ -17069,9 +18096,9 @@ export declare class UpgradeDBClusterVersionResponse extends $tea.Model {
17069
18096
  export declare class CreateDBClusterRequestTag extends $tea.Model {
17070
18097
  /**
17071
18098
  * @remarks
17072
- * The key of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click the **+** icon.
18099
+ * Tag key. If you need to add multiple tags to the target cluster at once, click **Add** to add a tag key.
17073
18100
  *
17074
- * > You can create up to 20 key-value pairs of tags at a time. Each value of the `Tag.N.Key` parameter is paired with a value of the `Tag.N.Value` parameter.
18101
+ * > Up to 20 pairs of tags can be added each time, where `Tag.N.Key` corresponds to `Tag.N.Value`.
17075
18102
  *
17076
18103
  * @example
17077
18104
  * type
@@ -17079,9 +18106,9 @@ export declare class CreateDBClusterRequestTag extends $tea.Model {
17079
18106
  key?: string;
17080
18107
  /**
17081
18108
  * @remarks
17082
- * The value of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click the **+** icon.
18109
+ * Tag value. If you need to add multiple tags to the target cluster at once, click **Add** to add tag values.
17083
18110
  *
17084
- * > You can create up to 20 key-value pairs of tags at a time. Each value of the `Tag.N.Value` parameter is paired with a value of the `Tag.N.Key` parameter.
18111
+ * > Up to 20 pairs of tags can be added each time, where `Tag.N.Value` corresponds to `Tag.N.Key`.
17085
18112
  *
17086
18113
  * @example
17087
18114
  * test
@@ -17379,6 +18406,62 @@ export declare class DescribeAccountsResponseBodyAccounts extends $tea.Model {
17379
18406
  [key: string]: any;
17380
18407
  });
17381
18408
  }
18409
+ export declare class DescribeActivationCodesResponseBodyItems extends $tea.Model {
18410
+ /**
18411
+ * @example
18412
+ * 2024-10-16 16:46:20
18413
+ */
18414
+ activateAt?: string;
18415
+ /**
18416
+ * @example
18417
+ * testCode
18418
+ */
18419
+ description?: string;
18420
+ /**
18421
+ * @example
18422
+ * 2054-10-16 16:46:20
18423
+ */
18424
+ expireAt?: string;
18425
+ /**
18426
+ * @example
18427
+ * 2024-10-16 16:46:20
18428
+ */
18429
+ gmtCreated?: string;
18430
+ /**
18431
+ * @example
18432
+ * 2024-10-16 16:46:20
18433
+ */
18434
+ gmtModified?: string;
18435
+ /**
18436
+ * @example
18437
+ * 123
18438
+ */
18439
+ id?: number;
18440
+ /**
18441
+ * @example
18442
+ * 12:34:56:78:98:00
18443
+ */
18444
+ macAddress?: string;
18445
+ /**
18446
+ * @example
18447
+ * testName
18448
+ */
18449
+ name?: string;
18450
+ /**
18451
+ * @example
18452
+ * 1234567890123456
18453
+ */
18454
+ systemIdentifier?: string;
18455
+ static names(): {
18456
+ [key: string]: string;
18457
+ };
18458
+ static types(): {
18459
+ [key: string]: any;
18460
+ };
18461
+ constructor(map?: {
18462
+ [key: string]: any;
18463
+ });
18464
+ }
17382
18465
  export declare class DescribeAutoRenewAttributeResponseBodyItemsAutoRenewAttribute extends $tea.Model {
17383
18466
  /**
17384
18467
  * @remarks
@@ -18069,20 +19152,23 @@ export declare class DescribeDBClusterAccessWhitelistResponseBodyItems extends $
18069
19152
  export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
18070
19153
  /**
18071
19154
  * @remarks
18072
- * The number of CPU cores for compute node scale-out within seconds.
19155
+ * Number of CPU cores for second-level elastic scaling.
18073
19156
  *
18074
19157
  * @example
18075
19158
  * 6
18076
19159
  */
18077
19160
  addedCpuCores?: string;
18078
19161
  /**
19162
+ * @remarks
19163
+ * Number of CPU cores for the node.
19164
+ *
18079
19165
  * @example
18080
19166
  * 2
18081
19167
  */
18082
19168
  cpuCores?: string;
18083
19169
  /**
18084
19170
  * @remarks
18085
- * The time when the node was created.
19171
+ * Node creation time.
18086
19172
  *
18087
19173
  * @example
18088
19174
  * 2020-03-23T21:35:43Z
@@ -18090,7 +19176,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18090
19176
  creationTime?: string;
18091
19177
  /**
18092
19178
  * @remarks
18093
- * The type of the node.
19179
+ * Node specification.
18094
19180
  *
18095
19181
  * @example
18096
19182
  * polar.mysql.x4.large
@@ -18098,7 +19184,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18098
19184
  DBNodeClass?: string;
18099
19185
  /**
18100
19186
  * @remarks
18101
- * The ID of the node.
19187
+ * Node ID.
18102
19188
  *
18103
19189
  * @example
18104
19190
  * pi-****************
@@ -18106,10 +19192,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18106
19192
  DBNodeId?: string;
18107
19193
  /**
18108
19194
  * @remarks
18109
- * The role of the node. Valid values:
19195
+ * Node role, with possible values as follows:
18110
19196
  *
18111
- * * **Writer**: The node is the primary node.
18112
- * * **Reader**: The node is a read-only node.
19197
+ * - **Writer**: Primary node.
19198
+ * - **Reader**: Read-only node.
18113
19199
  *
18114
19200
  * @example
18115
19201
  * Reader
@@ -18117,21 +19203,20 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18117
19203
  DBNodeRole?: string;
18118
19204
  /**
18119
19205
  * @remarks
18120
- * The status of the node. Valid values:
18121
- *
18122
- * * **Creating**: The cluster is being created.
18123
- * * **Running**: The cluster is running.
18124
- * * **Deleting**: The cluster is being deleted.
18125
- * * **Rebooting**: The cluster is restarting.
18126
- * * **DBNodeCreating**: PolarProxy is being added.
18127
- * * **DBNodeDeleting**: PolarProxy is being deleted.
18128
- * * **ClassChanging**: The specification type of PolarProxy are being modified.
18129
- * * **NetAddressCreating**: The network connection is being created.
18130
- * * **NetAddressDeleting**: The network connection is being deleted.
18131
- * * **NetAddressModifying**: The network connection is being modified.
18132
- * * **MinorVersionUpgrading**: The minor version is being updated.
18133
- * * **Maintaining**: The cluster is being maintained.
18134
- * * **Switching**: A failover is being performed.
19206
+ * Node status, with possible values as follows:
19207
+ * * **Creating**: Creating
19208
+ * * **Running**: Running
19209
+ * * **Deleting**: Deleting
19210
+ * * **Rebooting**: Rebooting
19211
+ * * **DBNodeCreating**: Adding node
19212
+ * * **DBNodeDeleting**: Removing node
19213
+ * * **ClassChanging**: Modifying node specification
19214
+ * * **NetAddressCreating**: Creating network connection
19215
+ * * **NetAddressDeleting**: Deleting network connection
19216
+ * * **NetAddressModifying**: Modifying network connection
19217
+ * * **MinorVersionUpgrading**: Upgrading minor version
19218
+ * * **Maintaining**: Instance maintenance
19219
+ * * **Switching**: Switching
18135
19220
  *
18136
19221
  * @example
18137
19222
  * Running
@@ -18139,7 +19224,8 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18139
19224
  DBNodeStatus?: string;
18140
19225
  /**
18141
19226
  * @remarks
18142
- * The failover priority. Each node is assigned a failover priority. If a failover occurs, a node can be selected as a primary node. The priority determines the probability at which a node is selected as a primary node. A larger value indicates a higher priority. Valid values: 1 to 15.
19227
+ * Failover priority. Each node has a failover priority, determining the likelihood of being elected as the primary node during a failover. A higher value indicates a higher priority.
19228
+ * Range: 1 to 15.
18143
19229
  *
18144
19230
  * @example
18145
19231
  * 1
@@ -18147,10 +19233,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18147
19233
  failoverPriority?: number;
18148
19234
  /**
18149
19235
  * @remarks
18150
- * Indicates whether the hot standby feature is enabled. Valid values:
19236
+ * Whether hot standby is enabled. Possible values are:
18151
19237
  *
18152
- * * **ON**
18153
- * * **OFF**
19238
+ * - **ON**: Enabled
19239
+ * - **OFF**: Disabled
18154
19240
  *
18155
19241
  * @example
18156
19242
  * ON
@@ -18158,10 +19244,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18158
19244
  hotReplicaMode?: string;
18159
19245
  /**
18160
19246
  * @remarks
18161
- * Indicates whether the In-Memory Column Index (IMCI) feature is enabled. Valid values:
19247
+ * Whether columnar index is enabled. Possible values are:
18162
19248
  *
18163
- * * **ON**
18164
- * * **OFF**
19249
+ * - **ON**: Enabled
19250
+ * - **OFF**: Disabled
18165
19251
  *
18166
19252
  * @example
18167
19253
  * ON
@@ -18169,7 +19255,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18169
19255
  imciSwitch?: string;
18170
19256
  /**
18171
19257
  * @remarks
18172
- * The ID of the primary node in the cluster that runs Multi-master Cluster Edition.
19258
+ * Primary node ID of the multi-master architecture cluster edition.
18173
19259
  *
18174
19260
  * @example
18175
19261
  * pi-bp18z52akld3*****
@@ -18177,7 +19263,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18177
19263
  masterId?: string;
18178
19264
  /**
18179
19265
  * @remarks
18180
- * The maximum number of concurrent connections in the cluster.
19266
+ * Maximum concurrent connections of the cluster.
18181
19267
  *
18182
19268
  * @example
18183
19269
  * 8000
@@ -18185,34 +19271,55 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18185
19271
  maxConnections?: number;
18186
19272
  /**
18187
19273
  * @remarks
18188
- * The maximum input/output operations per second (IOPS).
19274
+ * Maximum number of I/O requests, that is, IOPS.
18189
19275
  *
18190
19276
  * @example
18191
19277
  * 32000
18192
19278
  */
18193
19279
  maxIOPS?: number;
18194
19280
  /**
19281
+ * @remarks
19282
+ * Node memory size, in MB.
19283
+ *
18195
19284
  * @example
18196
19285
  * 8192
18197
19286
  */
18198
19287
  memorySize?: string;
19288
+ /**
19289
+ * @remarks
19290
+ * The name of the hot standby compute node corresponding to the node when the hot standby storage and compute clusters feature is enabled.
19291
+ *
19292
+ * @example
19293
+ * pi-bp18z52mirror*****
19294
+ */
18199
19295
  mirrorInsName?: string;
19296
+ multiMasterLocalStandby?: string;
19297
+ multiMasterPrimaryNode?: string;
18200
19298
  /**
19299
+ * @remarks
19300
+ * Orca feature, valid values are:
19301
+ * - on: enabled
19302
+ * - off: disabled
19303
+ *
18201
19304
  * @example
18202
19305
  * off
18203
19306
  */
18204
19307
  orca?: string;
18205
19308
  /**
19309
+ * @remarks
19310
+ * Remote memory size, in MB.
19311
+ *
18206
19312
  * @example
18207
19313
  * 3072
18208
19314
  */
18209
19315
  remoteMemorySize?: string;
18210
19316
  /**
18211
19317
  * @remarks
18212
- * Indicates whether the global consistency (high-performance mode) feature is enabled for the node. Valid values:
19318
+ * Whether the node has the global consistency (high-performance mode) feature enabled. Possible values are:
18213
19319
  *
18214
- * * **ON**
18215
- * * **OFF**
19320
+ * - **ON**: Enabled
19321
+ *
19322
+ * - **OFF**: Disabled
18216
19323
  *
18217
19324
  * This parameter is required.
18218
19325
  *
@@ -18222,7 +19329,8 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18222
19329
  sccMode?: string;
18223
19330
  /**
18224
19331
  * @remarks
18225
- * The routing weight of the node. Valid values: 1 to 100 Default value: 1.
19332
+ * Routing weight.
19333
+ * Range: 1~100. Default is 1.
18226
19334
  *
18227
19335
  * @example
18228
19336
  * 1
@@ -18230,22 +19338,31 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18230
19338
  serverWeight?: string;
18231
19339
  /**
18232
19340
  * @remarks
18233
- * The type of the serverless node. Only **AgileServerless** can be returned.
19341
+ * Serverless type. Possible values include:
18234
19342
  *
18235
- * > This parameter is supported only for serverless clusters.
19343
+ * - **AgileServerless**: Agile
19344
+ * - **SteadyServerless**: Steady
19345
+ *
19346
+ * > This parameter is only supported by Serverless clusters.
18236
19347
  *
18237
19348
  * @example
18238
19349
  * AgileServerless
18239
19350
  */
18240
19351
  serverlessType?: string;
18241
19352
  /**
19353
+ * @remarks
19354
+ * Identifies whether the node is in the primary or standby availability zone, primarily used in resource mirroring scenarios.
19355
+ * Values include:
19356
+ * - **Primary**: Primary Availability Zone
19357
+ * - **Standby**: Standby Availability Zone
19358
+ *
18242
19359
  * @example
18243
19360
  * Primary
18244
19361
  */
18245
19362
  subCluster?: string;
18246
19363
  /**
18247
19364
  * @remarks
18248
- * The ID of the zone.
19365
+ * Availability zone ID.
18249
19366
  *
18250
19367
  * @example
18251
19368
  * cn-hangzhou-i
@@ -18264,7 +19381,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
18264
19381
  export declare class DescribeDBClusterAttributeResponseBodyTags extends $tea.Model {
18265
19382
  /**
18266
19383
  * @remarks
18267
- * The key of the tag.
19384
+ * Tag key.
18268
19385
  *
18269
19386
  * @example
18270
19387
  * test
@@ -18272,7 +19389,7 @@ export declare class DescribeDBClusterAttributeResponseBodyTags extends $tea.Mod
18272
19389
  key?: string;
18273
19390
  /**
18274
19391
  * @remarks
18275
- * The value of the tag.
19392
+ * Tag value.
18276
19393
  *
18277
19394
  * @example
18278
19395
  * MySQL
@@ -18784,7 +19901,12 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
18784
19901
  addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
18785
19902
  /**
18786
19903
  * @remarks
18787
- * The type of the source database.
19904
+ * The role of the source database instance.
19905
+ *
19906
+ * @example
19907
+ * ReadOnly
19908
+ * Maxscale
19909
+ * Primary
18788
19910
  */
18789
19911
  custinsType?: string;
18790
19912
  /**
@@ -19656,6 +20778,16 @@ export declare class DescribeDBClustersResponseBodyItemsDBCluster extends $tea.M
19656
20778
  * false
19657
20779
  */
19658
20780
  expired?: string;
20781
+ /**
20782
+ * @remarks
20783
+ * Indicates whether the hot standby storage cluster feature is enabled. Valid values:
20784
+ *
20785
+ * * ON
20786
+ * * OFF
20787
+ *
20788
+ * @example
20789
+ * OFF
20790
+ */
19659
20791
  hotStandbyCluster?: string;
19660
20792
  /**
19661
20793
  * @remarks
@@ -20912,6 +22044,13 @@ export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClustersDBNodes
20912
22044
  });
20913
22045
  }
20914
22046
  export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClusters extends $tea.Model {
22047
+ /**
22048
+ * @remarks
22049
+ * The edition of the cluster.
22050
+ *
22051
+ * @example
22052
+ * Normal
22053
+ */
20915
22054
  category?: string;
20916
22055
  /**
20917
22056
  * @remarks
@@ -21275,6 +22414,82 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecu
21275
22414
  [key: string]: any;
21276
22415
  });
21277
22416
  }
22417
+ export declare class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
22418
+ /**
22419
+ * @example
22420
+ * 10
22421
+ */
22422
+ activatedCodeCount?: number;
22423
+ /**
22424
+ * @example
22425
+ * 10
22426
+ */
22427
+ activationCodeQuota?: number;
22428
+ /**
22429
+ * @example
22430
+ * 227638319690519
22431
+ */
22432
+ aliyunOrderId?: string;
22433
+ /**
22434
+ * @example
22435
+ * false
22436
+ */
22437
+ allowEmptySystemIdentifier?: boolean;
22438
+ /**
22439
+ * @example
22440
+ * PG
22441
+ */
22442
+ engine?: string;
22443
+ /**
22444
+ * @example
22445
+ * 2022-02-11 03:14:15
22446
+ */
22447
+ gmtCreated?: string;
22448
+ /**
22449
+ * @example
22450
+ * 2022-02-11 03:14:15
22451
+ */
22452
+ gmtModified?: string;
22453
+ /**
22454
+ * @example
22455
+ * false
22456
+ */
22457
+ isVirtualOrder?: boolean;
22458
+ /**
22459
+ * @example
22460
+ * false
22461
+ */
22462
+ isVirtualOrderFrozen?: boolean;
22463
+ /**
22464
+ * @example
22465
+ * single_node_subscribe
22466
+ */
22467
+ packageType?: string;
22468
+ /**
22469
+ * @example
22470
+ * 1 year
22471
+ */
22472
+ packageValidity?: string;
22473
+ /**
22474
+ * @example
22475
+ * aliyun_public
22476
+ */
22477
+ purchaseChannel?: string;
22478
+ /**
22479
+ * @example
22480
+ * 227638319690519
22481
+ */
22482
+ virtualAliyunOrderId?: string;
22483
+ static names(): {
22484
+ [key: string]: string;
22485
+ };
22486
+ static types(): {
22487
+ [key: string]: any;
22488
+ };
22489
+ constructor(map?: {
22490
+ [key: string]: any;
22491
+ });
22492
+ }
21278
22493
  export declare class DescribeMaskingRulesResponseBodyData extends $tea.Model {
21279
22494
  /**
21280
22495
  * @remarks
@@ -21904,6 +23119,14 @@ export declare class DescribeScheduleTasksResponseBodyDataTimerInfos extends $te
21904
23119
  * CreateDBNodes
21905
23120
  */
21906
23121
  action?: string;
23122
+ /**
23123
+ * @remarks
23124
+ * The ID of the scheduled task.
23125
+ *
23126
+ * @example
23127
+ * 86293c29-a03d-4872-b625-***********
23128
+ */
23129
+ crontabJobId?: string;
21907
23130
  /**
21908
23131
  * @remarks
21909
23132
  * The cluster ID.
@@ -22027,7 +23250,7 @@ export declare class DescribeScheduleTasksResponseBodyData extends $tea.Model {
22027
23250
  pageSize?: number;
22028
23251
  /**
22029
23252
  * @remarks
22030
- * The details of the scheduled task.
23253
+ * The details of the scheduled tasks.
22031
23254
  */
22032
23255
  timerInfos?: DescribeScheduleTasksResponseBodyDataTimerInfos[];
22033
23256
  /**
@@ -22051,7 +23274,7 @@ export declare class DescribeScheduleTasksResponseBodyData extends $tea.Model {
22051
23274
  export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extends $tea.Model {
22052
23275
  /**
22053
23276
  * @remarks
22054
- * The name of the database.
23277
+ * Database name.
22055
23278
  *
22056
23279
  * @example
22057
23280
  * testdb
@@ -22059,7 +23282,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22059
23282
  DBName?: string;
22060
23283
  /**
22061
23284
  * @remarks
22062
- * The ID of the node.
23285
+ * Node ID.
22063
23286
  *
22064
23287
  * @example
22065
23288
  * pi-*****************
@@ -22067,7 +23290,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22067
23290
  DBNodeId?: string;
22068
23291
  /**
22069
23292
  * @remarks
22070
- * The time when the SQL statement was executed. The time is in the `yyyy-MM-ddTHH:mmZ` format. The time is displayed in UTC.
23293
+ * Time when the SQL starts execution. The format is `YYYY-MM-DDThh:mmZ` (UTC time).
22071
23294
  *
22072
23295
  * @example
22073
23296
  * 2021-04-07T03:47Z
@@ -22075,7 +23298,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22075
23298
  executionStartTime?: string;
22076
23299
  /**
22077
23300
  * @remarks
22078
- * The IP address of the client that is used to connect to the database.
23301
+ * Client address connecting to the database.
22079
23302
  *
22080
23303
  * @example
22081
23304
  * testdb[testdb] @ [100.**.**.242]
@@ -22083,7 +23306,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22083
23306
  hostAddress?: string;
22084
23307
  /**
22085
23308
  * @remarks
22086
- * The period of time during which the SQL statement was locked. Unit: seconds.
23309
+ * SQL lock duration in seconds.
22087
23310
  *
22088
23311
  * @example
22089
23312
  * 0
@@ -22091,7 +23314,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22091
23314
  lockTimes?: number;
22092
23315
  /**
22093
23316
  * @remarks
22094
- * The number of rows parsed by the SQL statement.
23317
+ * Number of rows parsed.
22095
23318
  *
22096
23319
  * @example
22097
23320
  * 0
@@ -22099,7 +23322,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22099
23322
  parseRowCounts?: number;
22100
23323
  /**
22101
23324
  * @remarks
22102
- * The time range for the query. Unit: milliseconds.
23325
+ * Query time. Unit: milliseconds.
22103
23326
  *
22104
23327
  * @example
22105
23328
  * 100
@@ -22107,7 +23330,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22107
23330
  queryTimeMS?: number;
22108
23331
  /**
22109
23332
  * @remarks
22110
- * The amount of time that was consumed to execute the SQL statement. Unit: seconds.
23333
+ * SQL execution duration, in seconds.
22111
23334
  *
22112
23335
  * @example
22113
23336
  * 20
@@ -22115,16 +23338,23 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
22115
23338
  queryTimes?: number;
22116
23339
  /**
22117
23340
  * @remarks
22118
- * The number of rows returned by the SQL statement.
23341
+ * Number of rows returned.
22119
23342
  *
22120
23343
  * @example
22121
23344
  * 0
22122
23345
  */
22123
23346
  returnRowCounts?: number;
23347
+ /**
23348
+ * @remarks
23349
+ * Unique identifier for the SQL statement in slow log statistics.
23350
+ *
23351
+ * @example
23352
+ * U2FsdGVk****
23353
+ */
22124
23354
  SQLHash?: string;
22125
23355
  /**
22126
23356
  * @remarks
22127
- * The SQL statement that is executed in the query.
23357
+ * Query statement.
22128
23358
  */
22129
23359
  SQLText?: string;
22130
23360
  static names(): {
@@ -22509,7 +23739,7 @@ export declare class DescribeVSwitchesResponseBodyVSwitchs extends $tea.Model {
22509
23739
  export declare class ListTagResourcesRequestTag extends $tea.Model {
22510
23740
  /**
22511
23741
  * @remarks
22512
- * The key of the tag. To query the details of clusters to which multiple tags are bound, click **Add** to add tags.
23742
+ * The tag key. To query the details of clusters to which multiple tags are added, click **Add** to add tags.
22513
23743
  *
22514
23744
  * >
22515
23745
  *
@@ -22780,9 +24010,9 @@ export declare class ModifyGlobalSecurityIPGroupRelationResponseBodyGlobalSecuri
22780
24010
  export declare class TagResourcesRequestTag extends $tea.Model {
22781
24011
  /**
22782
24012
  * @remarks
22783
- * The key of the tag. To create multiple tags for a cluster at a time, click **Add** to add tag keys.
24013
+ * The key of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click **Add** to add tag keys.
22784
24014
  *
22785
- * > You can create up to 20 tags at a time. A tag consists of a key and a value. Each value of `Tag.N.Key` is paired with a value of `Tag.N.Value`.
24015
+ * > You can create up to 20 tags for a cluster at a time. The value of `Tag.N.Key` is paired with the value of `Tag.N.Value`.
22786
24016
  *
22787
24017
  * @example
22788
24018
  * type
@@ -22790,9 +24020,9 @@ export declare class TagResourcesRequestTag extends $tea.Model {
22790
24020
  key?: string;
22791
24021
  /**
22792
24022
  * @remarks
22793
- * The value of the tag. To create multiple tags for a cluster at a time, click **Add** to add tag values.
24023
+ * The value of the tag that you want to create for the cluster. To create multiple tags for a cluster at a time, click **Add** to add tag values.
22794
24024
  *
22795
- * > You can create up to 20 tags at a time. A tag consists of a key and a value. Each value of `Tag.N.Value` is paired with a value of `Tag.N.Key`.
24025
+ * > You can create up to 20 tags for a cluster at a time. The value of `Tag.N.Key` is paired with the value of `Tag.N.Value`.
22796
24026
  *
22797
24027
  * @example
22798
24028
  * test
@@ -22972,6 +24202,21 @@ export default class Client extends OpenApi {
22972
24202
  * @returns CreateAccountResponse
22973
24203
  */
22974
24204
  createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
24205
+ /**
24206
+ * 生成轻量化版本激活码
24207
+ *
24208
+ * @param request - CreateActivationCodeRequest
24209
+ * @param runtime - runtime options for this request RuntimeOptions
24210
+ * @returns CreateActivationCodeResponse
24211
+ */
24212
+ createActivationCodeWithOptions(request: CreateActivationCodeRequest, runtime: $Util.RuntimeOptions): Promise<CreateActivationCodeResponse>;
24213
+ /**
24214
+ * 生成轻量化版本激活码
24215
+ *
24216
+ * @param request - CreateActivationCodeRequest
24217
+ * @returns CreateActivationCodeResponse
24218
+ */
24219
+ createActivationCode(request: CreateActivationCodeRequest): Promise<CreateActivationCodeResponse>;
22975
24220
  /**
22976
24221
  * Creates a full snapshot backup for a PolarDB cluster.
22977
24222
  *
@@ -23000,7 +24245,7 @@ export default class Client extends OpenApi {
23000
24245
  */
23001
24246
  createBackup(request: CreateBackupRequest): Promise<CreateBackupResponse>;
23002
24247
  /**
23003
- * 创建冷存储实例
24248
+ * Creates a cluster that is used to store cold data.
23004
24249
  *
23005
24250
  * @param request - CreateColdStorageInstanceRequest
23006
24251
  * @param runtime - runtime options for this request RuntimeOptions
@@ -23008,14 +24253,14 @@ export default class Client extends OpenApi {
23008
24253
  */
23009
24254
  createColdStorageInstanceWithOptions(request: CreateColdStorageInstanceRequest, runtime: $Util.RuntimeOptions): Promise<CreateColdStorageInstanceResponse>;
23010
24255
  /**
23011
- * 创建冷存储实例
24256
+ * Creates a cluster that is used to store cold data.
23012
24257
  *
23013
24258
  * @param request - CreateColdStorageInstanceRequest
23014
24259
  * @returns CreateColdStorageInstanceResponse
23015
24260
  */
23016
24261
  createColdStorageInstance(request: CreateColdStorageInstanceRequest): Promise<CreateColdStorageInstanceResponse>;
23017
24262
  /**
23018
- * Creates a PolarDB cluster.
24263
+ * Create Database Cluster
23019
24264
  *
23020
24265
  * @param request - CreateDBClusterRequest
23021
24266
  * @param runtime - runtime options for this request RuntimeOptions
@@ -23023,7 +24268,7 @@ export default class Client extends OpenApi {
23023
24268
  */
23024
24269
  createDBClusterWithOptions(request: CreateDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBClusterResponse>;
23025
24270
  /**
23026
- * Creates a PolarDB cluster.
24271
+ * Create Database Cluster
23027
24272
  *
23028
24273
  * @param request - CreateDBClusterRequest
23029
24274
  * @returns CreateDBClusterResponse
@@ -23168,6 +24413,21 @@ export default class Client extends OpenApi {
23168
24413
  * @returns CreateGlobalSecurityIPGroupResponse
23169
24414
  */
23170
24415
  createGlobalSecurityIPGroup(request: CreateGlobalSecurityIPGroupRequest): Promise<CreateGlobalSecurityIPGroupResponse>;
24416
+ /**
24417
+ * 创建或获取虚拟证书订单
24418
+ *
24419
+ * @param request - CreateOrGetVirtualLicenseOrderRequest
24420
+ * @param runtime - runtime options for this request RuntimeOptions
24421
+ * @returns CreateOrGetVirtualLicenseOrderResponse
24422
+ */
24423
+ createOrGetVirtualLicenseOrderWithOptions(request: CreateOrGetVirtualLicenseOrderRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrGetVirtualLicenseOrderResponse>;
24424
+ /**
24425
+ * 创建或获取虚拟证书订单
24426
+ *
24427
+ * @param request - CreateOrGetVirtualLicenseOrderRequest
24428
+ * @returns CreateOrGetVirtualLicenseOrderResponse
24429
+ */
24430
+ createOrGetVirtualLicenseOrder(request: CreateOrGetVirtualLicenseOrderRequest): Promise<CreateOrGetVirtualLicenseOrderResponse>;
23171
24431
  /**
23172
24432
  * Creates a parameter template.
23173
24433
  *
@@ -23452,7 +24712,7 @@ export default class Client extends OpenApi {
23452
24712
  */
23453
24713
  deleteParameterGroup(request: DeleteParameterGroupRequest): Promise<DeleteParameterGroupResponse>;
23454
24714
  /**
23455
- * Queries the state of the PolarDB for AI feature for a cluster.
24715
+ * Queries the status of the PolarDB for AI feature.
23456
24716
  *
23457
24717
  * @param request - DescribeAITaskStatusRequest
23458
24718
  * @param runtime - runtime options for this request RuntimeOptions
@@ -23460,7 +24720,7 @@ export default class Client extends OpenApi {
23460
24720
  */
23461
24721
  describeAITaskStatusWithOptions(request: DescribeAITaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAITaskStatusResponse>;
23462
24722
  /**
23463
- * Queries the state of the PolarDB for AI feature for a cluster.
24723
+ * Queries the status of the PolarDB for AI feature.
23464
24724
  *
23465
24725
  * @param request - DescribeAITaskStatusRequest
23466
24726
  * @returns DescribeAITaskStatusResponse
@@ -23481,6 +24741,36 @@ export default class Client extends OpenApi {
23481
24741
  * @returns DescribeAccountsResponse
23482
24742
  */
23483
24743
  describeAccounts(request: DescribeAccountsRequest): Promise<DescribeAccountsResponse>;
24744
+ /**
24745
+ * 查询激活码详情
24746
+ *
24747
+ * @param request - DescribeActivationCodeDetailsRequest
24748
+ * @param runtime - runtime options for this request RuntimeOptions
24749
+ * @returns DescribeActivationCodeDetailsResponse
24750
+ */
24751
+ describeActivationCodeDetailsWithOptions(request: DescribeActivationCodeDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodeDetailsResponse>;
24752
+ /**
24753
+ * 查询激活码详情
24754
+ *
24755
+ * @param request - DescribeActivationCodeDetailsRequest
24756
+ * @returns DescribeActivationCodeDetailsResponse
24757
+ */
24758
+ describeActivationCodeDetails(request: DescribeActivationCodeDetailsRequest): Promise<DescribeActivationCodeDetailsResponse>;
24759
+ /**
24760
+ * 查询激活码列表
24761
+ *
24762
+ * @param request - DescribeActivationCodesRequest
24763
+ * @param runtime - runtime options for this request RuntimeOptions
24764
+ * @returns DescribeActivationCodesResponse
24765
+ */
24766
+ describeActivationCodesWithOptions(request: DescribeActivationCodesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodesResponse>;
24767
+ /**
24768
+ * 查询激活码列表
24769
+ *
24770
+ * @param request - DescribeActivationCodesRequest
24771
+ * @returns DescribeActivationCodesResponse
24772
+ */
24773
+ describeActivationCodes(request: DescribeActivationCodesRequest): Promise<DescribeActivationCodesResponse>;
23484
24774
  /**
23485
24775
  * Queries the auto-renewal attributes of a subscription PolarDB cluster.
23486
24776
  *
@@ -23803,7 +25093,7 @@ export default class Client extends OpenApi {
23803
25093
  */
23804
25094
  describeDBClusterServerlessConf(request: DescribeDBClusterServerlessConfRequest): Promise<DescribeDBClusterServerlessConfResponse>;
23805
25095
  /**
23806
- * Queries the Transparent Data Encryption (TDE) settings of a PolarDB for MySQL cluster.
25096
+ * Queries the transparent data encryption (TDE) settings of a PolarDB cluster.
23807
25097
  *
23808
25098
  * @param request - DescribeDBClusterTDERequest
23809
25099
  * @param runtime - runtime options for this request RuntimeOptions
@@ -23811,7 +25101,7 @@ export default class Client extends OpenApi {
23811
25101
  */
23812
25102
  describeDBClusterTDEWithOptions(request: DescribeDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterTDEResponse>;
23813
25103
  /**
23814
- * Queries the Transparent Data Encryption (TDE) settings of a PolarDB for MySQL cluster.
25104
+ * Queries the transparent data encryption (TDE) settings of a PolarDB cluster.
23815
25105
  *
23816
25106
  * @param request - DescribeDBClusterTDERequest
23817
25107
  * @returns DescribeDBClusterTDEResponse
@@ -24090,6 +25380,36 @@ export default class Client extends OpenApi {
24090
25380
  * @returns DescribeGlobalSecurityIPGroupRelationResponse
24091
25381
  */
24092
25382
  describeGlobalSecurityIPGroupRelation(request: DescribeGlobalSecurityIPGroupRelationRequest): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
25383
+ /**
25384
+ * 查看License订单详情
25385
+ *
25386
+ * @param request - DescribeLicenseOrderDetailsRequest
25387
+ * @param runtime - runtime options for this request RuntimeOptions
25388
+ * @returns DescribeLicenseOrderDetailsResponse
25389
+ */
25390
+ describeLicenseOrderDetailsWithOptions(request: DescribeLicenseOrderDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrderDetailsResponse>;
25391
+ /**
25392
+ * 查看License订单详情
25393
+ *
25394
+ * @param request - DescribeLicenseOrderDetailsRequest
25395
+ * @returns DescribeLicenseOrderDetailsResponse
25396
+ */
25397
+ describeLicenseOrderDetails(request: DescribeLicenseOrderDetailsRequest): Promise<DescribeLicenseOrderDetailsResponse>;
25398
+ /**
25399
+ * 查询License订单列表
25400
+ *
25401
+ * @param request - DescribeLicenseOrdersRequest
25402
+ * @param runtime - runtime options for this request RuntimeOptions
25403
+ * @returns DescribeLicenseOrdersResponse
25404
+ */
25405
+ describeLicenseOrdersWithOptions(request: DescribeLicenseOrdersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrdersResponse>;
25406
+ /**
25407
+ * 查询License订单列表
25408
+ *
25409
+ * @param request - DescribeLicenseOrdersRequest
25410
+ * @returns DescribeLicenseOrdersResponse
25411
+ */
25412
+ describeLicenseOrders(request: DescribeLicenseOrdersRequest): Promise<DescribeLicenseOrdersResponse>;
24093
25413
  /**
24094
25414
  * Queries the retention policy of log backups in a PolarDB cluster.
24095
25415
  *
@@ -24272,10 +25592,11 @@ export default class Client extends OpenApi {
24272
25592
  */
24273
25593
  describeScheduleTasks(request: DescribeScheduleTasksRequest): Promise<DescribeScheduleTasksResponse>;
24274
25594
  /**
24275
- * Queries the details of the slow query logs of a PolarDB cluster.
25595
+ * Slow Log Details
24276
25596
  *
24277
25597
  * @remarks
24278
- * > This operation is applicable only to PolarDB for MySQL clusters.
25598
+ * >- Only PolarDB MySQL Edition clusters support calling this interface.
25599
+ * >- Starting from September 1, 2024, due to the optimization of the SQL template algorithm, when calling this interface, the value of the SQLHash field will change. For more details, please refer to [Notice] Optimization of Slow SQL Template Algorithm (~~2845725~~).
24279
25600
  *
24280
25601
  * @param request - DescribeSlowLogRecordsRequest
24281
25602
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24283,10 +25604,11 @@ export default class Client extends OpenApi {
24283
25604
  */
24284
25605
  describeSlowLogRecordsWithOptions(request: DescribeSlowLogRecordsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSlowLogRecordsResponse>;
24285
25606
  /**
24286
- * Queries the details of the slow query logs of a PolarDB cluster.
25607
+ * Slow Log Details
24287
25608
  *
24288
25609
  * @remarks
24289
- * > This operation is applicable only to PolarDB for MySQL clusters.
25610
+ * >- Only PolarDB MySQL Edition clusters support calling this interface.
25611
+ * >- Starting from September 1, 2024, due to the optimization of the SQL template algorithm, when calling this interface, the value of the SQLHash field will change. For more details, please refer to [Notice] Optimization of Slow SQL Template Algorithm (~~2845725~~).
24290
25612
  *
24291
25613
  * @param request - DescribeSlowLogRecordsRequest
24292
25614
  * @returns DescribeSlowLogRecordsResponse
@@ -24314,10 +25636,10 @@ export default class Client extends OpenApi {
24314
25636
  */
24315
25637
  describeSlowLogs(request: DescribeSlowLogsRequest): Promise<DescribeSlowLogsResponse>;
24316
25638
  /**
24317
- * Queries the details of the tasks that are generated by calling API operations. For example, you can call this operation to view the details of the task when you create a cluster.
25639
+ * Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.
24318
25640
  *
24319
25641
  * @remarks
24320
- * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the console.
25642
+ * You can call this operation to view the details of a task that is generated by a specific API operation or in the PolarDB console. The system calls the specific API operation when you perform an operation in the PolarDB console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the PolarDB console.
24321
25643
  * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
24322
25644
  *
24323
25645
  * @param request - DescribeTasksRequest
@@ -24326,10 +25648,10 @@ export default class Client extends OpenApi {
24326
25648
  */
24327
25649
  describeTasksWithOptions(request: DescribeTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeTasksResponse>;
24328
25650
  /**
24329
- * Queries the details of the tasks that are generated by calling API operations. For example, you can call this operation to view the details of the task when you create a cluster.
25651
+ * Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.
24330
25652
  *
24331
25653
  * @remarks
24332
- * You can call this operation to view the details of a task that is generated by a specific API operation or in the console. The system calls the specific API operation when you perform an operation in the console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the console.
25654
+ * You can call this operation to view the details of a task that is generated by a specific API operation or in the PolarDB console. The system calls the specific API operation when you perform an operation in the PolarDB console. For example, you can view the details of the task when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation or [create a cluster](https://help.aliyun.com/document_detail/58769.html) in the PolarDB console.
24333
25655
  * * You can view the details of tasks that are generated only when you call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create a cluster and `CreationOption` is not set to `CreateGdnStandby`.
24334
25656
  *
24335
25657
  * @param request - DescribeTasksRequest
@@ -24397,7 +25719,7 @@ export default class Client extends OpenApi {
24397
25719
  */
24398
25720
  enableDBClusterServerless(request: EnableDBClusterServerlessRequest): Promise<EnableDBClusterServerlessResponse>;
24399
25721
  /**
24400
- * 修改sql防火墙状态
25722
+ * Modifies the status of SQL firewall rules for a cluster.
24401
25723
  *
24402
25724
  * @param request - EnableFirewallRulesRequest
24403
25725
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24405,7 +25727,7 @@ export default class Client extends OpenApi {
24405
25727
  */
24406
25728
  enableFirewallRulesWithOptions(request: EnableFirewallRulesRequest, runtime: $Util.RuntimeOptions): Promise<EnableFirewallRulesResponse>;
24407
25729
  /**
24408
- * 修改sql防火墙状态
25730
+ * Modifies the status of SQL firewall rules for a cluster.
24409
25731
  *
24410
25732
  * @param request - EnableFirewallRulesRequest
24411
25733
  * @returns EnableFirewallRulesResponse
@@ -24471,7 +25793,7 @@ export default class Client extends OpenApi {
24471
25793
  */
24472
25794
  grantAccountPrivilege(request: GrantAccountPrivilegeRequest): Promise<GrantAccountPrivilegeResponse>;
24473
25795
  /**
24474
- * Queries the tags that are bound to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are bound.
25796
+ * Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added.
24475
25797
  *
24476
25798
  * @param request - ListTagResourcesRequest
24477
25799
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24479,7 +25801,7 @@ export default class Client extends OpenApi {
24479
25801
  */
24480
25802
  listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
24481
25803
  /**
24482
- * Queries the tags that are bound to one or more PolarDB clusters, or queries the PolarDB clusters to which one or more tags are bound.
25804
+ * Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added.
24483
25805
  *
24484
25806
  * @param request - ListTagResourcesRequest
24485
25807
  * @returns ListTagResourcesResponse
@@ -24799,12 +26121,16 @@ export default class Client extends OpenApi {
24799
26121
  */
24800
26122
  modifyDBClusterPrimaryZone(request: ModifyDBClusterPrimaryZoneRequest): Promise<ModifyDBClusterPrimaryZoneResponse>;
24801
26123
  /**
26124
+ * Modifies the configurations of a resource group for a database cluster.
26125
+ *
24802
26126
  * @param request - ModifyDBClusterResourceGroupRequest
24803
26127
  * @param runtime - runtime options for this request RuntimeOptions
24804
26128
  * @returns ModifyDBClusterResourceGroupResponse
24805
26129
  */
24806
26130
  modifyDBClusterResourceGroupWithOptions(request: ModifyDBClusterResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterResourceGroupResponse>;
24807
26131
  /**
26132
+ * Modifies the configurations of a resource group for a database cluster.
26133
+ *
24808
26134
  * @param request - ModifyDBClusterResourceGroupRequest
24809
26135
  * @returns ModifyDBClusterResourceGroupResponse
24810
26136
  */
@@ -24855,7 +26181,7 @@ export default class Client extends OpenApi {
24855
26181
  */
24856
26182
  modifyDBClusterStorageSpace(request: ModifyDBClusterStorageSpaceRequest): Promise<ModifyDBClusterStorageSpaceResponse>;
24857
26183
  /**
24858
- * Enables the TDE feature or changes the encryption method for a specified PolarDB for MySQL cluster.
26184
+ * Enables the transparent data encryption (TDE) feature for a PolarDB cluster.
24859
26185
  *
24860
26186
  * @remarks
24861
26187
  * > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](https://help.aliyun.com/document_detail/153781.html).
@@ -24867,7 +26193,7 @@ export default class Client extends OpenApi {
24867
26193
  */
24868
26194
  modifyDBClusterTDEWithOptions(request: ModifyDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterTDEResponse>;
24869
26195
  /**
24870
- * Enables the TDE feature or changes the encryption method for a specified PolarDB for MySQL cluster.
26196
+ * Enables the transparent data encryption (TDE) feature for a PolarDB cluster.
24871
26197
  *
24872
26198
  * @remarks
24873
26199
  * > * To perform this operation, you must activate KMS first. For more information, see [Purchase a dedicated KMS instance](https://help.aliyun.com/document_detail/153781.html).
@@ -24923,7 +26249,7 @@ export default class Client extends OpenApi {
24923
26249
  */
24924
26250
  modifyDBNodeClass(request: ModifyDBNodeClassRequest): Promise<ModifyDBNodeClassResponse>;
24925
26251
  /**
24926
- * Enables or disables a cluster node.
26252
+ * Enables or disables the hot standby node in a cluster.
24927
26253
  *
24928
26254
  * @param request - ModifyDBNodeHotReplicaModeRequest
24929
26255
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24931,7 +26257,7 @@ export default class Client extends OpenApi {
24931
26257
  */
24932
26258
  modifyDBNodeHotReplicaModeWithOptions(request: ModifyDBNodeHotReplicaModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeHotReplicaModeResponse>;
24933
26259
  /**
24934
- * Enables or disables a cluster node.
26260
+ * Enables or disables the hot standby node in a cluster.
24935
26261
  *
24936
26262
  * @param request - ModifyDBNodeHotReplicaModeRequest
24937
26263
  * @returns ModifyDBNodeHotReplicaModeResponse
@@ -24968,7 +26294,7 @@ export default class Client extends OpenApi {
24968
26294
  */
24969
26295
  modifyDBNodesParameters(request: ModifyDBNodesParametersRequest): Promise<ModifyDBNodesParametersResponse>;
24970
26296
  /**
24971
- * Modifies a Global Database Network (GDN).
26297
+ * Modifies a global database network (GDN).
24972
26298
  *
24973
26299
  * @param request - ModifyGlobalDatabaseNetworkRequest
24974
26300
  * @param runtime - runtime options for this request RuntimeOptions
@@ -24976,7 +26302,7 @@ export default class Client extends OpenApi {
24976
26302
  */
24977
26303
  modifyGlobalDatabaseNetworkWithOptions(request: ModifyGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalDatabaseNetworkResponse>;
24978
26304
  /**
24979
- * Modifies a Global Database Network (GDN).
26305
+ * Modifies a global database network (GDN).
24980
26306
  *
24981
26307
  * @param request - ModifyGlobalDatabaseNetworkRequest
24982
26308
  * @returns ModifyGlobalDatabaseNetworkResponse
@@ -25233,18 +26559,22 @@ export default class Client extends OpenApi {
25233
26559
  */
25234
26560
  switchOverGlobalDatabaseNetwork(request: SwitchOverGlobalDatabaseNetworkRequest): Promise<SwitchOverGlobalDatabaseNetworkResponse>;
25235
26561
  /**
26562
+ * Creates tags for a PolarDB cluster.
26563
+ *
25236
26564
  * @param request - TagResourcesRequest
25237
26565
  * @param runtime - runtime options for this request RuntimeOptions
25238
26566
  * @returns TagResourcesResponse
25239
26567
  */
25240
26568
  tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
25241
26569
  /**
26570
+ * Creates tags for a PolarDB cluster.
26571
+ *
25242
26572
  * @param request - TagResourcesRequest
25243
26573
  * @returns TagResourcesResponse
25244
26574
  */
25245
26575
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
25246
26576
  /**
25247
- * Temporarily upgrades the configuration of a PolarDB cluster or adds one or more nodes to a cluster.
26577
+ * Temporarily changes the node configurations of a cluster.
25248
26578
  *
25249
26579
  * @param request - TempModifyDBNodeRequest
25250
26580
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25252,7 +26582,7 @@ export default class Client extends OpenApi {
25252
26582
  */
25253
26583
  tempModifyDBNodeWithOptions(request: TempModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<TempModifyDBNodeResponse>;
25254
26584
  /**
25255
- * Temporarily upgrades the configuration of a PolarDB cluster or adds one or more nodes to a cluster.
26585
+ * Temporarily changes the node configurations of a cluster.
25256
26586
  *
25257
26587
  * @param request - TempModifyDBNodeRequest
25258
26588
  * @returns TempModifyDBNodeResponse
@@ -25262,9 +26592,10 @@ export default class Client extends OpenApi {
25262
26592
  * Changes the billing method of a PolarDB cluster.
25263
26593
  *
25264
26594
  * @remarks
25265
- * > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
25266
- * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
25267
- * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
26595
+ * >
26596
+ * * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
26597
+ * * You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
26598
+ * * If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
25268
26599
  *
25269
26600
  * @param request - TransformDBClusterPayTypeRequest
25270
26601
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25275,9 +26606,10 @@ export default class Client extends OpenApi {
25275
26606
  * Changes the billing method of a PolarDB cluster.
25276
26607
  *
25277
26608
  * @remarks
25278
- * > * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
25279
- * >* You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
25280
- * >* If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
26609
+ * >
26610
+ * * PolarDB clusters support the subscription and pay-as-you-go billing methods. You can change the billing method from subscription to pay-as-you-go or from pay-as-you-go to subscription based on your business requirements. For more information, see [Change the billing method from subscription to pay-as-you-go](https://help.aliyun.com/document_detail/172886.html) and [Change the billing method from pay-as-you-go to subscription](https://help.aliyun.com/document_detail/84076.html).
26611
+ * * You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
26612
+ * * If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
25281
26613
  *
25282
26614
  * @param request - TransformDBClusterPayTypeRequest
25283
26615
  * @returns TransformDBClusterPayTypeResponse