@alicloud/polardb20170801 5.1.12 → 5.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +1927 -583
- package/dist/client.js +1032 -81
- package/dist/client.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +2536 -478
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
|
-
* *
|
|
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
|
-
* >
|
|
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
|
-
*
|
|
1041
|
+
* Whether to enable idle pause. Values:
|
|
880
1042
|
*
|
|
881
|
-
*
|
|
882
|
-
* * **false**
|
|
1043
|
+
* - **true**: Enabled
|
|
883
1044
|
*
|
|
884
|
-
*
|
|
1045
|
+
* - **false**: Disabled (default)
|
|
1046
|
+
*
|
|
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
|
-
*
|
|
893
|
-
*
|
|
894
|
-
*
|
|
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
|
-
*
|
|
1065
|
+
* Whether to enable auto-renewal, with available values as follows:
|
|
904
1066
|
*
|
|
905
|
-
*
|
|
906
|
-
*
|
|
1067
|
+
* - **true**: Auto-renew.
|
|
1068
|
+
* - **false**: Do not auto-renew.
|
|
907
1069
|
*
|
|
908
|
-
*
|
|
1070
|
+
* The default is **false**.
|
|
909
1071
|
*
|
|
910
|
-
* > This parameter
|
|
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
|
-
*
|
|
919
|
-
*
|
|
920
|
-
* *
|
|
921
|
-
* *
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
1103
|
+
* The point in time to clone data, with the following options:
|
|
947
1104
|
*
|
|
948
|
-
*
|
|
949
|
-
*
|
|
950
|
-
*
|
|
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
|
-
*
|
|
1109
|
+
* The default value is **LATEST**.
|
|
953
1110
|
*
|
|
954
|
-
* > If
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
971
1133
|
*
|
|
972
|
-
* *
|
|
973
|
-
* *
|
|
974
|
-
* *
|
|
975
|
-
* * **NormalMultimaster**: Multi-master Cluster Edition
|
|
976
|
-
*
|
|
977
|
-
* >
|
|
978
|
-
*
|
|
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**.
|
|
980
|
-
*
|
|
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**.
|
|
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**.
|
|
982
1137
|
*
|
|
983
|
-
* For more information, see [Product
|
|
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
|
-
*
|
|
1146
|
+
* Creation method, with the following values supported:
|
|
992
1147
|
*
|
|
993
|
-
* *
|
|
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)
|
|
994
1152
|
*
|
|
995
|
-
*
|
|
996
|
-
* *
|
|
997
|
-
* *
|
|
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)
|
|
998
1157
|
*
|
|
999
|
-
* *
|
|
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)
|
|
1000
1162
|
*
|
|
1001
|
-
*
|
|
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)
|
|
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).
|
|
1004
1164
|
*
|
|
1005
|
-
* *
|
|
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).
|
|
1006
1166
|
*
|
|
1007
|
-
* *
|
|
1167
|
+
* * **CreateGdnStandby**: Creates a standby cluster. Console operation guide can be found at [Add Standby Cluster](https://help.aliyun.com/document_detail/160381.html).
|
|
1008
1168
|
*
|
|
1009
|
-
* *
|
|
1169
|
+
* * **UpgradeFromPolarDB**: Upgrades and migrates from PolarDB. Console operation guide is detailed in [Major Version Upgrade](https://help.aliyun.com/document_detail/459712.html).
|
|
1010
1170
|
*
|
|
1011
|
-
*
|
|
1171
|
+
* The default value is **Normal**.
|
|
1012
1172
|
*
|
|
1013
|
-
* >
|
|
1014
|
-
*
|
|
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**.
|
|
1016
|
-
*
|
|
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
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
* *
|
|
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
|
-
*
|
|
1191
|
+
* Database engine minor version number. Valid values include:
|
|
1037
1192
|
*
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1193
|
+
* - **8.0.2**
|
|
1194
|
+
* - **8.0.1**
|
|
1040
1195
|
*
|
|
1041
|
-
* > This parameter
|
|
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
|
-
*
|
|
1204
|
+
* Node specifications. For details, refer to the following documents:
|
|
1205
|
+
*
|
|
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).
|
|
1050
1209
|
*
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
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).
|
|
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.
|
|
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
|
-
*
|
|
1234
|
+
* Database engine type, with available values as follows:
|
|
1069
1235
|
*
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
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
|
-
*
|
|
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">
|
|
1083
1258
|
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1086
|
-
* * **5.6**
|
|
1087
|
-
* * **5.7**
|
|
1088
|
-
* * **8.0**
|
|
1089
|
-
*
|
|
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
|
-
* *
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1283
|
+
* Global Database Network (GDN) ID.
|
|
1116
1284
|
*
|
|
1117
|
-
* > This parameter is required
|
|
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
|
-
*
|
|
1136
|
-
*
|
|
1137
|
-
* * **ON**
|
|
1138
|
-
* * **OFF**
|
|
1315
|
+
* Enable the X-Engine storage engine feature, with valid values as follows:
|
|
1139
1316
|
*
|
|
1140
|
-
*
|
|
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
|
-
*
|
|
1154
|
-
*
|
|
1155
|
-
* *
|
|
1156
|
-
* * **0**: The table names are case-sensitive.
|
|
1157
|
-
*
|
|
1158
|
-
* Default value: **1**.
|
|
1336
|
+
* Whether table names are case-sensitive, with valid values as follows:
|
|
1337
|
+
* * **1**: Case-insensitive
|
|
1338
|
+
* * **0**: Case-sensitive
|
|
1159
1339
|
*
|
|
1160
|
-
*
|
|
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
|
-
*
|
|
1351
|
+
* Parameter template ID.
|
|
1171
1352
|
*
|
|
1172
|
-
* > You can
|
|
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
|
-
*
|
|
1361
|
+
* Payment type, with available values as follows:
|
|
1181
1362
|
*
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1196
|
-
*
|
|
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
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
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
|
-
*
|
|
1424
|
+
* Region ID.
|
|
1227
1425
|
*
|
|
1228
|
-
* > You can
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1446
|
+
* Maximum scaling limit for a single node. The value range is: 1 PCU~32 PCU.
|
|
1249
1447
|
*
|
|
1250
|
-
* >
|
|
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
|
-
*
|
|
1456
|
+
* Minimum scaling limit for a single node. The value range is: 1 PCU~31 PCU.
|
|
1259
1457
|
*
|
|
1260
|
-
* >
|
|
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
|
-
*
|
|
1466
|
+
* Maximum scaling limit for the number of read-only nodes. The value range is: 0~15.
|
|
1269
1467
|
*
|
|
1270
|
-
* >
|
|
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
|
-
*
|
|
1476
|
+
* Minimum scaling limit for the number of read-only nodes. The value range is: 0~15.
|
|
1279
1477
|
*
|
|
1280
|
-
* >
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
* *
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1559
|
+
* Enterprise edition storage types include:
|
|
1560
|
+
* - **PSL5**
|
|
1561
|
+
* - **PSL4**
|
|
1343
1562
|
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1598
|
+
* Enables TDE encryption. Valid values are as follows:
|
|
1379
1599
|
*
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1383
|
-
* >
|
|
1384
|
-
*
|
|
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
|
-
* *
|
|
1388
|
-
* *
|
|
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
|
-
*
|
|
1613
|
+
* List of tags.
|
|
1397
1614
|
*/
|
|
1398
1615
|
tag?: CreateDBClusterRequestTag[];
|
|
1399
1616
|
/**
|
|
1400
1617
|
* @remarks
|
|
1401
|
-
*
|
|
1402
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1636
|
+
* Virtual switch ID.
|
|
1419
1637
|
*
|
|
1420
|
-
* > If
|
|
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
|
-
*
|
|
1646
|
+
* Availability Zone ID.
|
|
1429
1647
|
*
|
|
1430
|
-
* > You can
|
|
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-
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
1726
|
+
* Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
|
|
1509
1727
|
*
|
|
1510
|
-
* * **Enable**:
|
|
1511
|
-
* * **Disable
|
|
1512
|
-
*
|
|
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;
|
|
@@ -2173,12 +2413,13 @@ export declare class CreateDatabaseRequest extends $tea.Model {
|
|
|
2173
2413
|
characterSetName?: string;
|
|
2174
2414
|
/**
|
|
2175
2415
|
* @remarks
|
|
2176
|
-
* The language that
|
|
2416
|
+
* The language that defines the collation rules in the database.
|
|
2177
2417
|
*
|
|
2178
|
-
* >
|
|
2179
|
-
* >* This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is not supported by PolarDB for MySQL clusters.
|
|
2418
|
+
* >
|
|
2180
2419
|
*
|
|
2181
|
-
*
|
|
2420
|
+
* * The language must be compatible with the character set that is specified by **CharacterSetName**.
|
|
2421
|
+
*
|
|
2422
|
+
* * This parameter is required for a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster. To view the valid values of this parameter, perform the following steps: Log on to the PolarDB console and click the ID of the cluster. In the left-side navigation pane, choose **Settings and Management** > **Databases**. Then, click **Create Database**.
|
|
2182
2423
|
*
|
|
2183
2424
|
* @example
|
|
2184
2425
|
* C
|
|
@@ -2400,56 +2641,174 @@ export declare class CreateGlobalSecurityIPGroupRequest extends $tea.Model {
|
|
|
2400
2641
|
* This parameter is required.
|
|
2401
2642
|
*
|
|
2402
2643
|
* @example
|
|
2403
|
-
* 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
|
|
2404
2777
|
*/
|
|
2405
|
-
|
|
2406
|
-
ownerAccount?: string;
|
|
2407
|
-
ownerId?: number;
|
|
2778
|
+
isVirtualOrder?: boolean;
|
|
2408
2779
|
/**
|
|
2409
|
-
* @remarks
|
|
2410
|
-
* The region ID.
|
|
2411
|
-
*
|
|
2412
|
-
* This parameter is required.
|
|
2413
|
-
*
|
|
2414
2780
|
* @example
|
|
2415
|
-
*
|
|
2781
|
+
* false
|
|
2416
2782
|
*/
|
|
2417
|
-
|
|
2783
|
+
isVirtualOrderFrozen?: boolean;
|
|
2418
2784
|
/**
|
|
2419
|
-
* @remarks
|
|
2420
|
-
* The ID of the resource group.
|
|
2421
|
-
*
|
|
2422
2785
|
* @example
|
|
2423
|
-
*
|
|
2786
|
+
* pre_generation_long_term
|
|
2424
2787
|
*/
|
|
2425
|
-
|
|
2426
|
-
resourceOwnerAccount?: string;
|
|
2427
|
-
resourceOwnerId?: number;
|
|
2428
|
-
securityToken?: string;
|
|
2429
|
-
static names(): {
|
|
2430
|
-
[key: string]: string;
|
|
2431
|
-
};
|
|
2432
|
-
static types(): {
|
|
2433
|
-
[key: string]: any;
|
|
2434
|
-
};
|
|
2435
|
-
constructor(map?: {
|
|
2436
|
-
[key: string]: any;
|
|
2437
|
-
});
|
|
2438
|
-
}
|
|
2439
|
-
export declare class CreateGlobalSecurityIPGroupResponseBody extends $tea.Model {
|
|
2788
|
+
packageType?: string;
|
|
2440
2789
|
/**
|
|
2441
|
-
* @
|
|
2442
|
-
*
|
|
2790
|
+
* @example
|
|
2791
|
+
* 30 years
|
|
2443
2792
|
*/
|
|
2444
|
-
|
|
2793
|
+
packageValidity?: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* @example
|
|
2796
|
+
* aliyun_market
|
|
2797
|
+
*/
|
|
2798
|
+
purchaseChannel?: string;
|
|
2445
2799
|
/**
|
|
2446
2800
|
* @remarks
|
|
2447
|
-
*
|
|
2801
|
+
* Id of the request
|
|
2448
2802
|
*
|
|
2449
2803
|
* @example
|
|
2450
|
-
*
|
|
2804
|
+
* 45D24263-7E3A-4140-9472-************
|
|
2451
2805
|
*/
|
|
2452
2806
|
requestId?: string;
|
|
2807
|
+
/**
|
|
2808
|
+
* @example
|
|
2809
|
+
* 2024********483
|
|
2810
|
+
*/
|
|
2811
|
+
virtualOrderId?: string;
|
|
2453
2812
|
static names(): {
|
|
2454
2813
|
[key: string]: string;
|
|
2455
2814
|
};
|
|
@@ -2460,12 +2819,12 @@ export declare class CreateGlobalSecurityIPGroupResponseBody extends $tea.Model
|
|
|
2460
2819
|
[key: string]: any;
|
|
2461
2820
|
});
|
|
2462
2821
|
}
|
|
2463
|
-
export declare class
|
|
2822
|
+
export declare class CreateOrGetVirtualLicenseOrderResponse extends $tea.Model {
|
|
2464
2823
|
headers?: {
|
|
2465
2824
|
[key: string]: string;
|
|
2466
2825
|
};
|
|
2467
2826
|
statusCode?: number;
|
|
2468
|
-
body?:
|
|
2827
|
+
body?: CreateOrGetVirtualLicenseOrderResponseBody;
|
|
2469
2828
|
static names(): {
|
|
2470
2829
|
[key: string]: string;
|
|
2471
2830
|
};
|
|
@@ -2931,11 +3290,11 @@ export declare class DeleteBackupResponse extends $tea.Model {
|
|
|
2931
3290
|
export declare class DeleteDBClusterRequest extends $tea.Model {
|
|
2932
3291
|
/**
|
|
2933
3292
|
* @remarks
|
|
2934
|
-
* The retention policy
|
|
3293
|
+
* The retention policy applied to the backup sets when the cluster is released. Valid values:
|
|
2935
3294
|
*
|
|
2936
|
-
* * **ALL**: permanently retains all
|
|
2937
|
-
* * **LATEST**: permanently retains the most recent backup
|
|
2938
|
-
* * **NONE**:
|
|
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.
|
|
2939
3298
|
*
|
|
2940
3299
|
* @example
|
|
2941
3300
|
* NONE
|
|
@@ -3806,6 +4165,9 @@ export declare class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
3806
4165
|
/**
|
|
3807
4166
|
* @remarks
|
|
3808
4167
|
* The state description of the PolarDB for AI feature.
|
|
4168
|
+
*
|
|
4169
|
+
* @example
|
|
4170
|
+
* Closed State
|
|
3809
4171
|
*/
|
|
3810
4172
|
statusName?: string;
|
|
3811
4173
|
static names(): {
|
|
@@ -3945,6 +4307,203 @@ export declare class DescribeAccountsResponse extends $tea.Model {
|
|
|
3945
4307
|
[key: string]: any;
|
|
3946
4308
|
});
|
|
3947
4309
|
}
|
|
4310
|
+
export declare class DescribeActivationCodeDetailsRequest extends $tea.Model {
|
|
4311
|
+
/**
|
|
4312
|
+
* @example
|
|
4313
|
+
* 123
|
|
4314
|
+
*/
|
|
4315
|
+
activationCodeId?: number;
|
|
4316
|
+
/**
|
|
4317
|
+
* @remarks
|
|
4318
|
+
* This parameter is required.
|
|
4319
|
+
*
|
|
4320
|
+
* @example
|
|
4321
|
+
* 2233****445566
|
|
4322
|
+
*/
|
|
4323
|
+
aliyunOrderId?: string;
|
|
4324
|
+
ownerAccount?: string;
|
|
4325
|
+
ownerId?: number;
|
|
4326
|
+
resourceOwnerAccount?: string;
|
|
4327
|
+
resourceOwnerId?: number;
|
|
4328
|
+
static names(): {
|
|
4329
|
+
[key: string]: string;
|
|
4330
|
+
};
|
|
4331
|
+
static types(): {
|
|
4332
|
+
[key: string]: any;
|
|
4333
|
+
};
|
|
4334
|
+
constructor(map?: {
|
|
4335
|
+
[key: string]: any;
|
|
4336
|
+
});
|
|
4337
|
+
}
|
|
4338
|
+
export declare class DescribeActivationCodeDetailsResponseBody extends $tea.Model {
|
|
4339
|
+
/**
|
|
4340
|
+
* @example
|
|
4341
|
+
* 2024-10-16 16:46:20
|
|
4342
|
+
*/
|
|
4343
|
+
activateAt?: string;
|
|
4344
|
+
/**
|
|
4345
|
+
* @example
|
|
4346
|
+
* AAEAA******AAA=
|
|
4347
|
+
*/
|
|
4348
|
+
certContentB64?: string;
|
|
4349
|
+
/**
|
|
4350
|
+
* @example
|
|
4351
|
+
* testCode
|
|
4352
|
+
*/
|
|
4353
|
+
description?: string;
|
|
4354
|
+
/**
|
|
4355
|
+
* @example
|
|
4356
|
+
* 2054-10-09 16:46:20
|
|
4357
|
+
*/
|
|
4358
|
+
expireAt?: string;
|
|
4359
|
+
/**
|
|
4360
|
+
* @example
|
|
4361
|
+
* 2024-10-16 16:46:20
|
|
4362
|
+
*/
|
|
4363
|
+
gmtCreated?: string;
|
|
4364
|
+
/**
|
|
4365
|
+
* @example
|
|
4366
|
+
* 2024-10-16 16:46:20
|
|
4367
|
+
*/
|
|
4368
|
+
gmtModified?: string;
|
|
4369
|
+
/**
|
|
4370
|
+
* @example
|
|
4371
|
+
* 123
|
|
4372
|
+
*/
|
|
4373
|
+
id?: number;
|
|
4374
|
+
/**
|
|
4375
|
+
* @example
|
|
4376
|
+
* 12:34:56:78:98:00
|
|
4377
|
+
*/
|
|
4378
|
+
macAddress?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
* @example
|
|
4381
|
+
* testName
|
|
4382
|
+
*/
|
|
4383
|
+
name?: string;
|
|
4384
|
+
/**
|
|
4385
|
+
* @remarks
|
|
4386
|
+
* Id of the request
|
|
4387
|
+
*
|
|
4388
|
+
* @example
|
|
4389
|
+
* F2A9EFA7-915F-4572-8299-85A307******
|
|
4390
|
+
*/
|
|
4391
|
+
requestId?: string;
|
|
4392
|
+
/**
|
|
4393
|
+
* @example
|
|
4394
|
+
* 1234567890123456
|
|
4395
|
+
*/
|
|
4396
|
+
systemIdentifier?: string;
|
|
4397
|
+
static names(): {
|
|
4398
|
+
[key: string]: string;
|
|
4399
|
+
};
|
|
4400
|
+
static types(): {
|
|
4401
|
+
[key: string]: any;
|
|
4402
|
+
};
|
|
4403
|
+
constructor(map?: {
|
|
4404
|
+
[key: string]: any;
|
|
4405
|
+
});
|
|
4406
|
+
}
|
|
4407
|
+
export declare class DescribeActivationCodeDetailsResponse extends $tea.Model {
|
|
4408
|
+
headers?: {
|
|
4409
|
+
[key: string]: string;
|
|
4410
|
+
};
|
|
4411
|
+
statusCode?: number;
|
|
4412
|
+
body?: DescribeActivationCodeDetailsResponseBody;
|
|
4413
|
+
static names(): {
|
|
4414
|
+
[key: string]: string;
|
|
4415
|
+
};
|
|
4416
|
+
static types(): {
|
|
4417
|
+
[key: string]: any;
|
|
4418
|
+
};
|
|
4419
|
+
constructor(map?: {
|
|
4420
|
+
[key: string]: any;
|
|
4421
|
+
});
|
|
4422
|
+
}
|
|
4423
|
+
export declare class DescribeActivationCodesRequest extends $tea.Model {
|
|
4424
|
+
/**
|
|
4425
|
+
* @remarks
|
|
4426
|
+
* This parameter is required.
|
|
4427
|
+
*
|
|
4428
|
+
* @example
|
|
4429
|
+
* 2233****445566
|
|
4430
|
+
*/
|
|
4431
|
+
aliyunOrderId?: string;
|
|
4432
|
+
ownerAccount?: string;
|
|
4433
|
+
ownerId?: number;
|
|
4434
|
+
/**
|
|
4435
|
+
* @example
|
|
4436
|
+
* 1
|
|
4437
|
+
*/
|
|
4438
|
+
pageNumber?: number;
|
|
4439
|
+
/**
|
|
4440
|
+
* @example
|
|
4441
|
+
* 30
|
|
4442
|
+
*/
|
|
4443
|
+
pageSize?: number;
|
|
4444
|
+
resourceOwnerAccount?: string;
|
|
4445
|
+
resourceOwnerId?: number;
|
|
4446
|
+
static names(): {
|
|
4447
|
+
[key: string]: string;
|
|
4448
|
+
};
|
|
4449
|
+
static types(): {
|
|
4450
|
+
[key: string]: any;
|
|
4451
|
+
};
|
|
4452
|
+
constructor(map?: {
|
|
4453
|
+
[key: string]: any;
|
|
4454
|
+
});
|
|
4455
|
+
}
|
|
4456
|
+
export declare class DescribeActivationCodesResponseBody extends $tea.Model {
|
|
4457
|
+
items?: DescribeActivationCodesResponseBodyItems[];
|
|
4458
|
+
/**
|
|
4459
|
+
* @example
|
|
4460
|
+
* 1
|
|
4461
|
+
*/
|
|
4462
|
+
pageNumber?: number;
|
|
4463
|
+
/**
|
|
4464
|
+
* @example
|
|
4465
|
+
* 1
|
|
4466
|
+
*/
|
|
4467
|
+
pageRecordCount?: number;
|
|
4468
|
+
/**
|
|
4469
|
+
* @remarks
|
|
4470
|
+
* Id of the request
|
|
4471
|
+
*
|
|
4472
|
+
* @example
|
|
4473
|
+
* 65D7ACE6-4A61-4B6E-B357-8CB24A******
|
|
4474
|
+
*/
|
|
4475
|
+
requestId?: string;
|
|
4476
|
+
/**
|
|
4477
|
+
* @example
|
|
4478
|
+
* 1
|
|
4479
|
+
*/
|
|
4480
|
+
totalRecordCount?: number;
|
|
4481
|
+
static names(): {
|
|
4482
|
+
[key: string]: string;
|
|
4483
|
+
};
|
|
4484
|
+
static types(): {
|
|
4485
|
+
[key: string]: any;
|
|
4486
|
+
};
|
|
4487
|
+
constructor(map?: {
|
|
4488
|
+
[key: string]: any;
|
|
4489
|
+
});
|
|
4490
|
+
}
|
|
4491
|
+
export declare class DescribeActivationCodesResponse extends $tea.Model {
|
|
4492
|
+
headers?: {
|
|
4493
|
+
[key: string]: string;
|
|
4494
|
+
};
|
|
4495
|
+
statusCode?: number;
|
|
4496
|
+
body?: DescribeActivationCodesResponseBody;
|
|
4497
|
+
static names(): {
|
|
4498
|
+
[key: string]: string;
|
|
4499
|
+
};
|
|
4500
|
+
static types(): {
|
|
4501
|
+
[key: string]: any;
|
|
4502
|
+
};
|
|
4503
|
+
constructor(map?: {
|
|
4504
|
+
[key: string]: any;
|
|
4505
|
+
});
|
|
4506
|
+
}
|
|
3948
4507
|
export declare class DescribeAutoRenewAttributeRequest extends $tea.Model {
|
|
3949
4508
|
/**
|
|
3950
4509
|
* @remarks
|
|
@@ -4981,9 +5540,8 @@ export declare class DescribeDBClusterAccessWhitelistResponse extends $tea.Model
|
|
|
4981
5540
|
export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
|
|
4982
5541
|
/**
|
|
4983
5542
|
* @remarks
|
|
4984
|
-
*
|
|
4985
|
-
*
|
|
4986
|
-
* > 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.
|
|
5543
|
+
* Cluster ID.
|
|
5544
|
+
* > 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.
|
|
4987
5545
|
*
|
|
4988
5546
|
* This parameter is required.
|
|
4989
5547
|
*
|
|
@@ -4993,7 +5551,7 @@ export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
|
|
|
4993
5551
|
DBClusterId?: string;
|
|
4994
5552
|
/**
|
|
4995
5553
|
* @remarks
|
|
4996
|
-
*
|
|
5554
|
+
* Whether to obtain information about AI-related nodes.
|
|
4997
5555
|
*
|
|
4998
5556
|
* @example
|
|
4999
5557
|
* AI
|
|
@@ -5015,29 +5573,37 @@ export declare class DescribeDBClusterAttributeRequest extends $tea.Model {
|
|
|
5015
5573
|
}
|
|
5016
5574
|
export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
5017
5575
|
/**
|
|
5576
|
+
* @remarks
|
|
5577
|
+
* Start time for free AI activation
|
|
5578
|
+
*
|
|
5018
5579
|
* @example
|
|
5019
5580
|
* 2024-03-13T01:20:28Z
|
|
5020
5581
|
*/
|
|
5021
5582
|
aiCreatingTime?: string;
|
|
5022
5583
|
/**
|
|
5023
5584
|
* @remarks
|
|
5024
|
-
*
|
|
5585
|
+
* Types of AI nodes. Values include:
|
|
5025
5586
|
*
|
|
5026
|
-
*
|
|
5027
|
-
*
|
|
5587
|
+
* - **SearchNode**: Search node.
|
|
5588
|
+
* - **DLNode**: AI node.
|
|
5028
5589
|
*
|
|
5029
5590
|
* @example
|
|
5030
5591
|
* DLNode
|
|
5031
5592
|
*/
|
|
5032
5593
|
aiType?: string;
|
|
5033
5594
|
/**
|
|
5595
|
+
* @remarks
|
|
5596
|
+
* CPU architecture. Available options are:
|
|
5597
|
+
* - **X86**
|
|
5598
|
+
* - **ARM**
|
|
5599
|
+
*
|
|
5034
5600
|
* @example
|
|
5035
5601
|
* X86
|
|
5036
5602
|
*/
|
|
5037
5603
|
architecture?: string;
|
|
5038
5604
|
/**
|
|
5039
5605
|
* @remarks
|
|
5040
|
-
* Maximum blktags in file system.
|
|
5606
|
+
* Maximum number of blktags in the file system.
|
|
5041
5607
|
*
|
|
5042
5608
|
* @example
|
|
5043
5609
|
* 7,864,320
|
|
@@ -5045,7 +5611,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5045
5611
|
blktagTotal?: number;
|
|
5046
5612
|
/**
|
|
5047
5613
|
* @remarks
|
|
5048
|
-
*
|
|
5614
|
+
* Current blktag usage.
|
|
5049
5615
|
*
|
|
5050
5616
|
* @example
|
|
5051
5617
|
* 5,242,880
|
|
@@ -5053,35 +5619,43 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5053
5619
|
blktagUsed?: number;
|
|
5054
5620
|
/**
|
|
5055
5621
|
* @remarks
|
|
5056
|
-
* [
|
|
5057
|
-
*
|
|
5058
|
-
* *
|
|
5059
|
-
* *
|
|
5060
|
-
* *
|
|
5061
|
-
* *
|
|
5062
|
-
* * **SENormal**: Standard Edition.
|
|
5622
|
+
* [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
|
|
5623
|
+
* * **Normal**: Cluster Edition
|
|
5624
|
+
* * **Basic**: Single Node
|
|
5625
|
+
* * **Archive**: High Compression Engine (X-Engine)
|
|
5626
|
+
* * **NormalMultimaster**: Multi-Master Cluster Edition
|
|
5627
|
+
* * **SENormal**: Standard Edition
|
|
5063
5628
|
*
|
|
5064
|
-
*
|
|
5065
|
-
*
|
|
5066
|
-
*
|
|
5629
|
+
* > * PolarDB PostgreSQL version 11 does not support single-node.
|
|
5630
|
+
* >* PolarDB MySQL versions 8.0 and 5.7, and PolarDB PostgreSQL version 14 support the Standard Edition.
|
|
5631
|
+
* >* PolarDB MySQL version 8.0 supports High Compression Engine (X-Engine) and Multi-Master Cluster Edition.
|
|
5067
5632
|
*
|
|
5068
5633
|
* @example
|
|
5069
5634
|
* Normal
|
|
5070
5635
|
*/
|
|
5071
5636
|
category?: string;
|
|
5072
5637
|
/**
|
|
5638
|
+
* @remarks
|
|
5639
|
+
* Whether storage compression is enabled. Values are as follows:
|
|
5640
|
+
* - ON: Enabled
|
|
5641
|
+
* - OFF: Disabled
|
|
5642
|
+
*
|
|
5073
5643
|
* @example
|
|
5074
5644
|
* ON
|
|
5075
5645
|
*/
|
|
5076
5646
|
compressStorageMode?: string;
|
|
5077
5647
|
/**
|
|
5648
|
+
* @remarks
|
|
5649
|
+
* Compressed storage data size.
|
|
5650
|
+
* > This parameter is supported only when the cluster\\"s storage compression feature is enabled.
|
|
5651
|
+
*
|
|
5078
5652
|
* @example
|
|
5079
5653
|
* 15529410560
|
|
5080
5654
|
*/
|
|
5081
5655
|
compressStorageUsed?: number;
|
|
5082
5656
|
/**
|
|
5083
5657
|
* @remarks
|
|
5084
|
-
*
|
|
5658
|
+
* Cluster creation time.
|
|
5085
5659
|
*
|
|
5086
5660
|
* @example
|
|
5087
5661
|
* 2020-08-14T05:58:42Z
|
|
@@ -5089,7 +5663,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5089
5663
|
creationTime?: string;
|
|
5090
5664
|
/**
|
|
5091
5665
|
* @remarks
|
|
5092
|
-
*
|
|
5666
|
+
* Cluster description.
|
|
5093
5667
|
*
|
|
5094
5668
|
* @example
|
|
5095
5669
|
* test
|
|
@@ -5097,7 +5671,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5097
5671
|
DBClusterDescription?: string;
|
|
5098
5672
|
/**
|
|
5099
5673
|
* @remarks
|
|
5100
|
-
*
|
|
5674
|
+
* Cluster ID.
|
|
5101
5675
|
*
|
|
5102
5676
|
* @example
|
|
5103
5677
|
* pc-*****************
|
|
@@ -5105,7 +5679,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5105
5679
|
DBClusterId?: string;
|
|
5106
5680
|
/**
|
|
5107
5681
|
* @remarks
|
|
5108
|
-
*
|
|
5682
|
+
* Network type of the cluster.
|
|
5109
5683
|
*
|
|
5110
5684
|
* @example
|
|
5111
5685
|
* VPC
|
|
@@ -5113,7 +5687,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5113
5687
|
DBClusterNetworkType?: string;
|
|
5114
5688
|
/**
|
|
5115
5689
|
* @remarks
|
|
5116
|
-
*
|
|
5690
|
+
* Cluster status. For the full list of values, refer to [Cluster Status Table](https://help.aliyun.com/document_detail/99286.html).
|
|
5117
5691
|
*
|
|
5118
5692
|
* @example
|
|
5119
5693
|
* Running
|
|
@@ -5126,7 +5700,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5126
5700
|
DBNodes?: DescribeDBClusterAttributeResponseBodyDBNodes[];
|
|
5127
5701
|
/**
|
|
5128
5702
|
* @remarks
|
|
5129
|
-
*
|
|
5703
|
+
* Database engine type.
|
|
5130
5704
|
*
|
|
5131
5705
|
* @example
|
|
5132
5706
|
* MySQL
|
|
@@ -5134,7 +5708,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5134
5708
|
DBType?: string;
|
|
5135
5709
|
/**
|
|
5136
5710
|
* @remarks
|
|
5137
|
-
*
|
|
5711
|
+
* Database engine version.
|
|
5138
5712
|
*
|
|
5139
5713
|
* @example
|
|
5140
5714
|
* 8.0
|
|
@@ -5145,10 +5719,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5145
5719
|
* The status of the minor version. Valid values:
|
|
5146
5720
|
*
|
|
5147
5721
|
* * **Stable**: The minor version is stable.
|
|
5148
|
-
* * **Old**: The minor version is outdated. We recommend that you
|
|
5149
|
-
* * **HighRisk**: The minor version has critical defects. We recommend that you immediately
|
|
5722
|
+
* * **Old**: The minor version is outdated. We recommend that you update it to the latest version.
|
|
5723
|
+
* * **HighRisk**: The minor version has critical defects. We recommend that you immediately update it to the latest version.
|
|
5724
|
+
* * **Beta**: The minor version is a Beta version.
|
|
5150
5725
|
*
|
|
5151
|
-
* >
|
|
5726
|
+
* > For information about how to update the minor version, see [Minor version update](https://help.aliyun.com/document_detail/158572.html).
|
|
5152
5727
|
*
|
|
5153
5728
|
* @example
|
|
5154
5729
|
* Stable
|
|
@@ -5156,7 +5731,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5156
5731
|
DBVersionStatus?: string;
|
|
5157
5732
|
/**
|
|
5158
5733
|
* @remarks
|
|
5159
|
-
*
|
|
5734
|
+
* Total size of Level 1 backups (snapshots), in bytes.
|
|
5160
5735
|
*
|
|
5161
5736
|
* @example
|
|
5162
5737
|
* 74448896
|
|
@@ -5164,7 +5739,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5164
5739
|
dataLevel1BackupChainSize?: number;
|
|
5165
5740
|
/**
|
|
5166
5741
|
* @remarks
|
|
5167
|
-
*
|
|
5742
|
+
* Data replication relationship mode. Values are as follows:
|
|
5743
|
+
* - **AsyncSync**: Asynchronous
|
|
5744
|
+
* - **SemiSync**: Semi-synchronous
|
|
5168
5745
|
*
|
|
5169
5746
|
* @example
|
|
5170
5747
|
* AsyncSync
|
|
@@ -5172,10 +5749,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5172
5749
|
dataSyncMode?: string;
|
|
5173
5750
|
/**
|
|
5174
5751
|
* @remarks
|
|
5175
|
-
*
|
|
5176
|
-
*
|
|
5177
|
-
* *
|
|
5178
|
-
* * **1**: The cluster is locked and cannot be deleted.
|
|
5752
|
+
* Lock status for cluster deletion, with values as follows:
|
|
5753
|
+
* * **0**: Unlocked, cluster can be deleted.
|
|
5754
|
+
* * **1**: Locked, cluster cannot be deleted.
|
|
5179
5755
|
*
|
|
5180
5756
|
* @example
|
|
5181
5757
|
* 0
|
|
@@ -5183,7 +5759,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5183
5759
|
deletionLock?: number;
|
|
5184
5760
|
/**
|
|
5185
5761
|
* @remarks
|
|
5186
|
-
*
|
|
5762
|
+
* Cluster engine.
|
|
5187
5763
|
*
|
|
5188
5764
|
* @example
|
|
5189
5765
|
* POLARDB
|
|
@@ -5191,9 +5767,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5191
5767
|
engine?: string;
|
|
5192
5768
|
/**
|
|
5193
5769
|
* @remarks
|
|
5194
|
-
*
|
|
5770
|
+
* Cluster expiration time.
|
|
5195
5771
|
*
|
|
5196
|
-
* >
|
|
5772
|
+
* > Only clusters with **Prepaid** (subscription) payment methods return specific parameter values; **Postpaid** (pay-as-you-go) clusters return empty values.
|
|
5197
5773
|
*
|
|
5198
5774
|
* @example
|
|
5199
5775
|
* 2020-11-14T16:00:00Z
|
|
@@ -5201,9 +5777,8 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5201
5777
|
expireTime?: string;
|
|
5202
5778
|
/**
|
|
5203
5779
|
* @remarks
|
|
5204
|
-
*
|
|
5205
|
-
*
|
|
5206
|
-
* > This parameter is returned only for subscription (**Prepaid**) clusters.
|
|
5780
|
+
* Whether the cluster has expired.
|
|
5781
|
+
* > This parameter is only supported for clusters with **Prepaid** (Subscription) payment methods.
|
|
5207
5782
|
*
|
|
5208
5783
|
* @example
|
|
5209
5784
|
* false
|
|
@@ -5211,20 +5786,28 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5211
5786
|
expired?: string;
|
|
5212
5787
|
/**
|
|
5213
5788
|
* @remarks
|
|
5214
|
-
*
|
|
5789
|
+
* Whether to replenish resources for the new primary after cross-AZ switch. Values are as follows:
|
|
5790
|
+
* - **true**: Yes
|
|
5791
|
+
* - **false**: No
|
|
5215
5792
|
*
|
|
5216
5793
|
* @example
|
|
5217
5794
|
* false
|
|
5218
5795
|
*/
|
|
5219
5796
|
hasCompleteStandbyRes?: boolean;
|
|
5220
5797
|
/**
|
|
5798
|
+
* @remarks
|
|
5799
|
+
* Whether to enable storage hot backup cluster (and Standby compute nodes). Values are as follows:
|
|
5800
|
+
* - **StandbyClusterON**: Enable storage hot backup/Enable storage hot backup and Standby compute nodes.
|
|
5801
|
+
* - **StandbyClusterOFF**: Disable storage hot backup/Disable storage hot backup and Standby compute nodes.
|
|
5802
|
+
*
|
|
5221
5803
|
* @example
|
|
5222
5804
|
* StandbyClusterON
|
|
5223
5805
|
*/
|
|
5224
5806
|
hotStandbyCluster?: string;
|
|
5807
|
+
imciAutoIndex?: string;
|
|
5225
5808
|
/**
|
|
5226
5809
|
* @remarks
|
|
5227
|
-
* Maximum inodes in file system.
|
|
5810
|
+
* Maximum number of inodes in the file system.
|
|
5228
5811
|
*
|
|
5229
5812
|
* @example
|
|
5230
5813
|
* 6,291,456
|
|
@@ -5232,7 +5815,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5232
5815
|
inodeTotal?: number;
|
|
5233
5816
|
/**
|
|
5234
5817
|
* @remarks
|
|
5235
|
-
*
|
|
5818
|
+
* Current inode usage.
|
|
5236
5819
|
*
|
|
5237
5820
|
* @example
|
|
5238
5821
|
* 4,194,304
|
|
@@ -5240,10 +5823,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5240
5823
|
inodeUsed?: number;
|
|
5241
5824
|
/**
|
|
5242
5825
|
* @remarks
|
|
5243
|
-
* Indicates whether
|
|
5826
|
+
* Indicates whether it is the latest kernel version. Values are as follows:
|
|
5244
5827
|
*
|
|
5245
|
-
*
|
|
5246
|
-
*
|
|
5828
|
+
* - **true**: Yes
|
|
5829
|
+
*
|
|
5830
|
+
* - **false**: No
|
|
5247
5831
|
*
|
|
5248
5832
|
* @example
|
|
5249
5833
|
* false
|
|
@@ -5251,10 +5835,10 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5251
5835
|
isLatestVersion?: boolean;
|
|
5252
5836
|
/**
|
|
5253
5837
|
* @remarks
|
|
5254
|
-
* Indicates whether
|
|
5838
|
+
* Indicates whether it is the latest version of the database proxy, with possible values as follows:
|
|
5255
5839
|
*
|
|
5256
|
-
*
|
|
5257
|
-
*
|
|
5840
|
+
* - **true**: Yes
|
|
5841
|
+
* - **false**: No
|
|
5258
5842
|
*
|
|
5259
5843
|
* @example
|
|
5260
5844
|
* false
|
|
@@ -5262,11 +5846,11 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5262
5846
|
isProxyLatestVersion?: boolean;
|
|
5263
5847
|
/**
|
|
5264
5848
|
* @remarks
|
|
5265
|
-
*
|
|
5849
|
+
* Lock mode. Possible values are as follows:
|
|
5266
5850
|
*
|
|
5267
|
-
*
|
|
5268
|
-
*
|
|
5269
|
-
*
|
|
5851
|
+
* - **Unlock**: Unlocked.
|
|
5852
|
+
* - **ManualLock**: Manually triggered lock.
|
|
5853
|
+
* - **LockByExpiration**: Automatic cluster lock upon expiration.
|
|
5270
5854
|
*
|
|
5271
5855
|
* @example
|
|
5272
5856
|
* Unlock
|
|
@@ -5274,36 +5858,46 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5274
5858
|
lockMode?: string;
|
|
5275
5859
|
/**
|
|
5276
5860
|
* @remarks
|
|
5277
|
-
* The maintenance window
|
|
5861
|
+
* 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).
|
|
5278
5862
|
*
|
|
5279
5863
|
* @example
|
|
5280
5864
|
* 18:00Z-19:00Z
|
|
5281
5865
|
*/
|
|
5282
5866
|
maintainTime?: string;
|
|
5283
5867
|
/**
|
|
5868
|
+
* @remarks
|
|
5869
|
+
* Orca function with possible values as follows:
|
|
5870
|
+
*
|
|
5871
|
+
* - **on**: Enabled
|
|
5872
|
+
*
|
|
5873
|
+
* - **off**: Disabled
|
|
5874
|
+
*
|
|
5284
5875
|
* @example
|
|
5285
5876
|
* ON
|
|
5286
5877
|
*/
|
|
5287
5878
|
orca?: string;
|
|
5288
5879
|
/**
|
|
5289
5880
|
* @remarks
|
|
5290
|
-
*
|
|
5881
|
+
* Payment type. Possible values are:
|
|
5291
5882
|
*
|
|
5292
|
-
*
|
|
5293
|
-
*
|
|
5883
|
+
* - **Postpaid**: Pay-As-You-Go
|
|
5884
|
+
* - **Prepaid**: Prepaid (Subscription).
|
|
5294
5885
|
*
|
|
5295
5886
|
* @example
|
|
5296
5887
|
* Prepaid
|
|
5297
5888
|
*/
|
|
5298
5889
|
payType?: string;
|
|
5299
5890
|
/**
|
|
5891
|
+
* @remarks
|
|
5892
|
+
* 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.
|
|
5893
|
+
*
|
|
5300
5894
|
* @example
|
|
5301
5895
|
* 2500
|
|
5302
5896
|
*/
|
|
5303
5897
|
provisionedIops?: string;
|
|
5304
5898
|
/**
|
|
5305
5899
|
* @remarks
|
|
5306
|
-
*
|
|
5900
|
+
* Number of CPU cores for the database proxy.
|
|
5307
5901
|
*
|
|
5308
5902
|
* @example
|
|
5309
5903
|
* 4
|
|
@@ -5311,7 +5905,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5311
5905
|
proxyCpuCores?: string;
|
|
5312
5906
|
/**
|
|
5313
5907
|
* @remarks
|
|
5314
|
-
*
|
|
5908
|
+
* Serverless type for the database proxy. Currently, the value is fixed to AgileServerless.
|
|
5315
5909
|
*
|
|
5316
5910
|
* @example
|
|
5317
5911
|
* AgileServerless
|
|
@@ -5319,7 +5913,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5319
5913
|
proxyServerlessType?: string;
|
|
5320
5914
|
/**
|
|
5321
5915
|
* @remarks
|
|
5322
|
-
*
|
|
5916
|
+
* Standard configuration CPU cores for the database proxy.
|
|
5323
5917
|
*
|
|
5324
5918
|
* @example
|
|
5325
5919
|
* 2
|
|
@@ -5327,19 +5921,19 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5327
5921
|
proxyStandardCpuCores?: string;
|
|
5328
5922
|
/**
|
|
5329
5923
|
* @remarks
|
|
5330
|
-
*
|
|
5924
|
+
* Status of the database proxy. Possible values include:
|
|
5331
5925
|
*
|
|
5332
|
-
*
|
|
5333
|
-
*
|
|
5334
|
-
*
|
|
5335
|
-
*
|
|
5336
|
-
*
|
|
5337
|
-
*
|
|
5338
|
-
*
|
|
5339
|
-
*
|
|
5340
|
-
*
|
|
5341
|
-
*
|
|
5342
|
-
*
|
|
5926
|
+
* - **Creating**: Creating
|
|
5927
|
+
* - **Running**: Running
|
|
5928
|
+
* - **Deleting**: Releasing
|
|
5929
|
+
* - **Rebooting**: Restarting
|
|
5930
|
+
* - **DBNodeCreating**: Adding nodes
|
|
5931
|
+
* - **DBNodeDeleting**: Deleting nodes
|
|
5932
|
+
* - **ClassChanging**: Changing node specifications
|
|
5933
|
+
* - **NetAddressCreating**: Creating network connections
|
|
5934
|
+
* - **NetAddressDeleting**: Deleting network connections
|
|
5935
|
+
* - **NetAddressModifying**: Modifying network connections
|
|
5936
|
+
* - **Deleted**: Released
|
|
5343
5937
|
*
|
|
5344
5938
|
* @example
|
|
5345
5939
|
* Running
|
|
@@ -5347,10 +5941,10 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5347
5941
|
proxyStatus?: string;
|
|
5348
5942
|
/**
|
|
5349
5943
|
* @remarks
|
|
5350
|
-
*
|
|
5944
|
+
* Database proxy types, with the following values:
|
|
5351
5945
|
*
|
|
5352
|
-
*
|
|
5353
|
-
*
|
|
5946
|
+
* - **Exclusive**: Enterprise Exclusive Edition
|
|
5947
|
+
* - **General**: Enterprise General Purpose Edition
|
|
5354
5948
|
*
|
|
5355
5949
|
* @example
|
|
5356
5950
|
* Exclusive
|
|
@@ -5358,7 +5952,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5358
5952
|
proxyType?: string;
|
|
5359
5953
|
/**
|
|
5360
5954
|
* @remarks
|
|
5361
|
-
*
|
|
5955
|
+
* Region ID.
|
|
5362
5956
|
*
|
|
5363
5957
|
* @example
|
|
5364
5958
|
* cn-hangzhou
|
|
@@ -5366,7 +5960,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5366
5960
|
regionId?: string;
|
|
5367
5961
|
/**
|
|
5368
5962
|
* @remarks
|
|
5369
|
-
*
|
|
5963
|
+
* Request ID.
|
|
5370
5964
|
*
|
|
5371
5965
|
* @example
|
|
5372
5966
|
* 074467EF-86B9-4C23-ACBF-E9B81A******
|
|
@@ -5374,25 +5968,34 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5374
5968
|
requestId?: string;
|
|
5375
5969
|
/**
|
|
5376
5970
|
* @remarks
|
|
5377
|
-
*
|
|
5971
|
+
* Resource group ID.
|
|
5378
5972
|
*
|
|
5379
5973
|
* @example
|
|
5380
5974
|
* rg-***************
|
|
5381
5975
|
*/
|
|
5382
5976
|
resourceGroupId?: string;
|
|
5383
5977
|
/**
|
|
5978
|
+
* @remarks
|
|
5979
|
+
* 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.
|
|
5980
|
+
* <note>Only clusters restored from a backup set or time point after June 1, 2024, support this parameter.</note>
|
|
5981
|
+
*
|
|
5384
5982
|
* @example
|
|
5385
5983
|
* 2179639137
|
|
5386
5984
|
*/
|
|
5387
5985
|
restoreDataPoint?: string;
|
|
5388
5986
|
/**
|
|
5987
|
+
* @remarks
|
|
5988
|
+
* Cluster recovery method, with possible values:
|
|
5989
|
+
* * **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.
|
|
5990
|
+
* <note>This parameter is only supported for clusters restored from a backup set or time point after June 1, 2024.</note>
|
|
5991
|
+
*
|
|
5389
5992
|
* @example
|
|
5390
5993
|
* RestoreByTime
|
|
5391
5994
|
*/
|
|
5392
5995
|
restoreType?: string;
|
|
5393
5996
|
/**
|
|
5394
5997
|
* @remarks
|
|
5395
|
-
*
|
|
5998
|
+
* Storage amount of SQL, in bytes. If the value is -1, it indicates no data.
|
|
5396
5999
|
*
|
|
5397
6000
|
* @example
|
|
5398
6001
|
* 0
|
|
@@ -5400,21 +6003,37 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5400
6003
|
SQLSize?: number;
|
|
5401
6004
|
/**
|
|
5402
6005
|
* @remarks
|
|
5403
|
-
*
|
|
6006
|
+
* Serverless type. Valid values are as follows:
|
|
6007
|
+
* - AgileServerless: Agile - SteadyServerless: Stable
|
|
5404
6008
|
*
|
|
5405
6009
|
* @example
|
|
5406
6010
|
* AgileServerless
|
|
5407
6011
|
*/
|
|
5408
6012
|
serverlessType?: string;
|
|
5409
6013
|
/**
|
|
6014
|
+
* @remarks
|
|
6015
|
+
* Source cluster ID. <note>Clusters restored from backup sets or specific points in time after June 1, 2024, support this parameter.</note>
|
|
6016
|
+
*
|
|
5410
6017
|
* @example
|
|
5411
6018
|
* pc-pz51ziv48317b2880
|
|
5412
6019
|
*/
|
|
5413
6020
|
sourceDBCluster?: string;
|
|
6021
|
+
/**
|
|
6022
|
+
* @remarks
|
|
6023
|
+
* The region ID of the source cluster.
|
|
6024
|
+
*
|
|
6025
|
+
* > This parameter is returned only if the source cluster ID exists.
|
|
6026
|
+
*
|
|
6027
|
+
* @example
|
|
6028
|
+
* cn-beijing
|
|
6029
|
+
*/
|
|
5414
6030
|
sourceRegionId?: string;
|
|
5415
6031
|
/**
|
|
5416
6032
|
* @remarks
|
|
5417
|
-
*
|
|
6033
|
+
* Cross-AZ disaster recovery mode. Values are as follows:
|
|
6034
|
+
* - **ON**: Enable cross-AZ disaster recovery mode.
|
|
6035
|
+
* - **OFF**: Disable cross-AZ disaster recovery mode.
|
|
6036
|
+
* - **0**: Customer drill mode.
|
|
5418
6037
|
*
|
|
5419
6038
|
* @example
|
|
5420
6039
|
* OFF
|
|
@@ -5422,7 +6041,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5422
6041
|
standbyHAMode?: string;
|
|
5423
6042
|
/**
|
|
5424
6043
|
* @remarks
|
|
5425
|
-
* The maximum storage capacity of the current cluster specification
|
|
6044
|
+
* The maximum storage capacity of the current cluster specification, in bytes.
|
|
5426
6045
|
*
|
|
5427
6046
|
* @example
|
|
5428
6047
|
* 10995116277760
|
|
@@ -5430,10 +6049,8 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5430
6049
|
storageMax?: number;
|
|
5431
6050
|
/**
|
|
5432
6051
|
* @remarks
|
|
5433
|
-
*
|
|
5434
|
-
*
|
|
5435
|
-
* * **Postpaid**: pay-as-you-go
|
|
5436
|
-
* * **Prepaid**: subscription.
|
|
6052
|
+
* Storage billing type. Valid values are as follows:
|
|
6053
|
+
* - **Postpaid**:Pay-as-you-go (by capacity). - **Prepaid**:Subscription (by space).
|
|
5437
6054
|
*
|
|
5438
6055
|
* @example
|
|
5439
6056
|
* Prepaid
|
|
@@ -5441,7 +6058,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5441
6058
|
storagePayType?: string;
|
|
5442
6059
|
/**
|
|
5443
6060
|
* @remarks
|
|
5444
|
-
*
|
|
6061
|
+
* Storage space for pay-by-space (subscription) billing. Unit: Byte.
|
|
5445
6062
|
*
|
|
5446
6063
|
* @example
|
|
5447
6064
|
* 50
|
|
@@ -5449,7 +6066,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5449
6066
|
storageSpace?: number;
|
|
5450
6067
|
/**
|
|
5451
6068
|
* @remarks
|
|
5452
|
-
*
|
|
6069
|
+
* Storage type, with a fixed value of **HighPerformance**.
|
|
5453
6070
|
*
|
|
5454
6071
|
* @example
|
|
5455
6072
|
* HighPerformance
|
|
@@ -5457,7 +6074,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5457
6074
|
storageType?: string;
|
|
5458
6075
|
/**
|
|
5459
6076
|
* @remarks
|
|
5460
|
-
*
|
|
6077
|
+
* Amount of used storage space, in bytes.
|
|
5461
6078
|
*
|
|
5462
6079
|
* @example
|
|
5463
6080
|
* 3012558848
|
|
@@ -5465,10 +6082,9 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5465
6082
|
storageUsed?: number;
|
|
5466
6083
|
/**
|
|
5467
6084
|
* @remarks
|
|
5468
|
-
* Indicates whether
|
|
5469
|
-
*
|
|
5470
|
-
*
|
|
5471
|
-
* * **OFF**
|
|
6085
|
+
* Indicates whether multi-AZ data strong consistency is enabled for the cluster. The value ranges are as follows:
|
|
6086
|
+
* - **ON**: Indicates that multi-AZ data strong consistency is enabled, applicable to the Standard 3AZ scenario.
|
|
6087
|
+
* - **OFF**: Indicates that multi-AZ data strong consistency is not enabled.
|
|
5472
6088
|
*
|
|
5473
6089
|
* @example
|
|
5474
6090
|
* ON
|
|
@@ -5476,26 +6092,32 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5476
6092
|
strictConsistency?: string;
|
|
5477
6093
|
/**
|
|
5478
6094
|
* @remarks
|
|
5479
|
-
*
|
|
5480
|
-
*
|
|
5481
|
-
* *
|
|
5482
|
-
* * **General**: general-purpose.
|
|
6095
|
+
* Specification type of compute nodes, with possible values as follows:
|
|
6096
|
+
* * **Exclusive**: Dedicated specification
|
|
6097
|
+
* * **General**: General-purpose specification
|
|
5483
6098
|
*
|
|
5484
|
-
* > This parameter is supported only for PolarDB
|
|
6099
|
+
* > This parameter is supported only for PolarDB MySQL Edition with the product series set to Cluster Edition.
|
|
5485
6100
|
*
|
|
5486
6101
|
* @example
|
|
5487
6102
|
* Exclusive
|
|
5488
6103
|
*/
|
|
5489
6104
|
subCategory?: string;
|
|
6105
|
+
/**
|
|
6106
|
+
* @remarks
|
|
6107
|
+
* Indicates whether the failover with hot replica feature is supported if the cluster has In-Memory Column Index (IMCI) nodes.
|
|
6108
|
+
*
|
|
6109
|
+
* @example
|
|
6110
|
+
* ON
|
|
6111
|
+
*/
|
|
5490
6112
|
supportInstantSwitchWithImci?: string;
|
|
5491
6113
|
/**
|
|
5492
6114
|
* @remarks
|
|
5493
|
-
* Details
|
|
6115
|
+
* Details of tags.
|
|
5494
6116
|
*/
|
|
5495
6117
|
tags?: DescribeDBClusterAttributeResponseBodyTags[];
|
|
5496
6118
|
/**
|
|
5497
6119
|
* @remarks
|
|
5498
|
-
*
|
|
6120
|
+
* VPC ID.
|
|
5499
6121
|
*
|
|
5500
6122
|
* @example
|
|
5501
6123
|
* vpc-*******************
|
|
@@ -5503,7 +6125,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5503
6125
|
VPCId?: string;
|
|
5504
6126
|
/**
|
|
5505
6127
|
* @remarks
|
|
5506
|
-
*
|
|
6128
|
+
* VSwitch ID.
|
|
5507
6129
|
*
|
|
5508
6130
|
* @example
|
|
5509
6131
|
* vsw-*********************
|
|
@@ -5511,7 +6133,7 @@ export declare class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
5511
6133
|
vSwitchId?: string;
|
|
5512
6134
|
/**
|
|
5513
6135
|
* @remarks
|
|
5514
|
-
*
|
|
6136
|
+
* Availability Zone IDs.
|
|
5515
6137
|
*
|
|
5516
6138
|
* @example
|
|
5517
6139
|
* cn-hangzhou-i,cn-hangzhou-g
|
|
@@ -5903,7 +6525,7 @@ export declare class DescribeDBClusterEndpointsRequest extends $tea.Model {
|
|
|
5903
6525
|
export declare class DescribeDBClusterEndpointsResponseBody extends $tea.Model {
|
|
5904
6526
|
/**
|
|
5905
6527
|
* @remarks
|
|
5906
|
-
* The
|
|
6528
|
+
* The information about the endpoints.
|
|
5907
6529
|
*/
|
|
5908
6530
|
items?: DescribeDBClusterEndpointsResponseBodyItems[];
|
|
5909
6531
|
/**
|
|
@@ -6371,6 +6993,13 @@ export declare class DescribeDBClusterPerformanceRequest extends $tea.Model {
|
|
|
6371
6993
|
* 2020-09-23T01:01Z
|
|
6372
6994
|
*/
|
|
6373
6995
|
startTime?: string;
|
|
6996
|
+
/**
|
|
6997
|
+
* @remarks
|
|
6998
|
+
* The Query Type
|
|
6999
|
+
*
|
|
7000
|
+
* @example
|
|
7001
|
+
* orca
|
|
7002
|
+
*/
|
|
6374
7003
|
type?: string;
|
|
6375
7004
|
static names(): {
|
|
6376
7005
|
[key: string]: string;
|
|
@@ -6695,6 +7324,19 @@ export declare class DescribeDBClusterTDERequest extends $tea.Model {
|
|
|
6695
7324
|
});
|
|
6696
7325
|
}
|
|
6697
7326
|
export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
|
|
7327
|
+
/**
|
|
7328
|
+
* @remarks
|
|
7329
|
+
* Indicates whether automatic key rotation is allowed. Valid values:
|
|
7330
|
+
*
|
|
7331
|
+
* * **Enabled**: Automatic key rotation is allowed.
|
|
7332
|
+
* * **Disabled**: Automatic key rotation is not allowed.
|
|
7333
|
+
*
|
|
7334
|
+
* > This parameter is returned only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.
|
|
7335
|
+
*
|
|
7336
|
+
* @example
|
|
7337
|
+
* Enabled
|
|
7338
|
+
*/
|
|
7339
|
+
automaticRotation?: string;
|
|
6698
7340
|
/**
|
|
6699
7341
|
* @remarks
|
|
6700
7342
|
* The ID of the cluster.
|
|
@@ -6710,6 +7352,8 @@ export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
|
|
|
6710
7352
|
* * **ON**
|
|
6711
7353
|
* * **OFF**
|
|
6712
7354
|
*
|
|
7355
|
+
* > This parameter is returned only for a PolarDB for MySQL cluster.
|
|
7356
|
+
*
|
|
6713
7357
|
* @example
|
|
6714
7358
|
* ON
|
|
6715
7359
|
*/
|
|
@@ -6730,6 +7374,18 @@ export declare class DescribeDBClusterTDEResponseBody extends $tea.Model {
|
|
|
6730
7374
|
* E37D1508-EC3B-4E06-A24A-C7AC31******
|
|
6731
7375
|
*/
|
|
6732
7376
|
requestId?: string;
|
|
7377
|
+
/**
|
|
7378
|
+
* @remarks
|
|
7379
|
+
* The automatic key rotation period configured in Key Management Service (KMS). If no automatic key rotation period is configured, 0s is returned. Unit: seconds.
|
|
7380
|
+
*
|
|
7381
|
+
* For example, if the rotation period is set to 7 days, 604800s is returned.
|
|
7382
|
+
*
|
|
7383
|
+
* > 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.
|
|
7384
|
+
*
|
|
7385
|
+
* @example
|
|
7386
|
+
* 604800s
|
|
7387
|
+
*/
|
|
7388
|
+
rotationInterval?: string;
|
|
6733
7389
|
/**
|
|
6734
7390
|
* @remarks
|
|
6735
7391
|
* The region where the TDE key resides.
|
|
@@ -6851,6 +7507,10 @@ export declare class DescribeDBClusterVersionResponseBody extends $tea.Model {
|
|
|
6851
7507
|
* 8.0.1.1.7
|
|
6852
7508
|
*/
|
|
6853
7509
|
DBRevisionVersion?: string;
|
|
7510
|
+
/**
|
|
7511
|
+
* @remarks
|
|
7512
|
+
* The versions to which the cluster can be upgraded.
|
|
7513
|
+
*/
|
|
6854
7514
|
DBRevisionVersionList?: DescribeDBClusterVersionResponseBodyDBRevisionVersionList[];
|
|
6855
7515
|
/**
|
|
6856
7516
|
* @remarks
|
|
@@ -7059,7 +7719,7 @@ export declare class DescribeDBClustersRequest extends $tea.Model {
|
|
|
7059
7719
|
ownerId?: number;
|
|
7060
7720
|
/**
|
|
7061
7721
|
* @remarks
|
|
7062
|
-
* The page number. The value must be
|
|
7722
|
+
* The page number. The value must be an integer that is greater than 0. Default value: **1**.
|
|
7063
7723
|
*
|
|
7064
7724
|
* @example
|
|
7065
7725
|
* 10
|
|
@@ -7067,7 +7727,7 @@ export declare class DescribeDBClustersRequest extends $tea.Model {
|
|
|
7067
7727
|
pageNumber?: number;
|
|
7068
7728
|
/**
|
|
7069
7729
|
* @remarks
|
|
7070
|
-
* The number of entries per page. Valid values: **30**, **50**,
|
|
7730
|
+
* The number of entries per page. Valid values: **30**, **50**, and **100**.
|
|
7071
7731
|
*
|
|
7072
7732
|
* Default value: **30**.
|
|
7073
7733
|
*
|
|
@@ -7417,10 +8077,11 @@ export declare class DescribeDBInitializeVariableRequest extends $tea.Model {
|
|
|
7417
8077
|
export declare class DescribeDBInitializeVariableResponseBody extends $tea.Model {
|
|
7418
8078
|
/**
|
|
7419
8079
|
* @remarks
|
|
7420
|
-
* The
|
|
8080
|
+
* The database type. Valid values:
|
|
7421
8081
|
*
|
|
7422
8082
|
* * Oracle
|
|
7423
8083
|
* * PostgreSQL
|
|
8084
|
+
* * MySQL
|
|
7424
8085
|
*
|
|
7425
8086
|
* @example
|
|
7426
8087
|
* PostgreSQL
|
|
@@ -7843,6 +8504,15 @@ export declare class DescribeDBProxyPerformanceRequest extends $tea.Model {
|
|
|
7843
8504
|
* pe-****************
|
|
7844
8505
|
*/
|
|
7845
8506
|
DBEndpointId?: string;
|
|
8507
|
+
/**
|
|
8508
|
+
* @remarks
|
|
8509
|
+
* Database instance node ID.
|
|
8510
|
+
*
|
|
8511
|
+
* > It is used to query the metrics of Proxy on different DB nodes, supporting metrics such as PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.
|
|
8512
|
+
*
|
|
8513
|
+
* @example
|
|
8514
|
+
* pi-******************
|
|
8515
|
+
*/
|
|
7846
8516
|
DBNodeId?: string;
|
|
7847
8517
|
/**
|
|
7848
8518
|
* @remarks
|
|
@@ -8456,6 +9126,13 @@ export declare class DescribeGlobalDatabaseNetworkResponseBody extends $tea.Mode
|
|
|
8456
9126
|
* active
|
|
8457
9127
|
*/
|
|
8458
9128
|
GDNStatus?: string;
|
|
9129
|
+
/**
|
|
9130
|
+
* @remarks
|
|
9131
|
+
* The global domain name.
|
|
9132
|
+
*
|
|
9133
|
+
* @example
|
|
9134
|
+
* [gdnid].gdn.rds.aliyuncs.com
|
|
9135
|
+
*/
|
|
8459
9136
|
globalDomainName?: string;
|
|
8460
9137
|
/**
|
|
8461
9138
|
* @remarks
|
|
@@ -8649,35 +9326,190 @@ export declare class DescribeGlobalDatabaseNetworksResponse extends $tea.Model {
|
|
|
8649
9326
|
export declare class DescribeGlobalSecurityIPGroupRequest extends $tea.Model {
|
|
8650
9327
|
/**
|
|
8651
9328
|
* @remarks
|
|
8652
|
-
* The ID of the IP whitelist template.
|
|
9329
|
+
* The ID of the IP whitelist template.
|
|
9330
|
+
*
|
|
9331
|
+
* @example
|
|
9332
|
+
* g-zsldxfiwjmti0kcm****
|
|
9333
|
+
*/
|
|
9334
|
+
globalSecurityGroupId?: string;
|
|
9335
|
+
ownerAccount?: string;
|
|
9336
|
+
ownerId?: number;
|
|
9337
|
+
/**
|
|
9338
|
+
* @remarks
|
|
9339
|
+
* The region ID of the IP whitelist template.
|
|
9340
|
+
*
|
|
9341
|
+
* This parameter is required.
|
|
9342
|
+
*
|
|
9343
|
+
* @example
|
|
9344
|
+
* cn-hangzhou
|
|
9345
|
+
*/
|
|
9346
|
+
regionId?: string;
|
|
9347
|
+
/**
|
|
9348
|
+
* @remarks
|
|
9349
|
+
* The ID of the resource group.
|
|
9350
|
+
*
|
|
9351
|
+
* @example
|
|
9352
|
+
* rg-************
|
|
9353
|
+
*/
|
|
9354
|
+
resourceGroupId?: string;
|
|
9355
|
+
resourceOwnerAccount?: string;
|
|
9356
|
+
resourceOwnerId?: number;
|
|
9357
|
+
securityToken?: string;
|
|
9358
|
+
static names(): {
|
|
9359
|
+
[key: string]: string;
|
|
9360
|
+
};
|
|
9361
|
+
static types(): {
|
|
9362
|
+
[key: string]: any;
|
|
9363
|
+
};
|
|
9364
|
+
constructor(map?: {
|
|
9365
|
+
[key: string]: any;
|
|
9366
|
+
});
|
|
9367
|
+
}
|
|
9368
|
+
export declare class DescribeGlobalSecurityIPGroupResponseBody extends $tea.Model {
|
|
9369
|
+
/**
|
|
9370
|
+
* @remarks
|
|
9371
|
+
* The details of the global IP whitelist template.
|
|
9372
|
+
*/
|
|
9373
|
+
globalSecurityIPGroup?: DescribeGlobalSecurityIPGroupResponseBodyGlobalSecurityIPGroup[];
|
|
9374
|
+
/**
|
|
9375
|
+
* @remarks
|
|
9376
|
+
* The ID of the request.
|
|
9377
|
+
*
|
|
9378
|
+
* @example
|
|
9379
|
+
* 9B7BFB11-C077-4FE3-B051-F69CEB******
|
|
9380
|
+
*/
|
|
9381
|
+
requestId?: string;
|
|
9382
|
+
static names(): {
|
|
9383
|
+
[key: string]: string;
|
|
9384
|
+
};
|
|
9385
|
+
static types(): {
|
|
9386
|
+
[key: string]: any;
|
|
9387
|
+
};
|
|
9388
|
+
constructor(map?: {
|
|
9389
|
+
[key: string]: any;
|
|
9390
|
+
});
|
|
9391
|
+
}
|
|
9392
|
+
export declare class DescribeGlobalSecurityIPGroupResponse extends $tea.Model {
|
|
9393
|
+
headers?: {
|
|
9394
|
+
[key: string]: string;
|
|
9395
|
+
};
|
|
9396
|
+
statusCode?: number;
|
|
9397
|
+
body?: DescribeGlobalSecurityIPGroupResponseBody;
|
|
9398
|
+
static names(): {
|
|
9399
|
+
[key: string]: string;
|
|
9400
|
+
};
|
|
9401
|
+
static types(): {
|
|
9402
|
+
[key: string]: any;
|
|
9403
|
+
};
|
|
9404
|
+
constructor(map?: {
|
|
9405
|
+
[key: string]: any;
|
|
9406
|
+
});
|
|
9407
|
+
}
|
|
9408
|
+
export declare class DescribeGlobalSecurityIPGroupRelationRequest extends $tea.Model {
|
|
9409
|
+
/**
|
|
9410
|
+
* @remarks
|
|
9411
|
+
* The ID of cluster.
|
|
9412
|
+
*
|
|
9413
|
+
* This parameter is required.
|
|
9414
|
+
*
|
|
9415
|
+
* @example
|
|
9416
|
+
* pc-*****************
|
|
9417
|
+
*/
|
|
9418
|
+
DBClusterId?: string;
|
|
9419
|
+
ownerAccount?: string;
|
|
9420
|
+
ownerId?: number;
|
|
9421
|
+
/**
|
|
9422
|
+
* @remarks
|
|
9423
|
+
* The region ID of the IP whitelist template.
|
|
9424
|
+
*
|
|
9425
|
+
* This parameter is required.
|
|
9426
|
+
*
|
|
9427
|
+
* @example
|
|
9428
|
+
* cn-hangzhou
|
|
9429
|
+
*/
|
|
9430
|
+
regionId?: string;
|
|
9431
|
+
/**
|
|
9432
|
+
* @remarks
|
|
9433
|
+
* The ID of the resource group.
|
|
9434
|
+
*
|
|
9435
|
+
* @example
|
|
9436
|
+
* rg-**********
|
|
9437
|
+
*/
|
|
9438
|
+
resourceGroupId?: string;
|
|
9439
|
+
resourceOwnerAccount?: string;
|
|
9440
|
+
resourceOwnerId?: number;
|
|
9441
|
+
securityToken?: string;
|
|
9442
|
+
static names(): {
|
|
9443
|
+
[key: string]: string;
|
|
9444
|
+
};
|
|
9445
|
+
static types(): {
|
|
9446
|
+
[key: string]: any;
|
|
9447
|
+
};
|
|
9448
|
+
constructor(map?: {
|
|
9449
|
+
[key: string]: any;
|
|
9450
|
+
});
|
|
9451
|
+
}
|
|
9452
|
+
export declare class DescribeGlobalSecurityIPGroupRelationResponseBody extends $tea.Model {
|
|
9453
|
+
/**
|
|
9454
|
+
* @remarks
|
|
9455
|
+
* The ID of cluster.
|
|
9456
|
+
*
|
|
9457
|
+
* @example
|
|
9458
|
+
* pc-*****************
|
|
9459
|
+
*/
|
|
9460
|
+
DBClusterId?: string;
|
|
9461
|
+
/**
|
|
9462
|
+
* @remarks
|
|
9463
|
+
* The details of the global IP whitelist template.
|
|
9464
|
+
*/
|
|
9465
|
+
globalSecurityIPGroupRel?: DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGroupRel[];
|
|
9466
|
+
/**
|
|
9467
|
+
* @remarks
|
|
9468
|
+
* The ID of the request.
|
|
9469
|
+
*
|
|
9470
|
+
* @example
|
|
9471
|
+
* 9B7BFB11-C077-4FE3-B051-F69CEB******
|
|
9472
|
+
*/
|
|
9473
|
+
requestId?: string;
|
|
9474
|
+
static names(): {
|
|
9475
|
+
[key: string]: string;
|
|
9476
|
+
};
|
|
9477
|
+
static types(): {
|
|
9478
|
+
[key: string]: any;
|
|
9479
|
+
};
|
|
9480
|
+
constructor(map?: {
|
|
9481
|
+
[key: string]: any;
|
|
9482
|
+
});
|
|
9483
|
+
}
|
|
9484
|
+
export declare class DescribeGlobalSecurityIPGroupRelationResponse extends $tea.Model {
|
|
9485
|
+
headers?: {
|
|
9486
|
+
[key: string]: string;
|
|
9487
|
+
};
|
|
9488
|
+
statusCode?: number;
|
|
9489
|
+
body?: DescribeGlobalSecurityIPGroupRelationResponseBody;
|
|
9490
|
+
static names(): {
|
|
9491
|
+
[key: string]: string;
|
|
9492
|
+
};
|
|
9493
|
+
static types(): {
|
|
9494
|
+
[key: string]: any;
|
|
9495
|
+
};
|
|
9496
|
+
constructor(map?: {
|
|
9497
|
+
[key: string]: any;
|
|
9498
|
+
});
|
|
9499
|
+
}
|
|
9500
|
+
export declare class DescribeLicenseOrderDetailsRequest extends $tea.Model {
|
|
9501
|
+
/**
|
|
9502
|
+
* @remarks
|
|
9503
|
+
* This parameter is required.
|
|
8653
9504
|
*
|
|
8654
9505
|
* @example
|
|
8655
|
-
*
|
|
9506
|
+
* 239618016570503
|
|
8656
9507
|
*/
|
|
8657
|
-
|
|
9508
|
+
aliyunOrderId?: string;
|
|
8658
9509
|
ownerAccount?: string;
|
|
8659
9510
|
ownerId?: number;
|
|
8660
|
-
/**
|
|
8661
|
-
* @remarks
|
|
8662
|
-
* The region ID of the IP whitelist template.
|
|
8663
|
-
*
|
|
8664
|
-
* This parameter is required.
|
|
8665
|
-
*
|
|
8666
|
-
* @example
|
|
8667
|
-
* cn-hangzhou
|
|
8668
|
-
*/
|
|
8669
|
-
regionId?: string;
|
|
8670
|
-
/**
|
|
8671
|
-
* @remarks
|
|
8672
|
-
* The ID of the resource group.
|
|
8673
|
-
*
|
|
8674
|
-
* @example
|
|
8675
|
-
* rg-************
|
|
8676
|
-
*/
|
|
8677
|
-
resourceGroupId?: string;
|
|
8678
9511
|
resourceOwnerAccount?: string;
|
|
8679
9512
|
resourceOwnerId?: number;
|
|
8680
|
-
securityToken?: string;
|
|
8681
9513
|
static names(): {
|
|
8682
9514
|
[key: string]: string;
|
|
8683
9515
|
};
|
|
@@ -8688,20 +9520,77 @@ export declare class DescribeGlobalSecurityIPGroupRequest extends $tea.Model {
|
|
|
8688
9520
|
[key: string]: any;
|
|
8689
9521
|
});
|
|
8690
9522
|
}
|
|
8691
|
-
export declare class
|
|
9523
|
+
export declare class DescribeLicenseOrderDetailsResponseBody extends $tea.Model {
|
|
8692
9524
|
/**
|
|
8693
|
-
* @
|
|
8694
|
-
*
|
|
9525
|
+
* @example
|
|
9526
|
+
* 2
|
|
8695
9527
|
*/
|
|
8696
|
-
|
|
9528
|
+
activatedCodeCount?: number;
|
|
8697
9529
|
/**
|
|
8698
|
-
* @remarks
|
|
8699
|
-
* The ID of the request.
|
|
8700
|
-
*
|
|
8701
9530
|
* @example
|
|
8702
|
-
*
|
|
9531
|
+
* 8
|
|
9532
|
+
*/
|
|
9533
|
+
activationCodeQuota?: number;
|
|
9534
|
+
/**
|
|
9535
|
+
* @example
|
|
9536
|
+
* 239618016570503
|
|
9537
|
+
*/
|
|
9538
|
+
aliyunOrderId?: string;
|
|
9539
|
+
/**
|
|
9540
|
+
* @example
|
|
9541
|
+
* false
|
|
9542
|
+
*/
|
|
9543
|
+
allowEmptySystemIdentifier?: boolean;
|
|
9544
|
+
/**
|
|
9545
|
+
* @example
|
|
9546
|
+
* PG
|
|
9547
|
+
*/
|
|
9548
|
+
engine?: string;
|
|
9549
|
+
/**
|
|
9550
|
+
* @example
|
|
9551
|
+
* 2021-10-19 01:13:45
|
|
9552
|
+
*/
|
|
9553
|
+
gmtCreated?: string;
|
|
9554
|
+
/**
|
|
9555
|
+
* @example
|
|
9556
|
+
* 2024-10-16 16:46:20
|
|
9557
|
+
*/
|
|
9558
|
+
gmtModified?: string;
|
|
9559
|
+
/**
|
|
9560
|
+
* @example
|
|
9561
|
+
* false
|
|
9562
|
+
*/
|
|
9563
|
+
isVirtualOrder?: boolean;
|
|
9564
|
+
/**
|
|
9565
|
+
* @example
|
|
9566
|
+
* false
|
|
9567
|
+
*/
|
|
9568
|
+
isVirtualOrderFrozen?: boolean;
|
|
9569
|
+
/**
|
|
9570
|
+
* @example
|
|
9571
|
+
* pre_generation_long_term
|
|
9572
|
+
*/
|
|
9573
|
+
packageType?: string;
|
|
9574
|
+
/**
|
|
9575
|
+
* @example
|
|
9576
|
+
* 1 year
|
|
9577
|
+
*/
|
|
9578
|
+
packageValidity?: string;
|
|
9579
|
+
/**
|
|
9580
|
+
* @example
|
|
9581
|
+
* aliyun_market
|
|
9582
|
+
*/
|
|
9583
|
+
purchaseChannel?: string;
|
|
9584
|
+
/**
|
|
9585
|
+
* @example
|
|
9586
|
+
* 22C0ACF0-DD29-4B67-9190-B7A48C******
|
|
8703
9587
|
*/
|
|
8704
9588
|
requestId?: string;
|
|
9589
|
+
/**
|
|
9590
|
+
* @example
|
|
9591
|
+
* 239618016570503
|
|
9592
|
+
*/
|
|
9593
|
+
virtualOrderId?: string;
|
|
8705
9594
|
static names(): {
|
|
8706
9595
|
[key: string]: string;
|
|
8707
9596
|
};
|
|
@@ -8712,12 +9601,12 @@ export declare class DescribeGlobalSecurityIPGroupResponseBody extends $tea.Mode
|
|
|
8712
9601
|
[key: string]: any;
|
|
8713
9602
|
});
|
|
8714
9603
|
}
|
|
8715
|
-
export declare class
|
|
9604
|
+
export declare class DescribeLicenseOrderDetailsResponse extends $tea.Model {
|
|
8716
9605
|
headers?: {
|
|
8717
9606
|
[key: string]: string;
|
|
8718
9607
|
};
|
|
8719
9608
|
statusCode?: number;
|
|
8720
|
-
body?:
|
|
9609
|
+
body?: DescribeLicenseOrderDetailsResponseBody;
|
|
8721
9610
|
static names(): {
|
|
8722
9611
|
[key: string]: string;
|
|
8723
9612
|
};
|
|
@@ -8728,40 +9617,37 @@ export declare class DescribeGlobalSecurityIPGroupResponse extends $tea.Model {
|
|
|
8728
9617
|
[key: string]: any;
|
|
8729
9618
|
});
|
|
8730
9619
|
}
|
|
8731
|
-
export declare class
|
|
9620
|
+
export declare class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
8732
9621
|
/**
|
|
8733
|
-
* @remarks
|
|
8734
|
-
* The ID of cluster.
|
|
8735
|
-
*
|
|
8736
|
-
* This parameter is required.
|
|
8737
|
-
*
|
|
8738
9622
|
* @example
|
|
8739
|
-
*
|
|
9623
|
+
* 239618016570503
|
|
8740
9624
|
*/
|
|
8741
|
-
|
|
9625
|
+
aliyunOrderId?: string;
|
|
8742
9626
|
ownerAccount?: string;
|
|
8743
9627
|
ownerId?: number;
|
|
8744
9628
|
/**
|
|
8745
|
-
* @remarks
|
|
8746
|
-
* The region ID of the IP whitelist template.
|
|
8747
|
-
*
|
|
8748
|
-
* This parameter is required.
|
|
8749
|
-
*
|
|
8750
9629
|
* @example
|
|
8751
|
-
*
|
|
9630
|
+
* single_node_subscribe
|
|
8752
9631
|
*/
|
|
8753
|
-
|
|
9632
|
+
packageType?: string;
|
|
8754
9633
|
/**
|
|
8755
|
-
* @remarks
|
|
8756
|
-
* The ID of the resource group.
|
|
8757
|
-
*
|
|
8758
9634
|
* @example
|
|
8759
|
-
*
|
|
9635
|
+
* 1
|
|
8760
9636
|
*/
|
|
8761
|
-
|
|
9637
|
+
pageNumber?: number;
|
|
9638
|
+
/**
|
|
9639
|
+
* @example
|
|
9640
|
+
* 30
|
|
9641
|
+
*/
|
|
9642
|
+
pageSize?: number;
|
|
9643
|
+
/**
|
|
9644
|
+
* @example
|
|
9645
|
+
* aliyun_market
|
|
9646
|
+
*/
|
|
9647
|
+
purchaseChannel?: string;
|
|
8762
9648
|
resourceOwnerAccount?: string;
|
|
8763
9649
|
resourceOwnerId?: number;
|
|
8764
|
-
|
|
9650
|
+
virtualOrder?: boolean;
|
|
8765
9651
|
static names(): {
|
|
8766
9652
|
[key: string]: string;
|
|
8767
9653
|
};
|
|
@@ -8772,28 +9658,28 @@ export declare class DescribeGlobalSecurityIPGroupRelationRequest extends $tea.M
|
|
|
8772
9658
|
[key: string]: any;
|
|
8773
9659
|
});
|
|
8774
9660
|
}
|
|
8775
|
-
export declare class
|
|
9661
|
+
export declare class DescribeLicenseOrdersResponseBody extends $tea.Model {
|
|
9662
|
+
items?: DescribeLicenseOrdersResponseBodyItems[];
|
|
8776
9663
|
/**
|
|
8777
|
-
* @remarks
|
|
8778
|
-
* The ID of cluster.
|
|
8779
|
-
*
|
|
8780
9664
|
* @example
|
|
8781
|
-
*
|
|
9665
|
+
* 1
|
|
8782
9666
|
*/
|
|
8783
|
-
|
|
9667
|
+
pageNumber?: number;
|
|
8784
9668
|
/**
|
|
8785
|
-
* @
|
|
8786
|
-
*
|
|
9669
|
+
* @example
|
|
9670
|
+
* 12
|
|
8787
9671
|
*/
|
|
8788
|
-
|
|
9672
|
+
pageRecordCount?: number;
|
|
8789
9673
|
/**
|
|
8790
|
-
* @remarks
|
|
8791
|
-
* The ID of the request.
|
|
8792
|
-
*
|
|
8793
9674
|
* @example
|
|
8794
|
-
*
|
|
9675
|
+
* 34458CD3-33E0-4624-BFEF-840C15******
|
|
8795
9676
|
*/
|
|
8796
9677
|
requestId?: string;
|
|
9678
|
+
/**
|
|
9679
|
+
* @example
|
|
9680
|
+
* 50
|
|
9681
|
+
*/
|
|
9682
|
+
totalRecordCount?: number;
|
|
8797
9683
|
static names(): {
|
|
8798
9684
|
[key: string]: string;
|
|
8799
9685
|
};
|
|
@@ -8804,12 +9690,12 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBody extends $
|
|
|
8804
9690
|
[key: string]: any;
|
|
8805
9691
|
});
|
|
8806
9692
|
}
|
|
8807
|
-
export declare class
|
|
9693
|
+
export declare class DescribeLicenseOrdersResponse extends $tea.Model {
|
|
8808
9694
|
headers?: {
|
|
8809
9695
|
[key: string]: string;
|
|
8810
9696
|
};
|
|
8811
9697
|
statusCode?: number;
|
|
8812
|
-
body?:
|
|
9698
|
+
body?: DescribeLicenseOrdersResponseBody;
|
|
8813
9699
|
static names(): {
|
|
8814
9700
|
[key: string]: string;
|
|
8815
9701
|
};
|
|
@@ -10024,7 +10910,7 @@ export declare class DescribeScheduleTasksRequest extends $tea.Model {
|
|
|
10024
10910
|
export declare class DescribeScheduleTasksResponseBody extends $tea.Model {
|
|
10025
10911
|
/**
|
|
10026
10912
|
* @remarks
|
|
10027
|
-
* The result data
|
|
10913
|
+
* The result data.
|
|
10028
10914
|
*/
|
|
10029
10915
|
data?: DescribeScheduleTasksResponseBodyData;
|
|
10030
10916
|
/**
|
|
@@ -10082,9 +10968,8 @@ export declare class DescribeScheduleTasksResponse extends $tea.Model {
|
|
|
10082
10968
|
export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
10083
10969
|
/**
|
|
10084
10970
|
* @remarks
|
|
10085
|
-
*
|
|
10086
|
-
*
|
|
10087
|
-
* > 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.
|
|
10971
|
+
* Cluster ID.
|
|
10972
|
+
* > 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.
|
|
10088
10973
|
*
|
|
10089
10974
|
* This parameter is required.
|
|
10090
10975
|
*
|
|
@@ -10094,7 +10979,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10094
10979
|
DBClusterId?: string;
|
|
10095
10980
|
/**
|
|
10096
10981
|
* @remarks
|
|
10097
|
-
*
|
|
10982
|
+
* Database name.
|
|
10098
10983
|
*
|
|
10099
10984
|
* @example
|
|
10100
10985
|
* testdb
|
|
@@ -10102,9 +10987,9 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10102
10987
|
DBName?: string;
|
|
10103
10988
|
/**
|
|
10104
10989
|
* @remarks
|
|
10105
|
-
*
|
|
10990
|
+
* 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).
|
|
10106
10991
|
*
|
|
10107
|
-
* >
|
|
10992
|
+
* > 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.
|
|
10108
10993
|
*
|
|
10109
10994
|
* This parameter is required.
|
|
10110
10995
|
*
|
|
@@ -10112,14 +10997,21 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10112
10997
|
* 2022-11-16T04:00Z
|
|
10113
10998
|
*/
|
|
10114
10999
|
endTime?: string;
|
|
11000
|
+
/**
|
|
11001
|
+
* @remarks
|
|
11002
|
+
* Node ID
|
|
11003
|
+
*
|
|
11004
|
+
* @example
|
|
11005
|
+
* pi-**********
|
|
11006
|
+
*/
|
|
10115
11007
|
nodeId?: string;
|
|
10116
11008
|
ownerAccount?: string;
|
|
10117
11009
|
ownerId?: number;
|
|
10118
11010
|
/**
|
|
10119
11011
|
* @remarks
|
|
10120
|
-
*
|
|
11012
|
+
* Page number, with a range greater than 0 and not exceeding the maximum value of Integer.
|
|
10121
11013
|
*
|
|
10122
|
-
*
|
|
11014
|
+
* The default value is **1**.
|
|
10123
11015
|
*
|
|
10124
11016
|
* @example
|
|
10125
11017
|
* 1
|
|
@@ -10127,13 +11019,12 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10127
11019
|
pageNumber?: number;
|
|
10128
11020
|
/**
|
|
10129
11021
|
* @remarks
|
|
10130
|
-
*
|
|
10131
|
-
*
|
|
10132
|
-
* *
|
|
10133
|
-
* *
|
|
10134
|
-
* * **100**
|
|
11022
|
+
* Number of records per page, with the following options:
|
|
11023
|
+
* * **30**
|
|
11024
|
+
* * **50**
|
|
11025
|
+
* * **100**
|
|
10135
11026
|
*
|
|
10136
|
-
*
|
|
11027
|
+
* The default value is **30**.
|
|
10137
11028
|
*
|
|
10138
11029
|
* @example
|
|
10139
11030
|
* 30
|
|
@@ -10141,9 +11032,9 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10141
11032
|
pageSize?: number;
|
|
10142
11033
|
/**
|
|
10143
11034
|
* @remarks
|
|
10144
|
-
*
|
|
11035
|
+
* Region ID.
|
|
10145
11036
|
*
|
|
10146
|
-
* > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html)
|
|
11037
|
+
* > 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.
|
|
10147
11038
|
*
|
|
10148
11039
|
* This parameter is required.
|
|
10149
11040
|
*
|
|
@@ -10155,7 +11046,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10155
11046
|
resourceOwnerId?: number;
|
|
10156
11047
|
/**
|
|
10157
11048
|
* @remarks
|
|
10158
|
-
*
|
|
11049
|
+
* 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.
|
|
10159
11050
|
*
|
|
10160
11051
|
* @example
|
|
10161
11052
|
* U2FsdGVk****
|
|
@@ -10163,13 +11054,10 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10163
11054
|
SQLHASH?: string;
|
|
10164
11055
|
/**
|
|
10165
11056
|
* @remarks
|
|
10166
|
-
*
|
|
10167
|
-
*
|
|
10168
|
-
* >
|
|
10169
|
-
*
|
|
10170
|
-
* * You can specify a time range of up to 30 days.
|
|
11057
|
+
* Start time of the query. The format is `YYYY-MM-DDThh:mmZ` (UTC time).
|
|
10171
11058
|
*
|
|
10172
|
-
* *
|
|
11059
|
+
* > * Supports viewing slow log information up to 30 days.
|
|
11060
|
+
* > * 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.
|
|
10173
11061
|
*
|
|
10174
11062
|
* This parameter is required.
|
|
10175
11063
|
*
|
|
@@ -10190,7 +11078,7 @@ export declare class DescribeSlowLogRecordsRequest extends $tea.Model {
|
|
|
10190
11078
|
export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
10191
11079
|
/**
|
|
10192
11080
|
* @remarks
|
|
10193
|
-
*
|
|
11081
|
+
* Cluster ID.
|
|
10194
11082
|
*
|
|
10195
11083
|
* @example
|
|
10196
11084
|
* pc-*****************
|
|
@@ -10198,7 +11086,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
|
10198
11086
|
DBClusterId?: string;
|
|
10199
11087
|
/**
|
|
10200
11088
|
* @remarks
|
|
10201
|
-
*
|
|
11089
|
+
* Database engine.
|
|
10202
11090
|
*
|
|
10203
11091
|
* @example
|
|
10204
11092
|
* polardb_mysql
|
|
@@ -10206,12 +11094,12 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
|
10206
11094
|
engine?: string;
|
|
10207
11095
|
/**
|
|
10208
11096
|
* @remarks
|
|
10209
|
-
*
|
|
11097
|
+
* List of slow log details.
|
|
10210
11098
|
*/
|
|
10211
11099
|
items?: DescribeSlowLogRecordsResponseBodyItems;
|
|
10212
11100
|
/**
|
|
10213
11101
|
* @remarks
|
|
10214
|
-
*
|
|
11102
|
+
* Page number.
|
|
10215
11103
|
*
|
|
10216
11104
|
* @example
|
|
10217
11105
|
* 1
|
|
@@ -10219,7 +11107,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
|
10219
11107
|
pageNumber?: number;
|
|
10220
11108
|
/**
|
|
10221
11109
|
* @remarks
|
|
10222
|
-
*
|
|
11110
|
+
* Number of records on this page.
|
|
10223
11111
|
*
|
|
10224
11112
|
* @example
|
|
10225
11113
|
* 1
|
|
@@ -10227,7 +11115,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
|
10227
11115
|
pageRecordCount?: number;
|
|
10228
11116
|
/**
|
|
10229
11117
|
* @remarks
|
|
10230
|
-
*
|
|
11118
|
+
* Request ID.
|
|
10231
11119
|
*
|
|
10232
11120
|
* @example
|
|
10233
11121
|
* A7E6A8FD-C50B-46B2-BA85-D8B8D3******
|
|
@@ -10235,7 +11123,7 @@ export declare class DescribeSlowLogRecordsResponseBody extends $tea.Model {
|
|
|
10235
11123
|
requestId?: string;
|
|
10236
11124
|
/**
|
|
10237
11125
|
* @remarks
|
|
10238
|
-
*
|
|
11126
|
+
* Total number of SQL statements.
|
|
10239
11127
|
*
|
|
10240
11128
|
* @example
|
|
10241
11129
|
* 1
|
|
@@ -10517,7 +11405,7 @@ export declare class DescribeTasksRequest extends $tea.Model {
|
|
|
10517
11405
|
* * **Running**: The task is running.
|
|
10518
11406
|
* * **Finished**: The task is completed.
|
|
10519
11407
|
* * **Closed**: The task is closed.
|
|
10520
|
-
* * **Pause**: The task is
|
|
11408
|
+
* * **Pause**: The task is paused.
|
|
10521
11409
|
* * **Stop**: The task is interrupted.
|
|
10522
11410
|
*
|
|
10523
11411
|
* >
|
|
@@ -11048,6 +11936,8 @@ export declare class EnableDBClusterServerlessResponse extends $tea.Model {
|
|
|
11048
11936
|
export declare class EnableFirewallRulesRequest extends $tea.Model {
|
|
11049
11937
|
/**
|
|
11050
11938
|
* @remarks
|
|
11939
|
+
* The cluster ID.
|
|
11940
|
+
*
|
|
11051
11941
|
* This parameter is required.
|
|
11052
11942
|
*
|
|
11053
11943
|
* @example
|
|
@@ -11055,6 +11945,14 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
|
|
|
11055
11945
|
*/
|
|
11056
11946
|
DBClusterId?: string;
|
|
11057
11947
|
/**
|
|
11948
|
+
* @remarks
|
|
11949
|
+
* Specifies whether to enable or disable the specified firewall rules. Valid values:
|
|
11950
|
+
*
|
|
11951
|
+
* * **true**: enables the specified firewall rules.
|
|
11952
|
+
* * **false**: disables the specified firewall rules.
|
|
11953
|
+
*
|
|
11954
|
+
* > This parameter is valid only when you specify the **RuleNameList** parameter.
|
|
11955
|
+
*
|
|
11058
11956
|
* @example
|
|
11059
11957
|
* true
|
|
11060
11958
|
*/
|
|
@@ -11065,6 +11963,10 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
|
|
|
11065
11963
|
resourceOwnerId?: number;
|
|
11066
11964
|
/**
|
|
11067
11965
|
* @remarks
|
|
11966
|
+
* 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 (,).
|
|
11967
|
+
*
|
|
11968
|
+
* > You can call the **DescribeFirewallRules** operation to query the details of all firewall rules that are applicable to a cluster, such as rule names.
|
|
11969
|
+
*
|
|
11068
11970
|
* This parameter is required.
|
|
11069
11971
|
*
|
|
11070
11972
|
* @example
|
|
@@ -11083,6 +11985,11 @@ export declare class EnableFirewallRulesRequest extends $tea.Model {
|
|
|
11083
11985
|
}
|
|
11084
11986
|
export declare class EnableFirewallRulesResponseBody extends $tea.Model {
|
|
11085
11987
|
/**
|
|
11988
|
+
* @remarks
|
|
11989
|
+
* The message that is returned for the request.
|
|
11990
|
+
*
|
|
11991
|
+
* > 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.
|
|
11992
|
+
*
|
|
11086
11993
|
* @example
|
|
11087
11994
|
* Message
|
|
11088
11995
|
*/
|
|
@@ -11096,6 +12003,12 @@ export declare class EnableFirewallRulesResponseBody extends $tea.Model {
|
|
|
11096
12003
|
*/
|
|
11097
12004
|
requestId?: string;
|
|
11098
12005
|
/**
|
|
12006
|
+
* @remarks
|
|
12007
|
+
* Indicates whether the request was successful. Valid values:
|
|
12008
|
+
*
|
|
12009
|
+
* * **true**
|
|
12010
|
+
* * **false**
|
|
12011
|
+
*
|
|
11099
12012
|
* @example
|
|
11100
12013
|
* true
|
|
11101
12014
|
*/
|
|
@@ -11372,7 +12285,7 @@ export declare class FailoverDBClusterRequest extends $tea.Model {
|
|
|
11372
12285
|
resourceOwnerId?: number;
|
|
11373
12286
|
/**
|
|
11374
12287
|
* @remarks
|
|
11375
|
-
* Specifies whether to
|
|
12288
|
+
* Specifies whether to switch back services to the original primary zone when the original primary zone recovers.
|
|
11376
12289
|
*
|
|
11377
12290
|
* * true
|
|
11378
12291
|
* * false
|
|
@@ -11392,6 +12305,16 @@ export declare class FailoverDBClusterRequest extends $tea.Model {
|
|
|
11392
12305
|
* pi-***********
|
|
11393
12306
|
*/
|
|
11394
12307
|
targetDBNodeId?: string;
|
|
12308
|
+
/**
|
|
12309
|
+
* @remarks
|
|
12310
|
+
* Whether it is a primary-standby switch within the primary availability zone, with the following values:
|
|
12311
|
+
*
|
|
12312
|
+
* Primary: Primary-standby switch within the primary availability zone.
|
|
12313
|
+
* Standby: Switch to the storage hot backup cluster.
|
|
12314
|
+
*
|
|
12315
|
+
* @example
|
|
12316
|
+
* Primary
|
|
12317
|
+
*/
|
|
11395
12318
|
targetZoneType?: string;
|
|
11396
12319
|
static names(): {
|
|
11397
12320
|
[key: string]: string;
|
|
@@ -11559,7 +12482,7 @@ export declare class ListTagResourcesRequest extends $tea.Model {
|
|
|
11559
12482
|
regionId?: string;
|
|
11560
12483
|
/**
|
|
11561
12484
|
* @remarks
|
|
11562
|
-
* The
|
|
12485
|
+
* The IDs of the clusters. To query the tags of multiple clusters, click **Add** to add cluster IDs.
|
|
11563
12486
|
*
|
|
11564
12487
|
* >
|
|
11565
12488
|
*
|
|
@@ -12034,13 +12957,13 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
12034
12957
|
backupFrequency?: string;
|
|
12035
12958
|
/**
|
|
12036
12959
|
* @remarks
|
|
12037
|
-
* Specifies whether to retain backups when
|
|
12960
|
+
* Specifies whether to retain backups when a cluster is deleted. Valid values:
|
|
12038
12961
|
*
|
|
12039
12962
|
* * **ALL**: permanently retains all backups.
|
|
12040
|
-
* * **LATEST**: permanently retains
|
|
12963
|
+
* * **LATEST**: permanently retains the most recent backup.
|
|
12041
12964
|
* * **NONE**: does not retain backups.
|
|
12042
12965
|
*
|
|
12043
|
-
* >
|
|
12966
|
+
* > The default value of the parameter is NONE.
|
|
12044
12967
|
*
|
|
12045
12968
|
* @example
|
|
12046
12969
|
* NONE
|
|
@@ -12128,7 +13051,7 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
12128
13051
|
* * **30 to 7300**: Cross-region level-2 backups are retained for 30 to 7,300 days.
|
|
12129
13052
|
* * **1**: Cross-region level-2 backups are permanently retained.
|
|
12130
13053
|
*
|
|
12131
|
-
* >
|
|
13054
|
+
* > The default value of the parameter is **0**.
|
|
12132
13055
|
*
|
|
12133
13056
|
* @example
|
|
12134
13057
|
* 30
|
|
@@ -12159,10 +13082,10 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
12159
13082
|
* The retention period of level-2 backups. Valid values:
|
|
12160
13083
|
*
|
|
12161
13084
|
* * **0**: The level-2 backup feature is disabled.
|
|
12162
|
-
* * **30 to 7300**:
|
|
12163
|
-
* * **1**:
|
|
13085
|
+
* * **30 to 7300**: Level-2 backups are retained for 30 to 7,300 days.
|
|
13086
|
+
* * **1**: Level-2 backups are permanently retained.
|
|
12164
13087
|
*
|
|
12165
|
-
* >
|
|
13088
|
+
* > The default value of this parameter is **0**.
|
|
12166
13089
|
*
|
|
12167
13090
|
* @example
|
|
12168
13091
|
* 0
|
|
@@ -12247,7 +13170,7 @@ export declare class ModifyBackupPolicyResponse extends $tea.Model {
|
|
|
12247
13170
|
export declare class ModifyDBClusterRequest extends $tea.Model {
|
|
12248
13171
|
/**
|
|
12249
13172
|
* @remarks
|
|
12250
|
-
*
|
|
13173
|
+
* Specifies whether to enable storage compression. Set the value to **ON**.
|
|
12251
13174
|
*
|
|
12252
13175
|
* @example
|
|
12253
13176
|
* ON
|
|
@@ -12265,6 +13188,15 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
|
|
|
12265
13188
|
* pc-*************
|
|
12266
13189
|
*/
|
|
12267
13190
|
DBClusterId?: string;
|
|
13191
|
+
/**
|
|
13192
|
+
* @remarks
|
|
13193
|
+
* The list of nodes for the drill.
|
|
13194
|
+
*
|
|
13195
|
+
* > 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.
|
|
13196
|
+
*
|
|
13197
|
+
* @example
|
|
13198
|
+
* pi-rwxxx
|
|
13199
|
+
*/
|
|
12268
13200
|
DBNodeCrashList?: string;
|
|
12269
13201
|
/**
|
|
12270
13202
|
* @remarks
|
|
@@ -12277,34 +13209,44 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
|
|
|
12277
13209
|
* AsynSync
|
|
12278
13210
|
*/
|
|
12279
13211
|
dataSyncMode?: string;
|
|
13212
|
+
/**
|
|
13213
|
+
* @remarks
|
|
13214
|
+
* The fault injection method. Valid values:
|
|
13215
|
+
*
|
|
13216
|
+
* * CrashSQLInjection: `Crash SQL`-based fault injection.
|
|
13217
|
+
*
|
|
13218
|
+
* @example
|
|
13219
|
+
* 0
|
|
13220
|
+
*/
|
|
12280
13221
|
faultInjectionType?: string;
|
|
12281
13222
|
/**
|
|
12282
13223
|
* @remarks
|
|
12283
|
-
* The
|
|
13224
|
+
* The level of the disaster recovery drill. Valid values:
|
|
12284
13225
|
*
|
|
12285
|
-
* *
|
|
13226
|
+
* * `0` or `FaultInjection`: The primary zone level.
|
|
13227
|
+
* * `1`: The node level.
|
|
12286
13228
|
*
|
|
12287
13229
|
* >
|
|
12288
13230
|
*
|
|
12289
|
-
* *
|
|
13231
|
+
* * 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.
|
|
12290
13232
|
*
|
|
12291
|
-
* *
|
|
13233
|
+
* * 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.
|
|
12292
13234
|
*
|
|
12293
13235
|
* @example
|
|
12294
13236
|
* 0
|
|
12295
13237
|
*/
|
|
12296
13238
|
faultSimulateMode?: string;
|
|
13239
|
+
imciAutoIndex?: string;
|
|
12297
13240
|
ownerAccount?: string;
|
|
12298
13241
|
ownerId?: number;
|
|
12299
13242
|
resourceOwnerAccount?: string;
|
|
12300
13243
|
resourceOwnerId?: number;
|
|
12301
13244
|
/**
|
|
12302
13245
|
* @remarks
|
|
12303
|
-
* Specifies whether to enable
|
|
13246
|
+
* Specifies whether to enable cross-zone automatic switchover. Valid values:
|
|
12304
13247
|
*
|
|
12305
|
-
* * **ON**:
|
|
12306
|
-
* * **OFF**:
|
|
12307
|
-
* * **0**: Enable the customer drill mode.
|
|
13248
|
+
* * **ON**: enables cross-zone automatic switchover.
|
|
13249
|
+
* * **OFF**: disables cross-zone automatic switchover.
|
|
12308
13250
|
*
|
|
12309
13251
|
* @example
|
|
12310
13252
|
* ON
|
|
@@ -12312,7 +13254,7 @@ export declare class ModifyDBClusterRequest extends $tea.Model {
|
|
|
12312
13254
|
standbyHAMode?: string;
|
|
12313
13255
|
/**
|
|
12314
13256
|
* @remarks
|
|
12315
|
-
* Specifies whether to enable automatic storage scaling
|
|
13257
|
+
* Specifies whether to enable automatic storage scaling. This parameter is available only for Standard Edition clusters. Valid values:
|
|
12316
13258
|
*
|
|
12317
13259
|
* * Enable
|
|
12318
13260
|
* * Disable
|
|
@@ -12351,11 +13293,17 @@ export declare class ModifyDBClusterResponseBody extends $tea.Model {
|
|
|
12351
13293
|
*/
|
|
12352
13294
|
DBClusterId?: string;
|
|
12353
13295
|
/**
|
|
13296
|
+
* @remarks
|
|
13297
|
+
* The order ID.
|
|
13298
|
+
*
|
|
12354
13299
|
* @example
|
|
12355
13300
|
* 2148126708*****
|
|
12356
13301
|
*/
|
|
12357
13302
|
orderId?: string;
|
|
12358
13303
|
/**
|
|
13304
|
+
* @remarks
|
|
13305
|
+
* The request ID.
|
|
13306
|
+
*
|
|
12359
13307
|
* @example
|
|
12360
13308
|
* CD3FA5F3-FAF3-44CA-AFFF-BAF869******
|
|
12361
13309
|
*/
|
|
@@ -13586,6 +14534,8 @@ export declare class ModifyDBClusterPrimaryZoneResponse extends $tea.Model {
|
|
|
13586
14534
|
export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
|
|
13587
14535
|
/**
|
|
13588
14536
|
* @remarks
|
|
14537
|
+
* The cluster ID.
|
|
14538
|
+
*
|
|
13589
14539
|
* This parameter is required.
|
|
13590
14540
|
*
|
|
13591
14541
|
* @example
|
|
@@ -13594,6 +14544,8 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
|
|
|
13594
14544
|
DBClusterId?: string;
|
|
13595
14545
|
/**
|
|
13596
14546
|
* @remarks
|
|
14547
|
+
* The ID of the new resource group.
|
|
14548
|
+
*
|
|
13597
14549
|
* This parameter is required.
|
|
13598
14550
|
*
|
|
13599
14551
|
* @example
|
|
@@ -13603,6 +14555,9 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
|
|
|
13603
14555
|
ownerAccount?: string;
|
|
13604
14556
|
ownerId?: number;
|
|
13605
14557
|
/**
|
|
14558
|
+
* @remarks
|
|
14559
|
+
* The ID of the original resource group.
|
|
14560
|
+
*
|
|
13606
14561
|
* @example
|
|
13607
14562
|
* rg-**********
|
|
13608
14563
|
*/
|
|
@@ -13621,6 +14576,9 @@ export declare class ModifyDBClusterResourceGroupRequest extends $tea.Model {
|
|
|
13621
14576
|
}
|
|
13622
14577
|
export declare class ModifyDBClusterResourceGroupResponseBody extends $tea.Model {
|
|
13623
14578
|
/**
|
|
14579
|
+
* @remarks
|
|
14580
|
+
* The request ID.
|
|
14581
|
+
*
|
|
13624
14582
|
* @example
|
|
13625
14583
|
* 70656639-1416-479F-AF13-D08197******
|
|
13626
14584
|
*/
|
|
@@ -13781,6 +14739,14 @@ export declare class ModifyDBClusterServerlessConfRequest extends $tea.Model {
|
|
|
13781
14739
|
* true
|
|
13782
14740
|
*/
|
|
13783
14741
|
allowShutDown?: string;
|
|
14742
|
+
/**
|
|
14743
|
+
* @remarks
|
|
14744
|
+
* Cycle policy ID.
|
|
14745
|
+
*
|
|
14746
|
+
* @example
|
|
14747
|
+
* 143f8e9f-2566-4dff-be47-bed79f28fc78
|
|
14748
|
+
*/
|
|
14749
|
+
crontabJobId?: string;
|
|
13784
14750
|
/**
|
|
13785
14751
|
* @remarks
|
|
13786
14752
|
* The ID of the serverless cluster.
|
|
@@ -13883,9 +14849,39 @@ export declare class ModifyDBClusterServerlessConfRequest extends $tea.Model {
|
|
|
13883
14849
|
* 10
|
|
13884
14850
|
*/
|
|
13885
14851
|
secondsUntilAutoPause?: string;
|
|
14852
|
+
/**
|
|
14853
|
+
* @remarks
|
|
14854
|
+
* CPU burst threshold
|
|
14855
|
+
*
|
|
14856
|
+
* @example
|
|
14857
|
+
* 80
|
|
14858
|
+
*/
|
|
13886
14859
|
serverlessRuleCpuEnlargeThreshold?: string;
|
|
14860
|
+
/**
|
|
14861
|
+
* @remarks
|
|
14862
|
+
* CPU downscale threshold
|
|
14863
|
+
*
|
|
14864
|
+
* @example
|
|
14865
|
+
* 50
|
|
14866
|
+
*/
|
|
13887
14867
|
serverlessRuleCpuShrinkThreshold?: string;
|
|
14868
|
+
/**
|
|
14869
|
+
* @remarks
|
|
14870
|
+
* Elastic sensitivity. Values: - normal: standard - flexible: sensitive
|
|
14871
|
+
*
|
|
14872
|
+
* @example
|
|
14873
|
+
* normal
|
|
14874
|
+
* flexible
|
|
14875
|
+
*/
|
|
13888
14876
|
serverlessRuleMode?: string;
|
|
14877
|
+
/**
|
|
14878
|
+
* @remarks
|
|
14879
|
+
* Asynchronous task ID.
|
|
14880
|
+
*
|
|
14881
|
+
* @example
|
|
14882
|
+
* 143f8e9f-2566-4dff-be47-bed79f28fc78
|
|
14883
|
+
*/
|
|
14884
|
+
taskId?: string;
|
|
13889
14885
|
static names(): {
|
|
13890
14886
|
[key: string]: string;
|
|
13891
14887
|
};
|
|
@@ -14072,12 +15068,25 @@ export declare class ModifyDBClusterTDERequest extends $tea.Model {
|
|
|
14072
15068
|
* @remarks
|
|
14073
15069
|
* The ID of the cluster.
|
|
14074
15070
|
*
|
|
14075
|
-
* This parameter is required.
|
|
15071
|
+
* This parameter is required.
|
|
15072
|
+
*
|
|
15073
|
+
* @example
|
|
15074
|
+
* pc-************
|
|
15075
|
+
*/
|
|
15076
|
+
DBClusterId?: string;
|
|
15077
|
+
/**
|
|
15078
|
+
* @remarks
|
|
15079
|
+
* 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:
|
|
15080
|
+
*
|
|
15081
|
+
* * **true**
|
|
15082
|
+
* * **false**
|
|
15083
|
+
*
|
|
15084
|
+
* > This parameter is supported only for a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle) cluster.
|
|
14076
15085
|
*
|
|
14077
15086
|
* @example
|
|
14078
|
-
*
|
|
15087
|
+
* false
|
|
14079
15088
|
*/
|
|
14080
|
-
|
|
15089
|
+
enableAutomaticRotation?: string;
|
|
14081
15090
|
/**
|
|
14082
15091
|
* @remarks
|
|
14083
15092
|
* Specifies whether to enable automatic encryption for new tables. Valid values:
|
|
@@ -14085,6 +15094,8 @@ export declare class ModifyDBClusterTDERequest extends $tea.Model {
|
|
|
14085
15094
|
* * **ON**
|
|
14086
15095
|
* * **OFF**
|
|
14087
15096
|
*
|
|
15097
|
+
* > This parameter takes effect only for a PolarDB for MySQL cluster.
|
|
15098
|
+
*
|
|
14088
15099
|
* @example
|
|
14089
15100
|
* ON
|
|
14090
15101
|
*/
|
|
@@ -14888,15 +15899,22 @@ export declare class ModifyDBNodesParametersResponse extends $tea.Model {
|
|
|
14888
15899
|
});
|
|
14889
15900
|
}
|
|
14890
15901
|
export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
|
|
15902
|
+
/**
|
|
15903
|
+
* @remarks
|
|
15904
|
+
* Create a global domain
|
|
15905
|
+
*
|
|
15906
|
+
* @example
|
|
15907
|
+
* false
|
|
15908
|
+
*/
|
|
14891
15909
|
enableGlobalDomainName?: boolean;
|
|
14892
15910
|
/**
|
|
14893
15911
|
* @remarks
|
|
14894
15912
|
* The description of the GDN. The description must meet the following requirements:
|
|
14895
15913
|
*
|
|
14896
|
-
* *
|
|
14897
|
-
* *
|
|
14898
|
-
* *
|
|
14899
|
-
* *
|
|
15914
|
+
* * The description cannot start with http:// or https://.
|
|
15915
|
+
* * The description must start with a letter.
|
|
15916
|
+
* * The description can contain letters, digits, underscores (_), and hyphens (-).
|
|
15917
|
+
* * The description must be 2 to 126 characters in length.
|
|
14900
15918
|
*
|
|
14901
15919
|
* @example
|
|
14902
15920
|
* GDN-fortest
|
|
@@ -14904,7 +15922,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
|
|
|
14904
15922
|
GDNDescription?: string;
|
|
14905
15923
|
/**
|
|
14906
15924
|
* @remarks
|
|
14907
|
-
* The ID
|
|
15925
|
+
* The GDN ID.
|
|
14908
15926
|
*
|
|
14909
15927
|
* This parameter is required.
|
|
14910
15928
|
*
|
|
@@ -14916,7 +15934,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
|
|
|
14916
15934
|
ownerId?: number;
|
|
14917
15935
|
/**
|
|
14918
15936
|
* @remarks
|
|
14919
|
-
* The
|
|
15937
|
+
* The resource group ID.
|
|
14920
15938
|
*
|
|
14921
15939
|
* @example
|
|
14922
15940
|
* rg-************
|
|
@@ -14938,7 +15956,7 @@ export declare class ModifyGlobalDatabaseNetworkRequest extends $tea.Model {
|
|
|
14938
15956
|
export declare class ModifyGlobalDatabaseNetworkResponseBody extends $tea.Model {
|
|
14939
15957
|
/**
|
|
14940
15958
|
* @remarks
|
|
14941
|
-
* The ID
|
|
15959
|
+
* The request ID.
|
|
14942
15960
|
*
|
|
14943
15961
|
* @example
|
|
14944
15962
|
* C61892A4-0850-4516-9E26-44D96C1782DE
|
|
@@ -15630,6 +16648,12 @@ export declare class OpenAITaskRequest extends $tea.Model {
|
|
|
15630
16648
|
*/
|
|
15631
16649
|
DBClusterId?: string;
|
|
15632
16650
|
/**
|
|
16651
|
+
* @remarks
|
|
16652
|
+
* The node type. Valid values:
|
|
16653
|
+
*
|
|
16654
|
+
* * **DLNode**: This node is an AI node.
|
|
16655
|
+
* * **SearchNode**: This node is a node for which the PolarDB for AI feature is enabled.
|
|
16656
|
+
*
|
|
15633
16657
|
* @example
|
|
15634
16658
|
* DLNode
|
|
15635
16659
|
*/
|
|
@@ -16459,6 +17483,8 @@ export declare class TagResourcesRequest extends $tea.Model {
|
|
|
16459
17483
|
regionId?: string;
|
|
16460
17484
|
/**
|
|
16461
17485
|
* @remarks
|
|
17486
|
+
* The cluster ID.
|
|
17487
|
+
*
|
|
16462
17488
|
* This parameter is required.
|
|
16463
17489
|
*
|
|
16464
17490
|
* @example
|
|
@@ -16479,6 +17505,8 @@ export declare class TagResourcesRequest extends $tea.Model {
|
|
|
16479
17505
|
resourceType?: string;
|
|
16480
17506
|
/**
|
|
16481
17507
|
* @remarks
|
|
17508
|
+
* The tags.
|
|
17509
|
+
*
|
|
16482
17510
|
* This parameter is required.
|
|
16483
17511
|
*/
|
|
16484
17512
|
tag?: TagResourcesRequestTag[];
|
|
@@ -16565,9 +17593,9 @@ export declare class TempModifyDBNodeRequest extends $tea.Model {
|
|
|
16565
17593
|
modifyType?: string;
|
|
16566
17594
|
/**
|
|
16567
17595
|
* @remarks
|
|
16568
|
-
* The
|
|
17596
|
+
* The operation type. Valid values:
|
|
16569
17597
|
*
|
|
16570
|
-
* * **Modify**: temporarily
|
|
17598
|
+
* * **Modify**: temporarily upgrades the configuration of the cluster.
|
|
16571
17599
|
*
|
|
16572
17600
|
* This parameter is required.
|
|
16573
17601
|
*
|
|
@@ -16822,9 +17850,9 @@ export declare class TransformDBClusterPayTypeResponse extends $tea.Model {
|
|
|
16822
17850
|
export declare class UntagResourcesRequest extends $tea.Model {
|
|
16823
17851
|
/**
|
|
16824
17852
|
* @remarks
|
|
16825
|
-
* Specifies whether to
|
|
17853
|
+
* Specifies whether to detach all tags from the cluster. Valid values: **true** and **false**. Default value: **false**.
|
|
16826
17854
|
*
|
|
16827
|
-
* > This parameter takes effect only
|
|
17855
|
+
* > This parameter takes effect only if `TagKey.n` is empty.
|
|
16828
17856
|
*
|
|
16829
17857
|
* @example
|
|
16830
17858
|
* true
|
|
@@ -16971,12 +17999,19 @@ export declare class UpgradeDBClusterVersionRequest extends $tea.Model {
|
|
|
16971
17999
|
resourceOwnerId?: number;
|
|
16972
18000
|
/**
|
|
16973
18001
|
* @remarks
|
|
16974
|
-
* The code of the version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](https://help.aliyun.com/document_detail/2319145.html) operation to query the version code.
|
|
18002
|
+
* The code of the db version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](https://help.aliyun.com/document_detail/2319145.html) operation to query the version code.
|
|
16975
18003
|
*
|
|
16976
18004
|
* @example
|
|
16977
18005
|
* 20230707
|
|
16978
18006
|
*/
|
|
16979
18007
|
targetDBRevisionVersionCode?: string;
|
|
18008
|
+
/**
|
|
18009
|
+
* @remarks
|
|
18010
|
+
* The code of the proxy version to which you want to upgrade the cluster. You can call the [DescribeDBClusterVersion](https://help.aliyun.com/document_detail/2319145.html) operation to query the version code.
|
|
18011
|
+
*
|
|
18012
|
+
* @example
|
|
18013
|
+
* 20240702
|
|
18014
|
+
*/
|
|
16980
18015
|
targetProxyRevisionVersionCode?: string;
|
|
16981
18016
|
/**
|
|
16982
18017
|
* @remarks
|
|
@@ -16991,10 +18026,10 @@ export declare class UpgradeDBClusterVersionRequest extends $tea.Model {
|
|
|
16991
18026
|
upgradeLabel?: string;
|
|
16992
18027
|
/**
|
|
16993
18028
|
* @remarks
|
|
16994
|
-
* The upgrade policy. Valid values:
|
|
18029
|
+
* The engine version upgrade policy. Valid values:
|
|
16995
18030
|
*
|
|
16996
18031
|
* * **HOT**: hot upgrade.
|
|
16997
|
-
* * **COLD**: cold upgrade. Only PolarDB for MySQL Cluster Edition
|
|
18032
|
+
* * **COLD**: cold upgrade. Only PolarDB for MySQL 8.0 Cluster Edition supports this upgrade method.
|
|
16998
18033
|
*
|
|
16999
18034
|
* @example
|
|
17000
18035
|
* HOT
|
|
@@ -17060,9 +18095,9 @@ export declare class UpgradeDBClusterVersionResponse extends $tea.Model {
|
|
|
17060
18095
|
export declare class CreateDBClusterRequestTag extends $tea.Model {
|
|
17061
18096
|
/**
|
|
17062
18097
|
* @remarks
|
|
17063
|
-
*
|
|
18098
|
+
* Tag key. If you need to add multiple tags to the target cluster at once, click **Add** to add a tag key.
|
|
17064
18099
|
*
|
|
17065
|
-
* >
|
|
18100
|
+
* > Up to 20 pairs of tags can be added each time, where `Tag.N.Key` corresponds to `Tag.N.Value`.
|
|
17066
18101
|
*
|
|
17067
18102
|
* @example
|
|
17068
18103
|
* type
|
|
@@ -17070,9 +18105,9 @@ export declare class CreateDBClusterRequestTag extends $tea.Model {
|
|
|
17070
18105
|
key?: string;
|
|
17071
18106
|
/**
|
|
17072
18107
|
* @remarks
|
|
17073
|
-
*
|
|
18108
|
+
* Tag value. If you need to add multiple tags to the target cluster at once, click **Add** to add tag values.
|
|
17074
18109
|
*
|
|
17075
|
-
* >
|
|
18110
|
+
* > Up to 20 pairs of tags can be added each time, where `Tag.N.Value` corresponds to `Tag.N.Key`.
|
|
17076
18111
|
*
|
|
17077
18112
|
* @example
|
|
17078
18113
|
* test
|
|
@@ -17370,6 +18405,62 @@ export declare class DescribeAccountsResponseBodyAccounts extends $tea.Model {
|
|
|
17370
18405
|
[key: string]: any;
|
|
17371
18406
|
});
|
|
17372
18407
|
}
|
|
18408
|
+
export declare class DescribeActivationCodesResponseBodyItems extends $tea.Model {
|
|
18409
|
+
/**
|
|
18410
|
+
* @example
|
|
18411
|
+
* 2024-10-16 16:46:20
|
|
18412
|
+
*/
|
|
18413
|
+
activateAt?: string;
|
|
18414
|
+
/**
|
|
18415
|
+
* @example
|
|
18416
|
+
* testCode
|
|
18417
|
+
*/
|
|
18418
|
+
description?: string;
|
|
18419
|
+
/**
|
|
18420
|
+
* @example
|
|
18421
|
+
* 2054-10-16 16:46:20
|
|
18422
|
+
*/
|
|
18423
|
+
expireAt?: string;
|
|
18424
|
+
/**
|
|
18425
|
+
* @example
|
|
18426
|
+
* 2024-10-16 16:46:20
|
|
18427
|
+
*/
|
|
18428
|
+
gmtCreated?: string;
|
|
18429
|
+
/**
|
|
18430
|
+
* @example
|
|
18431
|
+
* 2024-10-16 16:46:20
|
|
18432
|
+
*/
|
|
18433
|
+
gmtModified?: string;
|
|
18434
|
+
/**
|
|
18435
|
+
* @example
|
|
18436
|
+
* 123
|
|
18437
|
+
*/
|
|
18438
|
+
id?: number;
|
|
18439
|
+
/**
|
|
18440
|
+
* @example
|
|
18441
|
+
* 12:34:56:78:98:00
|
|
18442
|
+
*/
|
|
18443
|
+
macAddress?: string;
|
|
18444
|
+
/**
|
|
18445
|
+
* @example
|
|
18446
|
+
* testName
|
|
18447
|
+
*/
|
|
18448
|
+
name?: string;
|
|
18449
|
+
/**
|
|
18450
|
+
* @example
|
|
18451
|
+
* 1234567890123456
|
|
18452
|
+
*/
|
|
18453
|
+
systemIdentifier?: string;
|
|
18454
|
+
static names(): {
|
|
18455
|
+
[key: string]: string;
|
|
18456
|
+
};
|
|
18457
|
+
static types(): {
|
|
18458
|
+
[key: string]: any;
|
|
18459
|
+
};
|
|
18460
|
+
constructor(map?: {
|
|
18461
|
+
[key: string]: any;
|
|
18462
|
+
});
|
|
18463
|
+
}
|
|
17373
18464
|
export declare class DescribeAutoRenewAttributeResponseBodyItemsAutoRenewAttribute extends $tea.Model {
|
|
17374
18465
|
/**
|
|
17375
18466
|
* @remarks
|
|
@@ -18060,20 +19151,23 @@ export declare class DescribeDBClusterAccessWhitelistResponseBodyItems extends $
|
|
|
18060
19151
|
export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
18061
19152
|
/**
|
|
18062
19153
|
* @remarks
|
|
18063
|
-
*
|
|
19154
|
+
* Number of CPU cores for second-level elastic scaling.
|
|
18064
19155
|
*
|
|
18065
19156
|
* @example
|
|
18066
19157
|
* 6
|
|
18067
19158
|
*/
|
|
18068
19159
|
addedCpuCores?: string;
|
|
18069
19160
|
/**
|
|
19161
|
+
* @remarks
|
|
19162
|
+
* Number of CPU cores for the node.
|
|
19163
|
+
*
|
|
18070
19164
|
* @example
|
|
18071
19165
|
* 2
|
|
18072
19166
|
*/
|
|
18073
19167
|
cpuCores?: string;
|
|
18074
19168
|
/**
|
|
18075
19169
|
* @remarks
|
|
18076
|
-
*
|
|
19170
|
+
* Node creation time.
|
|
18077
19171
|
*
|
|
18078
19172
|
* @example
|
|
18079
19173
|
* 2020-03-23T21:35:43Z
|
|
@@ -18081,7 +19175,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18081
19175
|
creationTime?: string;
|
|
18082
19176
|
/**
|
|
18083
19177
|
* @remarks
|
|
18084
|
-
*
|
|
19178
|
+
* Node specification.
|
|
18085
19179
|
*
|
|
18086
19180
|
* @example
|
|
18087
19181
|
* polar.mysql.x4.large
|
|
@@ -18089,7 +19183,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18089
19183
|
DBNodeClass?: string;
|
|
18090
19184
|
/**
|
|
18091
19185
|
* @remarks
|
|
18092
|
-
*
|
|
19186
|
+
* Node ID.
|
|
18093
19187
|
*
|
|
18094
19188
|
* @example
|
|
18095
19189
|
* pi-****************
|
|
@@ -18097,10 +19191,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18097
19191
|
DBNodeId?: string;
|
|
18098
19192
|
/**
|
|
18099
19193
|
* @remarks
|
|
18100
|
-
*
|
|
19194
|
+
* Node role, with possible values as follows:
|
|
18101
19195
|
*
|
|
18102
|
-
*
|
|
18103
|
-
*
|
|
19196
|
+
* - **Writer**: Primary node.
|
|
19197
|
+
* - **Reader**: Read-only node.
|
|
18104
19198
|
*
|
|
18105
19199
|
* @example
|
|
18106
19200
|
* Reader
|
|
@@ -18108,21 +19202,20 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18108
19202
|
DBNodeRole?: string;
|
|
18109
19203
|
/**
|
|
18110
19204
|
* @remarks
|
|
18111
|
-
*
|
|
18112
|
-
*
|
|
18113
|
-
* *
|
|
18114
|
-
* *
|
|
18115
|
-
* *
|
|
18116
|
-
* *
|
|
18117
|
-
* *
|
|
18118
|
-
* *
|
|
18119
|
-
* *
|
|
18120
|
-
* *
|
|
18121
|
-
* *
|
|
18122
|
-
* *
|
|
18123
|
-
* *
|
|
18124
|
-
* *
|
|
18125
|
-
* * **Switching**: A failover is being performed.
|
|
19205
|
+
* Node status, with possible values as follows:
|
|
19206
|
+
* * **Creating**: Creating
|
|
19207
|
+
* * **Running**: Running
|
|
19208
|
+
* * **Deleting**: Deleting
|
|
19209
|
+
* * **Rebooting**: Rebooting
|
|
19210
|
+
* * **DBNodeCreating**: Adding node
|
|
19211
|
+
* * **DBNodeDeleting**: Removing node
|
|
19212
|
+
* * **ClassChanging**: Modifying node specification
|
|
19213
|
+
* * **NetAddressCreating**: Creating network connection
|
|
19214
|
+
* * **NetAddressDeleting**: Deleting network connection
|
|
19215
|
+
* * **NetAddressModifying**: Modifying network connection
|
|
19216
|
+
* * **MinorVersionUpgrading**: Upgrading minor version
|
|
19217
|
+
* * **Maintaining**: Instance maintenance
|
|
19218
|
+
* * **Switching**: Switching
|
|
18126
19219
|
*
|
|
18127
19220
|
* @example
|
|
18128
19221
|
* Running
|
|
@@ -18130,7 +19223,8 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18130
19223
|
DBNodeStatus?: string;
|
|
18131
19224
|
/**
|
|
18132
19225
|
* @remarks
|
|
18133
|
-
*
|
|
19226
|
+
* 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.
|
|
19227
|
+
* Range: 1 to 15.
|
|
18134
19228
|
*
|
|
18135
19229
|
* @example
|
|
18136
19230
|
* 1
|
|
@@ -18138,10 +19232,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18138
19232
|
failoverPriority?: number;
|
|
18139
19233
|
/**
|
|
18140
19234
|
* @remarks
|
|
18141
|
-
*
|
|
19235
|
+
* Whether hot standby is enabled. Possible values are:
|
|
18142
19236
|
*
|
|
18143
|
-
*
|
|
18144
|
-
*
|
|
19237
|
+
* - **ON**: Enabled
|
|
19238
|
+
* - **OFF**: Disabled
|
|
18145
19239
|
*
|
|
18146
19240
|
* @example
|
|
18147
19241
|
* ON
|
|
@@ -18149,10 +19243,10 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18149
19243
|
hotReplicaMode?: string;
|
|
18150
19244
|
/**
|
|
18151
19245
|
* @remarks
|
|
18152
|
-
*
|
|
19246
|
+
* Whether columnar index is enabled. Possible values are:
|
|
18153
19247
|
*
|
|
18154
|
-
*
|
|
18155
|
-
*
|
|
19248
|
+
* - **ON**: Enabled
|
|
19249
|
+
* - **OFF**: Disabled
|
|
18156
19250
|
*
|
|
18157
19251
|
* @example
|
|
18158
19252
|
* ON
|
|
@@ -18160,7 +19254,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18160
19254
|
imciSwitch?: string;
|
|
18161
19255
|
/**
|
|
18162
19256
|
* @remarks
|
|
18163
|
-
*
|
|
19257
|
+
* Primary node ID of the multi-master architecture cluster edition.
|
|
18164
19258
|
*
|
|
18165
19259
|
* @example
|
|
18166
19260
|
* pi-bp18z52akld3*****
|
|
@@ -18168,7 +19262,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18168
19262
|
masterId?: string;
|
|
18169
19263
|
/**
|
|
18170
19264
|
* @remarks
|
|
18171
|
-
*
|
|
19265
|
+
* Maximum concurrent connections of the cluster.
|
|
18172
19266
|
*
|
|
18173
19267
|
* @example
|
|
18174
19268
|
* 8000
|
|
@@ -18176,34 +19270,55 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18176
19270
|
maxConnections?: number;
|
|
18177
19271
|
/**
|
|
18178
19272
|
* @remarks
|
|
18179
|
-
*
|
|
19273
|
+
* Maximum number of I/O requests, that is, IOPS.
|
|
18180
19274
|
*
|
|
18181
19275
|
* @example
|
|
18182
19276
|
* 32000
|
|
18183
19277
|
*/
|
|
18184
19278
|
maxIOPS?: number;
|
|
18185
19279
|
/**
|
|
19280
|
+
* @remarks
|
|
19281
|
+
* Node memory size, in MB.
|
|
19282
|
+
*
|
|
18186
19283
|
* @example
|
|
18187
19284
|
* 8192
|
|
18188
19285
|
*/
|
|
18189
19286
|
memorySize?: string;
|
|
19287
|
+
/**
|
|
19288
|
+
* @remarks
|
|
19289
|
+
* The name of the hot standby compute node corresponding to the node when the hot standby storage and compute clusters feature is enabled.
|
|
19290
|
+
*
|
|
19291
|
+
* @example
|
|
19292
|
+
* pi-bp18z52mirror*****
|
|
19293
|
+
*/
|
|
18190
19294
|
mirrorInsName?: string;
|
|
19295
|
+
multiMasterLocalStandby?: string;
|
|
19296
|
+
multiMasterPrimaryNode?: string;
|
|
18191
19297
|
/**
|
|
19298
|
+
* @remarks
|
|
19299
|
+
* Orca feature, valid values are:
|
|
19300
|
+
* - on: enabled
|
|
19301
|
+
* - off: disabled
|
|
19302
|
+
*
|
|
18192
19303
|
* @example
|
|
18193
19304
|
* off
|
|
18194
19305
|
*/
|
|
18195
19306
|
orca?: string;
|
|
18196
19307
|
/**
|
|
19308
|
+
* @remarks
|
|
19309
|
+
* Remote memory size, in MB.
|
|
19310
|
+
*
|
|
18197
19311
|
* @example
|
|
18198
19312
|
* 3072
|
|
18199
19313
|
*/
|
|
18200
19314
|
remoteMemorySize?: string;
|
|
18201
19315
|
/**
|
|
18202
19316
|
* @remarks
|
|
18203
|
-
*
|
|
19317
|
+
* Whether the node has the global consistency (high-performance mode) feature enabled. Possible values are:
|
|
18204
19318
|
*
|
|
18205
|
-
*
|
|
18206
|
-
*
|
|
19319
|
+
* - **ON**: Enabled
|
|
19320
|
+
*
|
|
19321
|
+
* - **OFF**: Disabled
|
|
18207
19322
|
*
|
|
18208
19323
|
* This parameter is required.
|
|
18209
19324
|
*
|
|
@@ -18213,7 +19328,8 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18213
19328
|
sccMode?: string;
|
|
18214
19329
|
/**
|
|
18215
19330
|
* @remarks
|
|
18216
|
-
*
|
|
19331
|
+
* Routing weight.
|
|
19332
|
+
* Range: 1~100. Default is 1.
|
|
18217
19333
|
*
|
|
18218
19334
|
* @example
|
|
18219
19335
|
* 1
|
|
@@ -18221,22 +19337,31 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18221
19337
|
serverWeight?: string;
|
|
18222
19338
|
/**
|
|
18223
19339
|
* @remarks
|
|
18224
|
-
*
|
|
19340
|
+
* Serverless type. Possible values include:
|
|
18225
19341
|
*
|
|
18226
|
-
*
|
|
19342
|
+
* - **AgileServerless**: Agile
|
|
19343
|
+
* - **SteadyServerless**: Steady
|
|
19344
|
+
*
|
|
19345
|
+
* > This parameter is only supported by Serverless clusters.
|
|
18227
19346
|
*
|
|
18228
19347
|
* @example
|
|
18229
19348
|
* AgileServerless
|
|
18230
19349
|
*/
|
|
18231
19350
|
serverlessType?: string;
|
|
18232
19351
|
/**
|
|
19352
|
+
* @remarks
|
|
19353
|
+
* Identifies whether the node is in the primary or standby availability zone, primarily used in resource mirroring scenarios.
|
|
19354
|
+
* Values include:
|
|
19355
|
+
* - **Primary**: Primary Availability Zone
|
|
19356
|
+
* - **Standby**: Standby Availability Zone
|
|
19357
|
+
*
|
|
18233
19358
|
* @example
|
|
18234
19359
|
* Primary
|
|
18235
19360
|
*/
|
|
18236
19361
|
subCluster?: string;
|
|
18237
19362
|
/**
|
|
18238
19363
|
* @remarks
|
|
18239
|
-
*
|
|
19364
|
+
* Availability zone ID.
|
|
18240
19365
|
*
|
|
18241
19366
|
* @example
|
|
18242
19367
|
* cn-hangzhou-i
|
|
@@ -18255,7 +19380,7 @@ export declare class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.
|
|
|
18255
19380
|
export declare class DescribeDBClusterAttributeResponseBodyTags extends $tea.Model {
|
|
18256
19381
|
/**
|
|
18257
19382
|
* @remarks
|
|
18258
|
-
*
|
|
19383
|
+
* Tag key.
|
|
18259
19384
|
*
|
|
18260
19385
|
* @example
|
|
18261
19386
|
* test
|
|
@@ -18263,7 +19388,7 @@ export declare class DescribeDBClusterAttributeResponseBodyTags extends $tea.Mod
|
|
|
18263
19388
|
key?: string;
|
|
18264
19389
|
/**
|
|
18265
19390
|
* @remarks
|
|
18266
|
-
*
|
|
19391
|
+
* Tag value.
|
|
18267
19392
|
*
|
|
18268
19393
|
* @example
|
|
18269
19394
|
* MySQL
|
|
@@ -18775,7 +19900,12 @@ export declare class DescribeDBClusterMigrationResponseBodyRdsEndpointList exten
|
|
|
18775
19900
|
addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
|
|
18776
19901
|
/**
|
|
18777
19902
|
* @remarks
|
|
18778
|
-
* The
|
|
19903
|
+
* The role of the source database instance.
|
|
19904
|
+
*
|
|
19905
|
+
* @example
|
|
19906
|
+
* ReadOnly
|
|
19907
|
+
* Maxscale
|
|
19908
|
+
* Primary
|
|
18779
19909
|
*/
|
|
18780
19910
|
custinsType?: string;
|
|
18781
19911
|
/**
|
|
@@ -19647,6 +20777,16 @@ export declare class DescribeDBClustersResponseBodyItemsDBCluster extends $tea.M
|
|
|
19647
20777
|
* false
|
|
19648
20778
|
*/
|
|
19649
20779
|
expired?: string;
|
|
20780
|
+
/**
|
|
20781
|
+
* @remarks
|
|
20782
|
+
* Indicates whether the hot standby storage cluster feature is enabled. Valid values:
|
|
20783
|
+
*
|
|
20784
|
+
* * ON
|
|
20785
|
+
* * OFF
|
|
20786
|
+
*
|
|
20787
|
+
* @example
|
|
20788
|
+
* OFF
|
|
20789
|
+
*/
|
|
19650
20790
|
hotStandbyCluster?: string;
|
|
19651
20791
|
/**
|
|
19652
20792
|
* @remarks
|
|
@@ -20050,12 +21190,15 @@ export declare class DescribeDBInitializeVariableResponseBodyVariablesVariable e
|
|
|
20050
21190
|
* @remarks
|
|
20051
21191
|
* The language that indicates the character type of the database.
|
|
20052
21192
|
*
|
|
20053
|
-
*
|
|
20054
|
-
* >- The specified value must be the same as the value of **Collate**.
|
|
20055
|
-
* >- This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.
|
|
20056
|
-
* >- This parameter is optional for PolarDB for MySQL clusters.
|
|
21193
|
+
* >
|
|
20057
21194
|
*
|
|
20058
|
-
*
|
|
21195
|
+
* * The language must be compatible with the character set that is specified by **CharacterSetName**.
|
|
21196
|
+
*
|
|
21197
|
+
* * The specified parameter value must be the same as the value of **Collate**.
|
|
21198
|
+
*
|
|
21199
|
+
* * If the PolarDB cluster runs PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL, this parameter is required. If the cluster runs PolarDB for MySQL, this parameter is not supported.
|
|
21200
|
+
*
|
|
21201
|
+
* To view the valid values of this parameter, perform the following steps: First, log on to the PolarDB console and click the ID of a cluster. Then, in the left-side navigation pane, choose **Settings and Management** > **Databases**. Finally, click **Create Database**.
|
|
20059
21202
|
*
|
|
20060
21203
|
* @example
|
|
20061
21204
|
* C
|
|
@@ -20900,6 +22043,13 @@ export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClustersDBNodes
|
|
|
20900
22043
|
});
|
|
20901
22044
|
}
|
|
20902
22045
|
export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClusters extends $tea.Model {
|
|
22046
|
+
/**
|
|
22047
|
+
* @remarks
|
|
22048
|
+
* The edition of the cluster.
|
|
22049
|
+
*
|
|
22050
|
+
* @example
|
|
22051
|
+
* Normal
|
|
22052
|
+
*/
|
|
20903
22053
|
category?: string;
|
|
20904
22054
|
/**
|
|
20905
22055
|
* @remarks
|
|
@@ -21263,6 +22413,82 @@ export declare class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecu
|
|
|
21263
22413
|
[key: string]: any;
|
|
21264
22414
|
});
|
|
21265
22415
|
}
|
|
22416
|
+
export declare class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
|
|
22417
|
+
/**
|
|
22418
|
+
* @example
|
|
22419
|
+
* 10
|
|
22420
|
+
*/
|
|
22421
|
+
activatedCodeCount?: number;
|
|
22422
|
+
/**
|
|
22423
|
+
* @example
|
|
22424
|
+
* 10
|
|
22425
|
+
*/
|
|
22426
|
+
activationCodeQuota?: number;
|
|
22427
|
+
/**
|
|
22428
|
+
* @example
|
|
22429
|
+
* 227638319690519
|
|
22430
|
+
*/
|
|
22431
|
+
aliyunOrderId?: string;
|
|
22432
|
+
/**
|
|
22433
|
+
* @example
|
|
22434
|
+
* false
|
|
22435
|
+
*/
|
|
22436
|
+
allowEmptySystemIdentifier?: boolean;
|
|
22437
|
+
/**
|
|
22438
|
+
* @example
|
|
22439
|
+
* PG
|
|
22440
|
+
*/
|
|
22441
|
+
engine?: string;
|
|
22442
|
+
/**
|
|
22443
|
+
* @example
|
|
22444
|
+
* 2022-02-11 03:14:15
|
|
22445
|
+
*/
|
|
22446
|
+
gmtCreated?: string;
|
|
22447
|
+
/**
|
|
22448
|
+
* @example
|
|
22449
|
+
* 2022-02-11 03:14:15
|
|
22450
|
+
*/
|
|
22451
|
+
gmtModified?: string;
|
|
22452
|
+
/**
|
|
22453
|
+
* @example
|
|
22454
|
+
* false
|
|
22455
|
+
*/
|
|
22456
|
+
isVirtualOrder?: boolean;
|
|
22457
|
+
/**
|
|
22458
|
+
* @example
|
|
22459
|
+
* false
|
|
22460
|
+
*/
|
|
22461
|
+
isVirtualOrderFrozen?: boolean;
|
|
22462
|
+
/**
|
|
22463
|
+
* @example
|
|
22464
|
+
* single_node_subscribe
|
|
22465
|
+
*/
|
|
22466
|
+
packageType?: string;
|
|
22467
|
+
/**
|
|
22468
|
+
* @example
|
|
22469
|
+
* 1 year
|
|
22470
|
+
*/
|
|
22471
|
+
packageValidity?: string;
|
|
22472
|
+
/**
|
|
22473
|
+
* @example
|
|
22474
|
+
* aliyun_public
|
|
22475
|
+
*/
|
|
22476
|
+
purchaseChannel?: string;
|
|
22477
|
+
/**
|
|
22478
|
+
* @example
|
|
22479
|
+
* 227638319690519
|
|
22480
|
+
*/
|
|
22481
|
+
virtualAliyunOrderId?: string;
|
|
22482
|
+
static names(): {
|
|
22483
|
+
[key: string]: string;
|
|
22484
|
+
};
|
|
22485
|
+
static types(): {
|
|
22486
|
+
[key: string]: any;
|
|
22487
|
+
};
|
|
22488
|
+
constructor(map?: {
|
|
22489
|
+
[key: string]: any;
|
|
22490
|
+
});
|
|
22491
|
+
}
|
|
21266
22492
|
export declare class DescribeMaskingRulesResponseBodyData extends $tea.Model {
|
|
21267
22493
|
/**
|
|
21268
22494
|
* @remarks
|
|
@@ -21892,6 +23118,14 @@ export declare class DescribeScheduleTasksResponseBodyDataTimerInfos extends $te
|
|
|
21892
23118
|
* CreateDBNodes
|
|
21893
23119
|
*/
|
|
21894
23120
|
action?: string;
|
|
23121
|
+
/**
|
|
23122
|
+
* @remarks
|
|
23123
|
+
* The ID of the scheduled task.
|
|
23124
|
+
*
|
|
23125
|
+
* @example
|
|
23126
|
+
* 86293c29-a03d-4872-b625-***********
|
|
23127
|
+
*/
|
|
23128
|
+
crontabJobId?: string;
|
|
21895
23129
|
/**
|
|
21896
23130
|
* @remarks
|
|
21897
23131
|
* The cluster ID.
|
|
@@ -22015,7 +23249,7 @@ export declare class DescribeScheduleTasksResponseBodyData extends $tea.Model {
|
|
|
22015
23249
|
pageSize?: number;
|
|
22016
23250
|
/**
|
|
22017
23251
|
* @remarks
|
|
22018
|
-
* The details of the scheduled
|
|
23252
|
+
* The details of the scheduled tasks.
|
|
22019
23253
|
*/
|
|
22020
23254
|
timerInfos?: DescribeScheduleTasksResponseBodyDataTimerInfos[];
|
|
22021
23255
|
/**
|
|
@@ -22039,7 +23273,7 @@ export declare class DescribeScheduleTasksResponseBodyData extends $tea.Model {
|
|
|
22039
23273
|
export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extends $tea.Model {
|
|
22040
23274
|
/**
|
|
22041
23275
|
* @remarks
|
|
22042
|
-
*
|
|
23276
|
+
* Database name.
|
|
22043
23277
|
*
|
|
22044
23278
|
* @example
|
|
22045
23279
|
* testdb
|
|
@@ -22047,7 +23281,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22047
23281
|
DBName?: string;
|
|
22048
23282
|
/**
|
|
22049
23283
|
* @remarks
|
|
22050
|
-
*
|
|
23284
|
+
* Node ID.
|
|
22051
23285
|
*
|
|
22052
23286
|
* @example
|
|
22053
23287
|
* pi-*****************
|
|
@@ -22055,7 +23289,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22055
23289
|
DBNodeId?: string;
|
|
22056
23290
|
/**
|
|
22057
23291
|
* @remarks
|
|
22058
|
-
*
|
|
23292
|
+
* Time when the SQL starts execution. The format is `YYYY-MM-DDThh:mmZ` (UTC time).
|
|
22059
23293
|
*
|
|
22060
23294
|
* @example
|
|
22061
23295
|
* 2021-04-07T03:47Z
|
|
@@ -22063,7 +23297,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22063
23297
|
executionStartTime?: string;
|
|
22064
23298
|
/**
|
|
22065
23299
|
* @remarks
|
|
22066
|
-
*
|
|
23300
|
+
* Client address connecting to the database.
|
|
22067
23301
|
*
|
|
22068
23302
|
* @example
|
|
22069
23303
|
* testdb[testdb] @ [100.**.**.242]
|
|
@@ -22071,7 +23305,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22071
23305
|
hostAddress?: string;
|
|
22072
23306
|
/**
|
|
22073
23307
|
* @remarks
|
|
22074
|
-
*
|
|
23308
|
+
* SQL lock duration in seconds.
|
|
22075
23309
|
*
|
|
22076
23310
|
* @example
|
|
22077
23311
|
* 0
|
|
@@ -22079,7 +23313,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22079
23313
|
lockTimes?: number;
|
|
22080
23314
|
/**
|
|
22081
23315
|
* @remarks
|
|
22082
|
-
*
|
|
23316
|
+
* Number of rows parsed.
|
|
22083
23317
|
*
|
|
22084
23318
|
* @example
|
|
22085
23319
|
* 0
|
|
@@ -22087,7 +23321,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22087
23321
|
parseRowCounts?: number;
|
|
22088
23322
|
/**
|
|
22089
23323
|
* @remarks
|
|
22090
|
-
*
|
|
23324
|
+
* Query time. Unit: milliseconds.
|
|
22091
23325
|
*
|
|
22092
23326
|
* @example
|
|
22093
23327
|
* 100
|
|
@@ -22095,7 +23329,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22095
23329
|
queryTimeMS?: number;
|
|
22096
23330
|
/**
|
|
22097
23331
|
* @remarks
|
|
22098
|
-
*
|
|
23332
|
+
* SQL execution duration, in seconds.
|
|
22099
23333
|
*
|
|
22100
23334
|
* @example
|
|
22101
23335
|
* 20
|
|
@@ -22103,7 +23337,7 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22103
23337
|
queryTimes?: number;
|
|
22104
23338
|
/**
|
|
22105
23339
|
* @remarks
|
|
22106
|
-
*
|
|
23340
|
+
* Number of rows returned.
|
|
22107
23341
|
*
|
|
22108
23342
|
* @example
|
|
22109
23343
|
* 0
|
|
@@ -22111,7 +23345,15 @@ export declare class DescribeSlowLogRecordsResponseBodyItemsSQLSlowRecord extend
|
|
|
22111
23345
|
returnRowCounts?: number;
|
|
22112
23346
|
/**
|
|
22113
23347
|
* @remarks
|
|
22114
|
-
*
|
|
23348
|
+
* Unique identifier for the SQL statement in slow log statistics.
|
|
23349
|
+
*
|
|
23350
|
+
* @example
|
|
23351
|
+
* U2FsdGVk****
|
|
23352
|
+
*/
|
|
23353
|
+
SQLHash?: string;
|
|
23354
|
+
/**
|
|
23355
|
+
* @remarks
|
|
23356
|
+
* Query statement.
|
|
22115
23357
|
*/
|
|
22116
23358
|
SQLText?: string;
|
|
22117
23359
|
static names(): {
|
|
@@ -22496,7 +23738,7 @@ export declare class DescribeVSwitchesResponseBodyVSwitchs extends $tea.Model {
|
|
|
22496
23738
|
export declare class ListTagResourcesRequestTag extends $tea.Model {
|
|
22497
23739
|
/**
|
|
22498
23740
|
* @remarks
|
|
22499
|
-
* The key
|
|
23741
|
+
* The tag key. To query the details of clusters to which multiple tags are added, click **Add** to add tags.
|
|
22500
23742
|
*
|
|
22501
23743
|
* >
|
|
22502
23744
|
*
|
|
@@ -22767,9 +24009,9 @@ export declare class ModifyGlobalSecurityIPGroupRelationResponseBodyGlobalSecuri
|
|
|
22767
24009
|
export declare class TagResourcesRequestTag extends $tea.Model {
|
|
22768
24010
|
/**
|
|
22769
24011
|
* @remarks
|
|
22770
|
-
* The key of the tag. To create multiple tags for a cluster at a time, click **Add** to add tag keys.
|
|
24012
|
+
* 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.
|
|
22771
24013
|
*
|
|
22772
|
-
* > You can create up to 20 tags
|
|
24014
|
+
* > 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`.
|
|
22773
24015
|
*
|
|
22774
24016
|
* @example
|
|
22775
24017
|
* type
|
|
@@ -22777,9 +24019,9 @@ export declare class TagResourcesRequestTag extends $tea.Model {
|
|
|
22777
24019
|
key?: string;
|
|
22778
24020
|
/**
|
|
22779
24021
|
* @remarks
|
|
22780
|
-
* The value of the tag. To create multiple tags for a cluster at a time, click **Add** to add tag values.
|
|
24022
|
+
* 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.
|
|
22781
24023
|
*
|
|
22782
|
-
* > You can create up to 20 tags
|
|
24024
|
+
* > 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`.
|
|
22783
24025
|
*
|
|
22784
24026
|
* @example
|
|
22785
24027
|
* test
|
|
@@ -22959,6 +24201,21 @@ export default class Client extends OpenApi {
|
|
|
22959
24201
|
* @returns CreateAccountResponse
|
|
22960
24202
|
*/
|
|
22961
24203
|
createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
|
|
24204
|
+
/**
|
|
24205
|
+
* 生成轻量化版本激活码
|
|
24206
|
+
*
|
|
24207
|
+
* @param request - CreateActivationCodeRequest
|
|
24208
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
24209
|
+
* @returns CreateActivationCodeResponse
|
|
24210
|
+
*/
|
|
24211
|
+
createActivationCodeWithOptions(request: CreateActivationCodeRequest, runtime: $Util.RuntimeOptions): Promise<CreateActivationCodeResponse>;
|
|
24212
|
+
/**
|
|
24213
|
+
* 生成轻量化版本激活码
|
|
24214
|
+
*
|
|
24215
|
+
* @param request - CreateActivationCodeRequest
|
|
24216
|
+
* @returns CreateActivationCodeResponse
|
|
24217
|
+
*/
|
|
24218
|
+
createActivationCode(request: CreateActivationCodeRequest): Promise<CreateActivationCodeResponse>;
|
|
22962
24219
|
/**
|
|
22963
24220
|
* Creates a full snapshot backup for a PolarDB cluster.
|
|
22964
24221
|
*
|
|
@@ -22987,7 +24244,7 @@ export default class Client extends OpenApi {
|
|
|
22987
24244
|
*/
|
|
22988
24245
|
createBackup(request: CreateBackupRequest): Promise<CreateBackupResponse>;
|
|
22989
24246
|
/**
|
|
22990
|
-
*
|
|
24247
|
+
* Creates a cluster that is used to store cold data.
|
|
22991
24248
|
*
|
|
22992
24249
|
* @param request - CreateColdStorageInstanceRequest
|
|
22993
24250
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -22995,14 +24252,14 @@ export default class Client extends OpenApi {
|
|
|
22995
24252
|
*/
|
|
22996
24253
|
createColdStorageInstanceWithOptions(request: CreateColdStorageInstanceRequest, runtime: $Util.RuntimeOptions): Promise<CreateColdStorageInstanceResponse>;
|
|
22997
24254
|
/**
|
|
22998
|
-
*
|
|
24255
|
+
* Creates a cluster that is used to store cold data.
|
|
22999
24256
|
*
|
|
23000
24257
|
* @param request - CreateColdStorageInstanceRequest
|
|
23001
24258
|
* @returns CreateColdStorageInstanceResponse
|
|
23002
24259
|
*/
|
|
23003
24260
|
createColdStorageInstance(request: CreateColdStorageInstanceRequest): Promise<CreateColdStorageInstanceResponse>;
|
|
23004
24261
|
/**
|
|
23005
|
-
*
|
|
24262
|
+
* Create Database Cluster
|
|
23006
24263
|
*
|
|
23007
24264
|
* @param request - CreateDBClusterRequest
|
|
23008
24265
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -23010,7 +24267,7 @@ export default class Client extends OpenApi {
|
|
|
23010
24267
|
*/
|
|
23011
24268
|
createDBClusterWithOptions(request: CreateDBClusterRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBClusterResponse>;
|
|
23012
24269
|
/**
|
|
23013
|
-
*
|
|
24270
|
+
* Create Database Cluster
|
|
23014
24271
|
*
|
|
23015
24272
|
* @param request - CreateDBClusterRequest
|
|
23016
24273
|
* @returns CreateDBClusterResponse
|
|
@@ -23155,6 +24412,21 @@ export default class Client extends OpenApi {
|
|
|
23155
24412
|
* @returns CreateGlobalSecurityIPGroupResponse
|
|
23156
24413
|
*/
|
|
23157
24414
|
createGlobalSecurityIPGroup(request: CreateGlobalSecurityIPGroupRequest): Promise<CreateGlobalSecurityIPGroupResponse>;
|
|
24415
|
+
/**
|
|
24416
|
+
* 创建或获取虚拟证书订单
|
|
24417
|
+
*
|
|
24418
|
+
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
24419
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
24420
|
+
* @returns CreateOrGetVirtualLicenseOrderResponse
|
|
24421
|
+
*/
|
|
24422
|
+
createOrGetVirtualLicenseOrderWithOptions(request: CreateOrGetVirtualLicenseOrderRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrGetVirtualLicenseOrderResponse>;
|
|
24423
|
+
/**
|
|
24424
|
+
* 创建或获取虚拟证书订单
|
|
24425
|
+
*
|
|
24426
|
+
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
24427
|
+
* @returns CreateOrGetVirtualLicenseOrderResponse
|
|
24428
|
+
*/
|
|
24429
|
+
createOrGetVirtualLicenseOrder(request: CreateOrGetVirtualLicenseOrderRequest): Promise<CreateOrGetVirtualLicenseOrderResponse>;
|
|
23158
24430
|
/**
|
|
23159
24431
|
* Creates a parameter template.
|
|
23160
24432
|
*
|
|
@@ -23439,7 +24711,7 @@ export default class Client extends OpenApi {
|
|
|
23439
24711
|
*/
|
|
23440
24712
|
deleteParameterGroup(request: DeleteParameterGroupRequest): Promise<DeleteParameterGroupResponse>;
|
|
23441
24713
|
/**
|
|
23442
|
-
* Queries the
|
|
24714
|
+
* Queries the status of the PolarDB for AI feature.
|
|
23443
24715
|
*
|
|
23444
24716
|
* @param request - DescribeAITaskStatusRequest
|
|
23445
24717
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -23447,7 +24719,7 @@ export default class Client extends OpenApi {
|
|
|
23447
24719
|
*/
|
|
23448
24720
|
describeAITaskStatusWithOptions(request: DescribeAITaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAITaskStatusResponse>;
|
|
23449
24721
|
/**
|
|
23450
|
-
* Queries the
|
|
24722
|
+
* Queries the status of the PolarDB for AI feature.
|
|
23451
24723
|
*
|
|
23452
24724
|
* @param request - DescribeAITaskStatusRequest
|
|
23453
24725
|
* @returns DescribeAITaskStatusResponse
|
|
@@ -23468,6 +24740,36 @@ export default class Client extends OpenApi {
|
|
|
23468
24740
|
* @returns DescribeAccountsResponse
|
|
23469
24741
|
*/
|
|
23470
24742
|
describeAccounts(request: DescribeAccountsRequest): Promise<DescribeAccountsResponse>;
|
|
24743
|
+
/**
|
|
24744
|
+
* 查询激活码详情
|
|
24745
|
+
*
|
|
24746
|
+
* @param request - DescribeActivationCodeDetailsRequest
|
|
24747
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
24748
|
+
* @returns DescribeActivationCodeDetailsResponse
|
|
24749
|
+
*/
|
|
24750
|
+
describeActivationCodeDetailsWithOptions(request: DescribeActivationCodeDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodeDetailsResponse>;
|
|
24751
|
+
/**
|
|
24752
|
+
* 查询激活码详情
|
|
24753
|
+
*
|
|
24754
|
+
* @param request - DescribeActivationCodeDetailsRequest
|
|
24755
|
+
* @returns DescribeActivationCodeDetailsResponse
|
|
24756
|
+
*/
|
|
24757
|
+
describeActivationCodeDetails(request: DescribeActivationCodeDetailsRequest): Promise<DescribeActivationCodeDetailsResponse>;
|
|
24758
|
+
/**
|
|
24759
|
+
* 查询激活码列表
|
|
24760
|
+
*
|
|
24761
|
+
* @param request - DescribeActivationCodesRequest
|
|
24762
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
24763
|
+
* @returns DescribeActivationCodesResponse
|
|
24764
|
+
*/
|
|
24765
|
+
describeActivationCodesWithOptions(request: DescribeActivationCodesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActivationCodesResponse>;
|
|
24766
|
+
/**
|
|
24767
|
+
* 查询激活码列表
|
|
24768
|
+
*
|
|
24769
|
+
* @param request - DescribeActivationCodesRequest
|
|
24770
|
+
* @returns DescribeActivationCodesResponse
|
|
24771
|
+
*/
|
|
24772
|
+
describeActivationCodes(request: DescribeActivationCodesRequest): Promise<DescribeActivationCodesResponse>;
|
|
23471
24773
|
/**
|
|
23472
24774
|
* Queries the auto-renewal attributes of a subscription PolarDB cluster.
|
|
23473
24775
|
*
|
|
@@ -23790,7 +25092,7 @@ export default class Client extends OpenApi {
|
|
|
23790
25092
|
*/
|
|
23791
25093
|
describeDBClusterServerlessConf(request: DescribeDBClusterServerlessConfRequest): Promise<DescribeDBClusterServerlessConfResponse>;
|
|
23792
25094
|
/**
|
|
23793
|
-
* Queries the
|
|
25095
|
+
* Queries the transparent data encryption (TDE) settings of a PolarDB cluster.
|
|
23794
25096
|
*
|
|
23795
25097
|
* @param request - DescribeDBClusterTDERequest
|
|
23796
25098
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -23798,7 +25100,7 @@ export default class Client extends OpenApi {
|
|
|
23798
25100
|
*/
|
|
23799
25101
|
describeDBClusterTDEWithOptions(request: DescribeDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBClusterTDEResponse>;
|
|
23800
25102
|
/**
|
|
23801
|
-
* Queries the
|
|
25103
|
+
* Queries the transparent data encryption (TDE) settings of a PolarDB cluster.
|
|
23802
25104
|
*
|
|
23803
25105
|
* @param request - DescribeDBClusterTDERequest
|
|
23804
25106
|
* @returns DescribeDBClusterTDEResponse
|
|
@@ -23850,7 +25152,7 @@ export default class Client extends OpenApi {
|
|
|
23850
25152
|
*/
|
|
23851
25153
|
describeDBClustersWithBackups(request: DescribeDBClustersWithBackupsRequest): Promise<DescribeDBClustersWithBackupsResponse>;
|
|
23852
25154
|
/**
|
|
23853
|
-
* Queries
|
|
25155
|
+
* Queries attributes such as character sets and collations supported by a database in a PolarDB cluster.
|
|
23854
25156
|
*
|
|
23855
25157
|
* @param request - DescribeDBInitializeVariableRequest
|
|
23856
25158
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -23858,7 +25160,7 @@ export default class Client extends OpenApi {
|
|
|
23858
25160
|
*/
|
|
23859
25161
|
describeDBInitializeVariableWithOptions(request: DescribeDBInitializeVariableRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInitializeVariableResponse>;
|
|
23860
25162
|
/**
|
|
23861
|
-
* Queries
|
|
25163
|
+
* Queries attributes such as character sets and collations supported by a database in a PolarDB cluster.
|
|
23862
25164
|
*
|
|
23863
25165
|
* @param request - DescribeDBInitializeVariableRequest
|
|
23864
25166
|
* @returns DescribeDBInitializeVariableResponse
|
|
@@ -24077,6 +25379,36 @@ export default class Client extends OpenApi {
|
|
|
24077
25379
|
* @returns DescribeGlobalSecurityIPGroupRelationResponse
|
|
24078
25380
|
*/
|
|
24079
25381
|
describeGlobalSecurityIPGroupRelation(request: DescribeGlobalSecurityIPGroupRelationRequest): Promise<DescribeGlobalSecurityIPGroupRelationResponse>;
|
|
25382
|
+
/**
|
|
25383
|
+
* 查看License订单详情
|
|
25384
|
+
*
|
|
25385
|
+
* @param request - DescribeLicenseOrderDetailsRequest
|
|
25386
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
25387
|
+
* @returns DescribeLicenseOrderDetailsResponse
|
|
25388
|
+
*/
|
|
25389
|
+
describeLicenseOrderDetailsWithOptions(request: DescribeLicenseOrderDetailsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrderDetailsResponse>;
|
|
25390
|
+
/**
|
|
25391
|
+
* 查看License订单详情
|
|
25392
|
+
*
|
|
25393
|
+
* @param request - DescribeLicenseOrderDetailsRequest
|
|
25394
|
+
* @returns DescribeLicenseOrderDetailsResponse
|
|
25395
|
+
*/
|
|
25396
|
+
describeLicenseOrderDetails(request: DescribeLicenseOrderDetailsRequest): Promise<DescribeLicenseOrderDetailsResponse>;
|
|
25397
|
+
/**
|
|
25398
|
+
* 查询License订单列表
|
|
25399
|
+
*
|
|
25400
|
+
* @param request - DescribeLicenseOrdersRequest
|
|
25401
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
25402
|
+
* @returns DescribeLicenseOrdersResponse
|
|
25403
|
+
*/
|
|
25404
|
+
describeLicenseOrdersWithOptions(request: DescribeLicenseOrdersRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLicenseOrdersResponse>;
|
|
25405
|
+
/**
|
|
25406
|
+
* 查询License订单列表
|
|
25407
|
+
*
|
|
25408
|
+
* @param request - DescribeLicenseOrdersRequest
|
|
25409
|
+
* @returns DescribeLicenseOrdersResponse
|
|
25410
|
+
*/
|
|
25411
|
+
describeLicenseOrders(request: DescribeLicenseOrdersRequest): Promise<DescribeLicenseOrdersResponse>;
|
|
24080
25412
|
/**
|
|
24081
25413
|
* Queries the retention policy of log backups in a PolarDB cluster.
|
|
24082
25414
|
*
|
|
@@ -24259,10 +25591,11 @@ export default class Client extends OpenApi {
|
|
|
24259
25591
|
*/
|
|
24260
25592
|
describeScheduleTasks(request: DescribeScheduleTasksRequest): Promise<DescribeScheduleTasksResponse>;
|
|
24261
25593
|
/**
|
|
24262
|
-
*
|
|
25594
|
+
* Slow Log Details
|
|
24263
25595
|
*
|
|
24264
25596
|
* @remarks
|
|
24265
|
-
*
|
|
25597
|
+
* >- Only PolarDB MySQL Edition clusters support calling this interface.
|
|
25598
|
+
* >- 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~~).
|
|
24266
25599
|
*
|
|
24267
25600
|
* @param request - DescribeSlowLogRecordsRequest
|
|
24268
25601
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -24270,10 +25603,11 @@ export default class Client extends OpenApi {
|
|
|
24270
25603
|
*/
|
|
24271
25604
|
describeSlowLogRecordsWithOptions(request: DescribeSlowLogRecordsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSlowLogRecordsResponse>;
|
|
24272
25605
|
/**
|
|
24273
|
-
*
|
|
25606
|
+
* Slow Log Details
|
|
24274
25607
|
*
|
|
24275
25608
|
* @remarks
|
|
24276
|
-
*
|
|
25609
|
+
* >- Only PolarDB MySQL Edition clusters support calling this interface.
|
|
25610
|
+
* >- 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~~).
|
|
24277
25611
|
*
|
|
24278
25612
|
* @param request - DescribeSlowLogRecordsRequest
|
|
24279
25613
|
* @returns DescribeSlowLogRecordsResponse
|
|
@@ -24301,10 +25635,10 @@ export default class Client extends OpenApi {
|
|
|
24301
25635
|
*/
|
|
24302
25636
|
describeSlowLogs(request: DescribeSlowLogsRequest): Promise<DescribeSlowLogsResponse>;
|
|
24303
25637
|
/**
|
|
24304
|
-
* Queries the
|
|
25638
|
+
* Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.
|
|
24305
25639
|
*
|
|
24306
25640
|
* @remarks
|
|
24307
|
-
* 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.
|
|
25641
|
+
* 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.
|
|
24308
25642
|
* * 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`.
|
|
24309
25643
|
*
|
|
24310
25644
|
* @param request - DescribeTasksRequest
|
|
@@ -24313,10 +25647,10 @@ export default class Client extends OpenApi {
|
|
|
24313
25647
|
*/
|
|
24314
25648
|
describeTasksWithOptions(request: DescribeTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeTasksResponse>;
|
|
24315
25649
|
/**
|
|
24316
|
-
* Queries the
|
|
25650
|
+
* Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.
|
|
24317
25651
|
*
|
|
24318
25652
|
* @remarks
|
|
24319
|
-
* 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.
|
|
25653
|
+
* 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.
|
|
24320
25654
|
* * 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`.
|
|
24321
25655
|
*
|
|
24322
25656
|
* @param request - DescribeTasksRequest
|
|
@@ -24384,7 +25718,7 @@ export default class Client extends OpenApi {
|
|
|
24384
25718
|
*/
|
|
24385
25719
|
enableDBClusterServerless(request: EnableDBClusterServerlessRequest): Promise<EnableDBClusterServerlessResponse>;
|
|
24386
25720
|
/**
|
|
24387
|
-
*
|
|
25721
|
+
* Modifies the status of SQL firewall rules for a cluster.
|
|
24388
25722
|
*
|
|
24389
25723
|
* @param request - EnableFirewallRulesRequest
|
|
24390
25724
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -24392,7 +25726,7 @@ export default class Client extends OpenApi {
|
|
|
24392
25726
|
*/
|
|
24393
25727
|
enableFirewallRulesWithOptions(request: EnableFirewallRulesRequest, runtime: $Util.RuntimeOptions): Promise<EnableFirewallRulesResponse>;
|
|
24394
25728
|
/**
|
|
24395
|
-
*
|
|
25729
|
+
* Modifies the status of SQL firewall rules for a cluster.
|
|
24396
25730
|
*
|
|
24397
25731
|
* @param request - EnableFirewallRulesRequest
|
|
24398
25732
|
* @returns EnableFirewallRulesResponse
|
|
@@ -24458,7 +25792,7 @@ export default class Client extends OpenApi {
|
|
|
24458
25792
|
*/
|
|
24459
25793
|
grantAccountPrivilege(request: GrantAccountPrivilegeRequest): Promise<GrantAccountPrivilegeResponse>;
|
|
24460
25794
|
/**
|
|
24461
|
-
* Queries the tags that are
|
|
25795
|
+
* Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added.
|
|
24462
25796
|
*
|
|
24463
25797
|
* @param request - ListTagResourcesRequest
|
|
24464
25798
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -24466,7 +25800,7 @@ export default class Client extends OpenApi {
|
|
|
24466
25800
|
*/
|
|
24467
25801
|
listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
|
|
24468
25802
|
/**
|
|
24469
|
-
* Queries the tags that are
|
|
25803
|
+
* Queries the tags that are added to one or more PolarDB clusters, or the PolarDB clusters to which one or more tags are added.
|
|
24470
25804
|
*
|
|
24471
25805
|
* @param request - ListTagResourcesRequest
|
|
24472
25806
|
* @returns ListTagResourcesResponse
|
|
@@ -24786,12 +26120,16 @@ export default class Client extends OpenApi {
|
|
|
24786
26120
|
*/
|
|
24787
26121
|
modifyDBClusterPrimaryZone(request: ModifyDBClusterPrimaryZoneRequest): Promise<ModifyDBClusterPrimaryZoneResponse>;
|
|
24788
26122
|
/**
|
|
26123
|
+
* Modifies the configurations of a resource group for a database cluster.
|
|
26124
|
+
*
|
|
24789
26125
|
* @param request - ModifyDBClusterResourceGroupRequest
|
|
24790
26126
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
24791
26127
|
* @returns ModifyDBClusterResourceGroupResponse
|
|
24792
26128
|
*/
|
|
24793
26129
|
modifyDBClusterResourceGroupWithOptions(request: ModifyDBClusterResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterResourceGroupResponse>;
|
|
24794
26130
|
/**
|
|
26131
|
+
* Modifies the configurations of a resource group for a database cluster.
|
|
26132
|
+
*
|
|
24795
26133
|
* @param request - ModifyDBClusterResourceGroupRequest
|
|
24796
26134
|
* @returns ModifyDBClusterResourceGroupResponse
|
|
24797
26135
|
*/
|
|
@@ -24842,7 +26180,7 @@ export default class Client extends OpenApi {
|
|
|
24842
26180
|
*/
|
|
24843
26181
|
modifyDBClusterStorageSpace(request: ModifyDBClusterStorageSpaceRequest): Promise<ModifyDBClusterStorageSpaceResponse>;
|
|
24844
26182
|
/**
|
|
24845
|
-
* Enables the
|
|
26183
|
+
* Enables the transparent data encryption (TDE) feature for a PolarDB cluster.
|
|
24846
26184
|
*
|
|
24847
26185
|
* @remarks
|
|
24848
26186
|
* > * 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).
|
|
@@ -24854,7 +26192,7 @@ export default class Client extends OpenApi {
|
|
|
24854
26192
|
*/
|
|
24855
26193
|
modifyDBClusterTDEWithOptions(request: ModifyDBClusterTDERequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBClusterTDEResponse>;
|
|
24856
26194
|
/**
|
|
24857
|
-
* Enables the
|
|
26195
|
+
* Enables the transparent data encryption (TDE) feature for a PolarDB cluster.
|
|
24858
26196
|
*
|
|
24859
26197
|
* @remarks
|
|
24860
26198
|
* > * 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).
|
|
@@ -24910,7 +26248,7 @@ export default class Client extends OpenApi {
|
|
|
24910
26248
|
*/
|
|
24911
26249
|
modifyDBNodeClass(request: ModifyDBNodeClassRequest): Promise<ModifyDBNodeClassResponse>;
|
|
24912
26250
|
/**
|
|
24913
|
-
* Enables or disables a cluster
|
|
26251
|
+
* Enables or disables the hot standby node in a cluster.
|
|
24914
26252
|
*
|
|
24915
26253
|
* @param request - ModifyDBNodeHotReplicaModeRequest
|
|
24916
26254
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -24918,7 +26256,7 @@ export default class Client extends OpenApi {
|
|
|
24918
26256
|
*/
|
|
24919
26257
|
modifyDBNodeHotReplicaModeWithOptions(request: ModifyDBNodeHotReplicaModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeHotReplicaModeResponse>;
|
|
24920
26258
|
/**
|
|
24921
|
-
* Enables or disables a cluster
|
|
26259
|
+
* Enables or disables the hot standby node in a cluster.
|
|
24922
26260
|
*
|
|
24923
26261
|
* @param request - ModifyDBNodeHotReplicaModeRequest
|
|
24924
26262
|
* @returns ModifyDBNodeHotReplicaModeResponse
|
|
@@ -24955,7 +26293,7 @@ export default class Client extends OpenApi {
|
|
|
24955
26293
|
*/
|
|
24956
26294
|
modifyDBNodesParameters(request: ModifyDBNodesParametersRequest): Promise<ModifyDBNodesParametersResponse>;
|
|
24957
26295
|
/**
|
|
24958
|
-
* Modifies a
|
|
26296
|
+
* Modifies a global database network (GDN).
|
|
24959
26297
|
*
|
|
24960
26298
|
* @param request - ModifyGlobalDatabaseNetworkRequest
|
|
24961
26299
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -24963,7 +26301,7 @@ export default class Client extends OpenApi {
|
|
|
24963
26301
|
*/
|
|
24964
26302
|
modifyGlobalDatabaseNetworkWithOptions(request: ModifyGlobalDatabaseNetworkRequest, runtime: $Util.RuntimeOptions): Promise<ModifyGlobalDatabaseNetworkResponse>;
|
|
24965
26303
|
/**
|
|
24966
|
-
* Modifies a
|
|
26304
|
+
* Modifies a global database network (GDN).
|
|
24967
26305
|
*
|
|
24968
26306
|
* @param request - ModifyGlobalDatabaseNetworkRequest
|
|
24969
26307
|
* @returns ModifyGlobalDatabaseNetworkResponse
|
|
@@ -25220,18 +26558,22 @@ export default class Client extends OpenApi {
|
|
|
25220
26558
|
*/
|
|
25221
26559
|
switchOverGlobalDatabaseNetwork(request: SwitchOverGlobalDatabaseNetworkRequest): Promise<SwitchOverGlobalDatabaseNetworkResponse>;
|
|
25222
26560
|
/**
|
|
26561
|
+
* Creates tags for a PolarDB cluster.
|
|
26562
|
+
*
|
|
25223
26563
|
* @param request - TagResourcesRequest
|
|
25224
26564
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
25225
26565
|
* @returns TagResourcesResponse
|
|
25226
26566
|
*/
|
|
25227
26567
|
tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
|
|
25228
26568
|
/**
|
|
26569
|
+
* Creates tags for a PolarDB cluster.
|
|
26570
|
+
*
|
|
25229
26571
|
* @param request - TagResourcesRequest
|
|
25230
26572
|
* @returns TagResourcesResponse
|
|
25231
26573
|
*/
|
|
25232
26574
|
tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
|
|
25233
26575
|
/**
|
|
25234
|
-
* Temporarily
|
|
26576
|
+
* Temporarily changes the node configurations of a cluster.
|
|
25235
26577
|
*
|
|
25236
26578
|
* @param request - TempModifyDBNodeRequest
|
|
25237
26579
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -25239,7 +26581,7 @@ export default class Client extends OpenApi {
|
|
|
25239
26581
|
*/
|
|
25240
26582
|
tempModifyDBNodeWithOptions(request: TempModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<TempModifyDBNodeResponse>;
|
|
25241
26583
|
/**
|
|
25242
|
-
* Temporarily
|
|
26584
|
+
* Temporarily changes the node configurations of a cluster.
|
|
25243
26585
|
*
|
|
25244
26586
|
* @param request - TempModifyDBNodeRequest
|
|
25245
26587
|
* @returns TempModifyDBNodeResponse
|
|
@@ -25249,9 +26591,10 @@ export default class Client extends OpenApi {
|
|
|
25249
26591
|
* Changes the billing method of a PolarDB cluster.
|
|
25250
26592
|
*
|
|
25251
26593
|
* @remarks
|
|
25252
|
-
* >
|
|
25253
|
-
*
|
|
25254
|
-
*
|
|
26594
|
+
* >
|
|
26595
|
+
* * 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).
|
|
26596
|
+
* * You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
|
|
26597
|
+
* * If you change the billing method from subscription to pay-as-you-go, the system automatically refunds the balance of the prepaid subscription fees.
|
|
25255
26598
|
*
|
|
25256
26599
|
* @param request - TransformDBClusterPayTypeRequest
|
|
25257
26600
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -25262,9 +26605,10 @@ export default class Client extends OpenApi {
|
|
|
25262
26605
|
* Changes the billing method of a PolarDB cluster.
|
|
25263
26606
|
*
|
|
25264
26607
|
* @remarks
|
|
25265
|
-
* >
|
|
25266
|
-
*
|
|
25267
|
-
*
|
|
26608
|
+
* >
|
|
26609
|
+
* * 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).
|
|
26610
|
+
* * You cannot change the billing method from pay-as-you-go to subscription if your account balance is insufficient.
|
|
26611
|
+
* * 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
26612
|
*
|
|
25269
26613
|
* @param request - TransformDBClusterPayTypeRequest
|
|
25270
26614
|
* @returns TransformDBClusterPayTypeResponse
|