@alicloud/polardb20170801 5.2.1 → 5.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +438 -155
- package/dist/client.js +29 -16
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +454 -155
package/src/client.ts
CHANGED
|
@@ -931,6 +931,12 @@ export class CreateAccountRequest extends $tea.Model {
|
|
|
931
931
|
* * **0 or unspecified**: does not grant required permissions.
|
|
932
932
|
* * **1**: grants required permissions.
|
|
933
933
|
*
|
|
934
|
+
* >
|
|
935
|
+
*
|
|
936
|
+
* * The parameter is valid only after you configure the `AccountPrivilege` parameter.
|
|
937
|
+
*
|
|
938
|
+
* * If you set the parameter to `1`, the current account is granted to the required permissions on all databases in the current cluster that are specified by the `AccountPrivilege` parameter.
|
|
939
|
+
*
|
|
934
940
|
* @example
|
|
935
941
|
* 0
|
|
936
942
|
*/
|
|
@@ -1032,6 +1038,8 @@ export class CreateAccountResponse extends $tea.Model {
|
|
|
1032
1038
|
export class CreateActivationCodeRequest extends $tea.Model {
|
|
1033
1039
|
/**
|
|
1034
1040
|
* @remarks
|
|
1041
|
+
* The Alibaba Cloud order ID (including the virtual order ID).
|
|
1042
|
+
*
|
|
1035
1043
|
* This parameter is required.
|
|
1036
1044
|
*
|
|
1037
1045
|
* @example
|
|
@@ -1039,12 +1047,17 @@ export class CreateActivationCodeRequest extends $tea.Model {
|
|
|
1039
1047
|
*/
|
|
1040
1048
|
aliyunOrderId?: string;
|
|
1041
1049
|
/**
|
|
1050
|
+
* @remarks
|
|
1051
|
+
* The description of the activation code.
|
|
1052
|
+
*
|
|
1042
1053
|
* @example
|
|
1043
1054
|
* testCode
|
|
1044
1055
|
*/
|
|
1045
1056
|
description?: string;
|
|
1046
1057
|
/**
|
|
1047
1058
|
* @remarks
|
|
1059
|
+
* The MAC address.
|
|
1060
|
+
*
|
|
1048
1061
|
* This parameter is required.
|
|
1049
1062
|
*
|
|
1050
1063
|
* @example
|
|
@@ -1053,6 +1066,8 @@ export class CreateActivationCodeRequest extends $tea.Model {
|
|
|
1053
1066
|
macAddress?: string;
|
|
1054
1067
|
/**
|
|
1055
1068
|
* @remarks
|
|
1069
|
+
* The name of the activation code. The name can contain only letters, digits, underscores (_), and hyphens (-). The activation code file downloaded from the console is named based on this name.
|
|
1070
|
+
*
|
|
1056
1071
|
* This parameter is required.
|
|
1057
1072
|
*
|
|
1058
1073
|
* @example
|
|
@@ -1064,6 +1079,9 @@ export class CreateActivationCodeRequest extends $tea.Model {
|
|
|
1064
1079
|
resourceOwnerAccount?: string;
|
|
1065
1080
|
resourceOwnerId?: number;
|
|
1066
1081
|
/**
|
|
1082
|
+
* @remarks
|
|
1083
|
+
* The system identifier of the database. This parameter is required if you set AllowEmptySystemIdentifier to false.
|
|
1084
|
+
*
|
|
1067
1085
|
* @example
|
|
1068
1086
|
* 1234567890123456
|
|
1069
1087
|
*/
|
|
@@ -1103,59 +1121,89 @@ export class CreateActivationCodeRequest extends $tea.Model {
|
|
|
1103
1121
|
|
|
1104
1122
|
export class CreateActivationCodeResponseBody extends $tea.Model {
|
|
1105
1123
|
/**
|
|
1124
|
+
* @remarks
|
|
1125
|
+
* The time when the activation code takes effect.
|
|
1126
|
+
*
|
|
1106
1127
|
* @example
|
|
1107
1128
|
* 2024-10-16 16:46:20
|
|
1108
1129
|
*/
|
|
1109
1130
|
activateAt?: string;
|
|
1110
1131
|
/**
|
|
1132
|
+
* @remarks
|
|
1133
|
+
* The activation code in the base64 format. The activation code is decoded and stored into a file named license.lic. PolarDB can access and read the license.lic file upon startup to validate the license or perform related operations.
|
|
1134
|
+
*
|
|
1111
1135
|
* @example
|
|
1112
1136
|
* AAEAA******AAA=
|
|
1113
1137
|
*/
|
|
1114
1138
|
certContentB64?: string;
|
|
1115
1139
|
/**
|
|
1140
|
+
* @remarks
|
|
1141
|
+
* The description of the activation code.
|
|
1142
|
+
*
|
|
1116
1143
|
* @example
|
|
1117
1144
|
* testCode
|
|
1118
1145
|
*/
|
|
1119
1146
|
description?: string;
|
|
1120
1147
|
/**
|
|
1148
|
+
* @remarks
|
|
1149
|
+
* The time when the activation code expires.
|
|
1150
|
+
*
|
|
1121
1151
|
* @example
|
|
1122
1152
|
* 2054-10-09 16:46:20
|
|
1123
1153
|
*/
|
|
1124
1154
|
expireAt?: string;
|
|
1125
1155
|
/**
|
|
1156
|
+
* @remarks
|
|
1157
|
+
* The time when the activation code was created.
|
|
1158
|
+
*
|
|
1126
1159
|
* @example
|
|
1127
1160
|
* 2024-10-16 16:46:20
|
|
1128
1161
|
*/
|
|
1129
1162
|
gmtCreated?: string;
|
|
1130
1163
|
/**
|
|
1164
|
+
* @remarks
|
|
1165
|
+
* The time when the activation code was last updated.
|
|
1166
|
+
*
|
|
1131
1167
|
* @example
|
|
1132
1168
|
* 2024-10-16 16:46:20
|
|
1133
1169
|
*/
|
|
1134
1170
|
gmtModified?: string;
|
|
1135
1171
|
/**
|
|
1172
|
+
* @remarks
|
|
1173
|
+
* The activation code ID.
|
|
1174
|
+
*
|
|
1136
1175
|
* @example
|
|
1137
1176
|
* 123
|
|
1138
1177
|
*/
|
|
1139
1178
|
id?: number;
|
|
1140
1179
|
/**
|
|
1180
|
+
* @remarks
|
|
1181
|
+
* The MAC address.
|
|
1182
|
+
*
|
|
1141
1183
|
* @example
|
|
1142
1184
|
* 12:34:56:78:98:00
|
|
1143
1185
|
*/
|
|
1144
1186
|
macAddress?: string;
|
|
1145
1187
|
/**
|
|
1188
|
+
* @remarks
|
|
1189
|
+
* The name of the activation code.
|
|
1190
|
+
*
|
|
1146
1191
|
* @example
|
|
1147
1192
|
* testName
|
|
1148
1193
|
*/
|
|
1149
1194
|
name?: string;
|
|
1150
1195
|
/**
|
|
1151
1196
|
* @remarks
|
|
1152
|
-
*
|
|
1197
|
+
* The request ID.
|
|
1153
1198
|
*
|
|
1154
1199
|
* @example
|
|
1155
1200
|
* 4CE6DF97-AEA4-484F-906F-C407EE******
|
|
1156
1201
|
*/
|
|
1157
1202
|
requestId?: string;
|
|
1158
1203
|
/**
|
|
1204
|
+
* @remarks
|
|
1205
|
+
* The system identifier of the database.
|
|
1206
|
+
*
|
|
1159
1207
|
* @example
|
|
1160
1208
|
* 1234567890123456
|
|
1161
1209
|
*/
|
|
@@ -1519,6 +1567,7 @@ export class CreateDBClusterRequest extends $tea.Model {
|
|
|
1519
1567
|
* NONE
|
|
1520
1568
|
*/
|
|
1521
1569
|
backupRetentionPolicyOnClusterDeletion?: string;
|
|
1570
|
+
burstingEnabled?: string;
|
|
1522
1571
|
/**
|
|
1523
1572
|
* @remarks
|
|
1524
1573
|
* Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.
|
|
@@ -2086,6 +2135,7 @@ export class CreateDBClusterRequest extends $tea.Model {
|
|
|
2086
2135
|
architecture: 'Architecture',
|
|
2087
2136
|
autoRenew: 'AutoRenew',
|
|
2088
2137
|
backupRetentionPolicyOnClusterDeletion: 'BackupRetentionPolicyOnClusterDeletion',
|
|
2138
|
+
burstingEnabled: 'BurstingEnabled',
|
|
2089
2139
|
clientToken: 'ClientToken',
|
|
2090
2140
|
cloneDataPoint: 'CloneDataPoint',
|
|
2091
2141
|
clusterNetworkType: 'ClusterNetworkType',
|
|
@@ -2145,6 +2195,7 @@ export class CreateDBClusterRequest extends $tea.Model {
|
|
|
2145
2195
|
architecture: 'string',
|
|
2146
2196
|
autoRenew: 'boolean',
|
|
2147
2197
|
backupRetentionPolicyOnClusterDeletion: 'string',
|
|
2198
|
+
burstingEnabled: 'string',
|
|
2148
2199
|
clientToken: 'string',
|
|
2149
2200
|
cloneDataPoint: 'string',
|
|
2150
2201
|
clusterNetworkType: 'string',
|
|
@@ -3348,6 +3399,13 @@ export class CreateGlobalDatabaseNetworkRequest extends $tea.Model {
|
|
|
3348
3399
|
* pc-bp1q76364ird*****
|
|
3349
3400
|
*/
|
|
3350
3401
|
DBClusterId?: string;
|
|
3402
|
+
/**
|
|
3403
|
+
* @remarks
|
|
3404
|
+
* Specifies whether to create a global domain name.
|
|
3405
|
+
*
|
|
3406
|
+
* @example
|
|
3407
|
+
* false
|
|
3408
|
+
*/
|
|
3351
3409
|
enableGlobalDomainName?: boolean;
|
|
3352
3410
|
/**
|
|
3353
3411
|
* @remarks
|
|
@@ -3613,6 +3671,8 @@ export class CreateGlobalSecurityIPGroupResponse extends $tea.Model {
|
|
|
3613
3671
|
export class CreateOrGetVirtualLicenseOrderRequest extends $tea.Model {
|
|
3614
3672
|
/**
|
|
3615
3673
|
* @remarks
|
|
3674
|
+
* The type of the engine. Valid values: PG, Oracle, and MySQL.
|
|
3675
|
+
*
|
|
3616
3676
|
* This parameter is required.
|
|
3617
3677
|
*
|
|
3618
3678
|
* @example
|
|
@@ -3650,69 +3710,105 @@ export class CreateOrGetVirtualLicenseOrderRequest extends $tea.Model {
|
|
|
3650
3710
|
|
|
3651
3711
|
export class CreateOrGetVirtualLicenseOrderResponseBody extends $tea.Model {
|
|
3652
3712
|
/**
|
|
3713
|
+
* @remarks
|
|
3714
|
+
* The number of generated activation codes.
|
|
3715
|
+
*
|
|
3653
3716
|
* @example
|
|
3654
3717
|
* 1
|
|
3655
3718
|
*/
|
|
3656
3719
|
activatedCodeCount?: number;
|
|
3657
3720
|
/**
|
|
3721
|
+
* @remarks
|
|
3722
|
+
* The maximum number of activation codes that you can apply for.
|
|
3723
|
+
*
|
|
3658
3724
|
* @example
|
|
3659
3725
|
* 10
|
|
3660
3726
|
*/
|
|
3661
3727
|
activationCodeQuota?: number;
|
|
3662
3728
|
/**
|
|
3729
|
+
* @remarks
|
|
3730
|
+
* The Alibaba Cloud order ID (including the virtual order ID).
|
|
3731
|
+
*
|
|
3663
3732
|
* @example
|
|
3664
3733
|
* 2233****445566
|
|
3665
3734
|
*/
|
|
3666
3735
|
aliyunOrderId?: string;
|
|
3667
3736
|
/**
|
|
3737
|
+
* @remarks
|
|
3738
|
+
* Indicates whether activation codes can be generated without the system identifier.
|
|
3739
|
+
*
|
|
3668
3740
|
* @example
|
|
3669
3741
|
* false
|
|
3670
3742
|
*/
|
|
3671
3743
|
allowEmptySystemIdentifier?: boolean;
|
|
3672
3744
|
/**
|
|
3745
|
+
* @remarks
|
|
3746
|
+
* The time when the order was created.
|
|
3747
|
+
*
|
|
3673
3748
|
* @example
|
|
3674
3749
|
* 2024-10-16 16:46:20
|
|
3675
3750
|
*/
|
|
3676
3751
|
gmtCreated?: string;
|
|
3677
3752
|
/**
|
|
3753
|
+
* @remarks
|
|
3754
|
+
* The time when the order was last updated.
|
|
3755
|
+
*
|
|
3678
3756
|
* @example
|
|
3679
3757
|
* 2024-10-16 16:46:20
|
|
3680
3758
|
*/
|
|
3681
3759
|
gmtModified?: string;
|
|
3682
3760
|
/**
|
|
3761
|
+
* @remarks
|
|
3762
|
+
* Indicates whether the order is a virtual order (virtual orders allow pre-generation of activation codes).
|
|
3763
|
+
*
|
|
3683
3764
|
* @example
|
|
3684
3765
|
* true
|
|
3685
3766
|
*/
|
|
3686
3767
|
isVirtualOrder?: boolean;
|
|
3687
3768
|
/**
|
|
3769
|
+
* @remarks
|
|
3770
|
+
* Indicates whether the virtual order is frozen (activation codes cannot be generated for a frozen virtual order).
|
|
3771
|
+
*
|
|
3688
3772
|
* @example
|
|
3689
3773
|
* false
|
|
3690
3774
|
*/
|
|
3691
3775
|
isVirtualOrderFrozen?: boolean;
|
|
3692
3776
|
/**
|
|
3777
|
+
* @remarks
|
|
3778
|
+
* The plan type.
|
|
3779
|
+
*
|
|
3693
3780
|
* @example
|
|
3694
3781
|
* pre_generation_long_term
|
|
3695
3782
|
*/
|
|
3696
3783
|
packageType?: string;
|
|
3697
3784
|
/**
|
|
3785
|
+
* @remarks
|
|
3786
|
+
* The validity period of the plan, which is one year (common) or thirty years (long-term).
|
|
3787
|
+
*
|
|
3698
3788
|
* @example
|
|
3699
3789
|
* 30 years
|
|
3700
3790
|
*/
|
|
3701
3791
|
packageValidity?: string;
|
|
3702
3792
|
/**
|
|
3793
|
+
* @remarks
|
|
3794
|
+
* The purchase channel.
|
|
3795
|
+
*
|
|
3703
3796
|
* @example
|
|
3704
3797
|
* aliyun_market
|
|
3705
3798
|
*/
|
|
3706
3799
|
purchaseChannel?: string;
|
|
3707
3800
|
/**
|
|
3708
3801
|
* @remarks
|
|
3709
|
-
*
|
|
3802
|
+
* The ID of the request.
|
|
3710
3803
|
*
|
|
3711
3804
|
* @example
|
|
3712
3805
|
* 45D24263-7E3A-4140-9472-************
|
|
3713
3806
|
*/
|
|
3714
3807
|
requestId?: string;
|
|
3715
3808
|
/**
|
|
3809
|
+
* @remarks
|
|
3810
|
+
* The ID of the virtual order.
|
|
3811
|
+
*
|
|
3716
3812
|
* @example
|
|
3717
3813
|
* 2024********483
|
|
3718
3814
|
*/
|
|
@@ -5631,6 +5727,10 @@ export class DescribeAITaskStatusRequest extends $tea.Model {
|
|
|
5631
5727
|
}
|
|
5632
5728
|
|
|
5633
5729
|
export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
5730
|
+
/**
|
|
5731
|
+
* @remarks
|
|
5732
|
+
* The name of the database account that is used to connect to the AI nodes in the cluster.
|
|
5733
|
+
*/
|
|
5634
5734
|
accountName?: string;
|
|
5635
5735
|
/**
|
|
5636
5736
|
* @remarks
|
|
@@ -5650,10 +5750,10 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5650
5750
|
requestId?: string;
|
|
5651
5751
|
/**
|
|
5652
5752
|
* @remarks
|
|
5653
|
-
* The
|
|
5753
|
+
* The status of the PolarDB for AI feature. Valid values:
|
|
5654
5754
|
*
|
|
5655
|
-
* * **1**:
|
|
5656
|
-
* * **2**:
|
|
5755
|
+
* * **1**: enabled.
|
|
5756
|
+
* * **2**: disabled.
|
|
5657
5757
|
*
|
|
5658
5758
|
* @example
|
|
5659
5759
|
* 1
|
|
@@ -5661,7 +5761,7 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5661
5761
|
status?: string;
|
|
5662
5762
|
/**
|
|
5663
5763
|
* @remarks
|
|
5664
|
-
* The
|
|
5764
|
+
* The description of the status of the PolarDB for AI feature.
|
|
5665
5765
|
*
|
|
5666
5766
|
* @example
|
|
5667
5767
|
* Closed State
|
|
@@ -6040,6 +6140,8 @@ export class DescribeActivationCodeDetailsResponse extends $tea.Model {
|
|
|
6040
6140
|
export class DescribeActivationCodesRequest extends $tea.Model {
|
|
6041
6141
|
/**
|
|
6042
6142
|
* @remarks
|
|
6143
|
+
* The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
|
|
6144
|
+
*
|
|
6043
6145
|
* This parameter is required.
|
|
6044
6146
|
*
|
|
6045
6147
|
* @example
|
|
@@ -6049,11 +6151,17 @@ export class DescribeActivationCodesRequest extends $tea.Model {
|
|
|
6049
6151
|
ownerAccount?: string;
|
|
6050
6152
|
ownerId?: number;
|
|
6051
6153
|
/**
|
|
6154
|
+
* @remarks
|
|
6155
|
+
* The page number.
|
|
6156
|
+
*
|
|
6052
6157
|
* @example
|
|
6053
6158
|
* 1
|
|
6054
6159
|
*/
|
|
6055
6160
|
pageNumber?: number;
|
|
6056
6161
|
/**
|
|
6162
|
+
* @remarks
|
|
6163
|
+
* The number of entries per page.
|
|
6164
|
+
*
|
|
6057
6165
|
* @example
|
|
6058
6166
|
* 30
|
|
6059
6167
|
*/
|
|
@@ -6090,26 +6198,39 @@ export class DescribeActivationCodesRequest extends $tea.Model {
|
|
|
6090
6198
|
}
|
|
6091
6199
|
|
|
6092
6200
|
export class DescribeActivationCodesResponseBody extends $tea.Model {
|
|
6201
|
+
/**
|
|
6202
|
+
* @remarks
|
|
6203
|
+
* The queried activation codes.
|
|
6204
|
+
*/
|
|
6093
6205
|
items?: DescribeActivationCodesResponseBodyItems[];
|
|
6094
6206
|
/**
|
|
6207
|
+
* @remarks
|
|
6208
|
+
* The page number.
|
|
6209
|
+
*
|
|
6095
6210
|
* @example
|
|
6096
6211
|
* 1
|
|
6097
6212
|
*/
|
|
6098
6213
|
pageNumber?: number;
|
|
6099
6214
|
/**
|
|
6215
|
+
* @remarks
|
|
6216
|
+
* The number of entries returned on the current page.
|
|
6217
|
+
*
|
|
6100
6218
|
* @example
|
|
6101
6219
|
* 1
|
|
6102
6220
|
*/
|
|
6103
6221
|
pageRecordCount?: number;
|
|
6104
6222
|
/**
|
|
6105
6223
|
* @remarks
|
|
6106
|
-
*
|
|
6224
|
+
* The request ID.
|
|
6107
6225
|
*
|
|
6108
6226
|
* @example
|
|
6109
6227
|
* 65D7ACE6-4A61-4B6E-B357-8CB24A******
|
|
6110
6228
|
*/
|
|
6111
6229
|
requestId?: string;
|
|
6112
6230
|
/**
|
|
6231
|
+
* @remarks
|
|
6232
|
+
* The total number of entries returned.
|
|
6233
|
+
*
|
|
6113
6234
|
* @example
|
|
6114
6235
|
* 1
|
|
6115
6236
|
*/
|
|
@@ -6177,7 +6298,7 @@ export class DescribeAutoRenewAttributeRequest extends $tea.Model {
|
|
|
6177
6298
|
ownerId?: number;
|
|
6178
6299
|
/**
|
|
6179
6300
|
* @remarks
|
|
6180
|
-
* The page number. The value must be an integer that is
|
|
6301
|
+
* The page number. The value must be an integer that is greater than 0. Default value: 1.
|
|
6181
6302
|
*
|
|
6182
6303
|
* @example
|
|
6183
6304
|
* 1
|
|
@@ -6185,7 +6306,7 @@ export class DescribeAutoRenewAttributeRequest extends $tea.Model {
|
|
|
6185
6306
|
pageNumber?: number;
|
|
6186
6307
|
/**
|
|
6187
6308
|
* @remarks
|
|
6188
|
-
* The number of entries
|
|
6309
|
+
* The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.
|
|
6189
6310
|
*
|
|
6190
6311
|
* @example
|
|
6191
6312
|
* 30
|
|
@@ -7101,6 +7222,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7101
7222
|
* 24A1990B-4F6E-482B-B8CB-75C612******
|
|
7102
7223
|
*/
|
|
7103
7224
|
requestId?: string;
|
|
7225
|
+
totalLevel2BackupSize?: string;
|
|
7104
7226
|
/**
|
|
7105
7227
|
* @remarks
|
|
7106
7228
|
* The total number of returned entries.
|
|
@@ -7115,6 +7237,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7115
7237
|
pageNumber: 'PageNumber',
|
|
7116
7238
|
pageRecordCount: 'PageRecordCount',
|
|
7117
7239
|
requestId: 'RequestId',
|
|
7240
|
+
totalLevel2BackupSize: 'TotalLevel2BackupSize',
|
|
7118
7241
|
totalRecordCount: 'TotalRecordCount',
|
|
7119
7242
|
};
|
|
7120
7243
|
}
|
|
@@ -7125,6 +7248,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7125
7248
|
pageNumber: 'string',
|
|
7126
7249
|
pageRecordCount: 'string',
|
|
7127
7250
|
requestId: 'string',
|
|
7251
|
+
totalLevel2BackupSize: 'string',
|
|
7128
7252
|
totalRecordCount: 'string',
|
|
7129
7253
|
};
|
|
7130
7254
|
}
|
|
@@ -7654,6 +7778,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
7654
7778
|
* 5,242,880
|
|
7655
7779
|
*/
|
|
7656
7780
|
blktagUsed?: number;
|
|
7781
|
+
burstingEnabled?: string;
|
|
7657
7782
|
/**
|
|
7658
7783
|
* @remarks
|
|
7659
7784
|
* [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
|
|
@@ -8183,6 +8308,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
8183
8308
|
architecture: 'Architecture',
|
|
8184
8309
|
blktagTotal: 'BlktagTotal',
|
|
8185
8310
|
blktagUsed: 'BlktagUsed',
|
|
8311
|
+
burstingEnabled: 'BurstingEnabled',
|
|
8186
8312
|
category: 'Category',
|
|
8187
8313
|
compressStorageMode: 'CompressStorageMode',
|
|
8188
8314
|
compressStorageUsed: 'CompressStorageUsed',
|
|
@@ -8250,6 +8376,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
8250
8376
|
architecture: 'string',
|
|
8251
8377
|
blktagTotal: 'number',
|
|
8252
8378
|
blktagUsed: 'number',
|
|
8379
|
+
burstingEnabled: 'string',
|
|
8253
8380
|
category: 'string',
|
|
8254
8381
|
compressStorageMode: 'string',
|
|
8255
8382
|
compressStorageUsed: 'number',
|
|
@@ -8898,7 +9025,11 @@ export class DescribeDBClusterEndpointsResponse extends $tea.Model {
|
|
|
8898
9025
|
export class DescribeDBClusterMigrationRequest extends $tea.Model {
|
|
8899
9026
|
/**
|
|
8900
9027
|
* @remarks
|
|
8901
|
-
* The
|
|
9028
|
+
* The network type of the endpoint. Valid values:
|
|
9029
|
+
*
|
|
9030
|
+
* * **Public**: the public endpoint
|
|
9031
|
+
* * **Private**: the internal endpoint (VPC)
|
|
9032
|
+
* * **Inner**: the internal endpoint (classic network)
|
|
8902
9033
|
*
|
|
8903
9034
|
* This parameter is required.
|
|
8904
9035
|
*
|
|
@@ -8938,7 +9069,10 @@ export class DescribeDBClusterMigrationRequest extends $tea.Model {
|
|
|
8938
9069
|
export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
8939
9070
|
/**
|
|
8940
9071
|
* @remarks
|
|
8941
|
-
* The
|
|
9072
|
+
* The mode of the source ApsaraDB RDS instance. Valid values:
|
|
9073
|
+
*
|
|
9074
|
+
* * **rw**: read and write mode
|
|
9075
|
+
* * **ro**: read-only mode
|
|
8942
9076
|
*
|
|
8943
9077
|
* @example
|
|
8944
9078
|
* test
|
|
@@ -8946,12 +9080,12 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8946
9080
|
comment?: string;
|
|
8947
9081
|
/**
|
|
8948
9082
|
* @remarks
|
|
8949
|
-
* The
|
|
9083
|
+
* The port number.
|
|
8950
9084
|
*/
|
|
8951
9085
|
DBClusterEndpointList?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointList[];
|
|
8952
9086
|
/**
|
|
8953
9087
|
* @remarks
|
|
8954
|
-
* The
|
|
9088
|
+
* The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
|
|
8955
9089
|
*
|
|
8956
9090
|
* @example
|
|
8957
9091
|
* pc-****************
|
|
@@ -8959,10 +9093,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8959
9093
|
DBClusterId?: string;
|
|
8960
9094
|
/**
|
|
8961
9095
|
* @remarks
|
|
8962
|
-
*
|
|
8963
|
-
*
|
|
8964
|
-
* * **rw**: read and write mode
|
|
8965
|
-
* * **ro**: read-only mode
|
|
9096
|
+
* Details about the endpoints.
|
|
8966
9097
|
*
|
|
8967
9098
|
* @example
|
|
8968
9099
|
* ro
|
|
@@ -8970,7 +9101,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8970
9101
|
DBClusterReadWriteMode?: string;
|
|
8971
9102
|
/**
|
|
8972
9103
|
* @remarks
|
|
8973
|
-
* The
|
|
9104
|
+
* The vSwitch ID.
|
|
8974
9105
|
*
|
|
8975
9106
|
* @example
|
|
8976
9107
|
* 0
|
|
@@ -8978,7 +9109,11 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8978
9109
|
delayedSeconds?: number;
|
|
8979
9110
|
/**
|
|
8980
9111
|
* @remarks
|
|
8981
|
-
* The
|
|
9112
|
+
* The network type of the endpoint. Valid values:
|
|
9113
|
+
*
|
|
9114
|
+
* * **Public**: the public endpoint
|
|
9115
|
+
* * **Private**: the internal endpoint (VPC)
|
|
9116
|
+
* * **Inner**: the internal endpoint (classic network)
|
|
8982
9117
|
*
|
|
8983
9118
|
* @example
|
|
8984
9119
|
* dts**********618bs
|
|
@@ -8986,7 +9121,10 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8986
9121
|
dtsInstanceId?: string;
|
|
8987
9122
|
/**
|
|
8988
9123
|
* @remarks
|
|
8989
|
-
* The
|
|
9124
|
+
* The mode of the PolarDB cluster. Valid values:
|
|
9125
|
+
*
|
|
9126
|
+
* * **rw**: read and write mode
|
|
9127
|
+
* * **ro**: read-only mode
|
|
8990
9128
|
*
|
|
8991
9129
|
* @example
|
|
8992
9130
|
* 2020-06-17T01:56:36Z
|
|
@@ -8994,15 +9132,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8994
9132
|
expiredTime?: string;
|
|
8995
9133
|
/**
|
|
8996
9134
|
* @remarks
|
|
8997
|
-
* The
|
|
8998
|
-
*
|
|
8999
|
-
* * **NO_MIGRATION**: No migration task is running.
|
|
9000
|
-
* * **RDS2POLARDB_CLONING**: Data is being replicated.
|
|
9001
|
-
* * **RDS2POLARDB_SYNCING**: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode.
|
|
9002
|
-
* * **SWITCHING**: Databases are being switched.
|
|
9003
|
-
* * **POLARDB2RDS_SYNCING**: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications.
|
|
9004
|
-
* * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
|
|
9005
|
-
* * **CLOSING_MIGRATION**: The migration task is being terminated.
|
|
9135
|
+
* The endpoint.
|
|
9006
9136
|
*
|
|
9007
9137
|
* @example
|
|
9008
9138
|
* RDS2POLARDB_SYNCING
|
|
@@ -9010,15 +9140,12 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9010
9140
|
migrationStatus?: string;
|
|
9011
9141
|
/**
|
|
9012
9142
|
* @remarks
|
|
9013
|
-
* The
|
|
9143
|
+
* The port number.
|
|
9014
9144
|
*/
|
|
9015
9145
|
rdsEndpointList?: DescribeDBClusterMigrationResponseBodyRdsEndpointList[];
|
|
9016
9146
|
/**
|
|
9017
9147
|
* @remarks
|
|
9018
|
-
* The
|
|
9019
|
-
*
|
|
9020
|
-
* * **rw**: read and write mode
|
|
9021
|
-
* * **ro**: read-only mode
|
|
9148
|
+
* The ID of the synchronous task.
|
|
9022
9149
|
*
|
|
9023
9150
|
* @example
|
|
9024
9151
|
* rw
|
|
@@ -9026,7 +9153,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9026
9153
|
rdsReadWriteMode?: string;
|
|
9027
9154
|
/**
|
|
9028
9155
|
* @remarks
|
|
9029
|
-
* The ID of the
|
|
9156
|
+
* The ID of the source ApsaraDB RDS instance.
|
|
9030
9157
|
*
|
|
9031
9158
|
* @example
|
|
9032
9159
|
* F2A9EFA7-915F-4572-8299-85A307******
|
|
@@ -9034,29 +9161,28 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9034
9161
|
requestId?: string;
|
|
9035
9162
|
/**
|
|
9036
9163
|
* @remarks
|
|
9037
|
-
* The
|
|
9164
|
+
* The endpoints of the ApsaraDB RDS instance.
|
|
9038
9165
|
*
|
|
9039
9166
|
* @example
|
|
9040
9167
|
* rm-************
|
|
9041
9168
|
*/
|
|
9042
9169
|
sourceRDSDBInstanceId?: string;
|
|
9043
9170
|
/**
|
|
9044
|
-
* @remarks
|
|
9045
|
-
* The type of the source database. Valid values:
|
|
9046
|
-
*
|
|
9047
|
-
* * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
|
|
9048
|
-
* * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
|
|
9049
|
-
*
|
|
9050
9171
|
* @example
|
|
9051
9172
|
* PolarDBMySQL
|
|
9052
9173
|
*/
|
|
9053
9174
|
srcDbType?: string;
|
|
9054
9175
|
/**
|
|
9055
9176
|
* @remarks
|
|
9056
|
-
* The
|
|
9177
|
+
* The migration state of the PolarDB cluster. Valid values:
|
|
9057
9178
|
*
|
|
9058
|
-
* * **
|
|
9059
|
-
* * **
|
|
9179
|
+
* * **NO_MIGRATION**: No migration task is running.
|
|
9180
|
+
* * **RDS2POLARDB_CLONING**: Data is being replicated.
|
|
9181
|
+
* * **RDS2POLARDB_SYNCING**: Data is being replicated. During the replication, the PolarDB cluster is running in read-only mode and the source ApsaraDB RDS instance is running in read and write mode.
|
|
9182
|
+
* * **SWITCHING**: Databases are being switched.
|
|
9183
|
+
* * **POLARDB2RDS_SYNCING**: Databases are switched. The PolarDB cluster is running in read and write mode and the source ApsaraDB RDS instance is running in read-only mode. In this state, you can modify the endpoints for your applications.
|
|
9184
|
+
* * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
|
|
9185
|
+
* * **CLOSING_MIGRATION**: The migration task is being terminated.
|
|
9060
9186
|
*
|
|
9061
9187
|
* @example
|
|
9062
9188
|
* RDS2POLARDB
|
|
@@ -11509,9 +11635,7 @@ export class DescribeDBProxyPerformanceRequest extends $tea.Model {
|
|
|
11509
11635
|
DBEndpointId?: string;
|
|
11510
11636
|
/**
|
|
11511
11637
|
* @remarks
|
|
11512
|
-
*
|
|
11513
|
-
*
|
|
11514
|
-
* > It is used to query the metrics of Proxy on different DB nodes, supporting metrics such as PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.
|
|
11638
|
+
* The ID of the node in the cluster. This parameter can be used to query the performance metrics of PolarProxy on different nodes. The following metrics are supported: PolarProxy_DBConns, PolarProxy_DBQps, and PolarProxy_DBActionOps.
|
|
11515
11639
|
*
|
|
11516
11640
|
* @example
|
|
11517
11641
|
* pi-******************
|
|
@@ -13051,6 +13175,9 @@ export class DescribeLicenseOrderDetailsResponse extends $tea.Model {
|
|
|
13051
13175
|
|
|
13052
13176
|
export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
13053
13177
|
/**
|
|
13178
|
+
* @remarks
|
|
13179
|
+
* The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
|
|
13180
|
+
*
|
|
13054
13181
|
* @example
|
|
13055
13182
|
* 239618016570503
|
|
13056
13183
|
*/
|
|
@@ -13058,27 +13185,49 @@ export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
|
13058
13185
|
ownerAccount?: string;
|
|
13059
13186
|
ownerId?: number;
|
|
13060
13187
|
/**
|
|
13188
|
+
* @remarks
|
|
13189
|
+
* The type of the package. Valid values:
|
|
13190
|
+
*
|
|
13191
|
+
* * single_node_subscribe: Single-node Edition (Subscription).
|
|
13192
|
+
* * single_node_long_term: Single-node Edition (Long-term).
|
|
13193
|
+
* * primary_backup_subscribe: HA Edition (Subscription).
|
|
13194
|
+
* * primary_backup_long_term: HA Edition (Long-term).
|
|
13195
|
+
* * pre_generation_long_term: Pre-generated (Long-term).
|
|
13196
|
+
*
|
|
13061
13197
|
* @example
|
|
13062
13198
|
* single_node_subscribe
|
|
13063
13199
|
*/
|
|
13064
13200
|
packageType?: string;
|
|
13065
13201
|
/**
|
|
13202
|
+
* @remarks
|
|
13203
|
+
* The page number.
|
|
13204
|
+
*
|
|
13066
13205
|
* @example
|
|
13067
13206
|
* 1
|
|
13068
13207
|
*/
|
|
13069
13208
|
pageNumber?: number;
|
|
13070
13209
|
/**
|
|
13210
|
+
* @remarks
|
|
13211
|
+
* The number of entries per page.
|
|
13212
|
+
*
|
|
13071
13213
|
* @example
|
|
13072
13214
|
* 30
|
|
13073
13215
|
*/
|
|
13074
13216
|
pageSize?: number;
|
|
13075
13217
|
/**
|
|
13218
|
+
* @remarks
|
|
13219
|
+
* The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market specifies Alibaba Cloud Marketplace. aliyun_public specifies the PolarDB buy page.
|
|
13220
|
+
*
|
|
13076
13221
|
* @example
|
|
13077
13222
|
* aliyun_market
|
|
13078
13223
|
*/
|
|
13079
13224
|
purchaseChannel?: string;
|
|
13080
13225
|
resourceOwnerAccount?: string;
|
|
13081
13226
|
resourceOwnerId?: number;
|
|
13227
|
+
/**
|
|
13228
|
+
* @remarks
|
|
13229
|
+
* Specifies whether to query only virtual orders.
|
|
13230
|
+
*/
|
|
13082
13231
|
virtualOrder?: boolean;
|
|
13083
13232
|
static names(): { [key: string]: string } {
|
|
13084
13233
|
return {
|
|
@@ -13116,23 +13265,39 @@ export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
|
13116
13265
|
}
|
|
13117
13266
|
|
|
13118
13267
|
export class DescribeLicenseOrdersResponseBody extends $tea.Model {
|
|
13268
|
+
/**
|
|
13269
|
+
* @remarks
|
|
13270
|
+
* The queried orders.
|
|
13271
|
+
*/
|
|
13119
13272
|
items?: DescribeLicenseOrdersResponseBodyItems[];
|
|
13120
13273
|
/**
|
|
13274
|
+
* @remarks
|
|
13275
|
+
* The page number.
|
|
13276
|
+
*
|
|
13121
13277
|
* @example
|
|
13122
13278
|
* 1
|
|
13123
13279
|
*/
|
|
13124
13280
|
pageNumber?: number;
|
|
13125
13281
|
/**
|
|
13282
|
+
* @remarks
|
|
13283
|
+
* The number of entries returned on the current page.
|
|
13284
|
+
*
|
|
13126
13285
|
* @example
|
|
13127
13286
|
* 12
|
|
13128
13287
|
*/
|
|
13129
13288
|
pageRecordCount?: number;
|
|
13130
13289
|
/**
|
|
13290
|
+
* @remarks
|
|
13291
|
+
* The request ID.
|
|
13292
|
+
*
|
|
13131
13293
|
* @example
|
|
13132
13294
|
* 34458CD3-33E0-4624-BFEF-840C15******
|
|
13133
13295
|
*/
|
|
13134
13296
|
requestId?: string;
|
|
13135
13297
|
/**
|
|
13298
|
+
* @remarks
|
|
13299
|
+
* The total number of entries returned.
|
|
13300
|
+
*
|
|
13136
13301
|
* @example
|
|
13137
13302
|
* 50
|
|
13138
13303
|
*/
|
|
@@ -16374,9 +16539,9 @@ export class EvaluateRegionResourceRequest extends $tea.Model {
|
|
|
16374
16539
|
* @remarks
|
|
16375
16540
|
* The cluster link type. The backend randomly selects the default value. Valid values:
|
|
16376
16541
|
*
|
|
16377
|
-
* * **lvs
|
|
16378
|
-
* * **proxy**: proxy server
|
|
16379
|
-
* * **dns**: domain name system
|
|
16542
|
+
* * **lvs**: Linux virtual server.
|
|
16543
|
+
* * **proxy**: proxy server.
|
|
16544
|
+
* * **dns**: domain name system.
|
|
16380
16545
|
*
|
|
16381
16546
|
* @example
|
|
16382
16547
|
* lvs
|
|
@@ -16446,9 +16611,9 @@ export class EvaluateRegionResourceRequest extends $tea.Model {
|
|
|
16446
16611
|
dispenseMode?: string;
|
|
16447
16612
|
/**
|
|
16448
16613
|
* @remarks
|
|
16449
|
-
* Specifies whether
|
|
16614
|
+
* Specifies whether to create Maxscale. Valid values:
|
|
16450
16615
|
*
|
|
16451
|
-
* * **true**
|
|
16616
|
+
* * **true** (default)
|
|
16452
16617
|
* * **false**
|
|
16453
16618
|
*
|
|
16454
16619
|
* This parameter is required.
|
|
@@ -17941,6 +18106,22 @@ export class ModifyDBClusterRequest extends $tea.Model {
|
|
|
17941
18106
|
* 0
|
|
17942
18107
|
*/
|
|
17943
18108
|
faultSimulateMode?: string;
|
|
18109
|
+
/**
|
|
18110
|
+
* @remarks
|
|
18111
|
+
* Specifies whether to enable automatic IMCI-based query acceleration. IMCI is short for In-Memory Column Index. Valid values:
|
|
18112
|
+
*
|
|
18113
|
+
* * `ON`: enables automatic IMCI-based query acceleration.
|
|
18114
|
+
* * `OFF`: disables automatic IMCI-based query acceleration.
|
|
18115
|
+
*
|
|
18116
|
+
* >
|
|
18117
|
+
*
|
|
18118
|
+
* * This parameter is supported only for PolarDB for MySQL clusters.
|
|
18119
|
+
*
|
|
18120
|
+
* * For information about the cluster version limits, see [Automatic IMCI-based query acceleration](https://help.aliyun.com/document_detail/2854119.html).
|
|
18121
|
+
*
|
|
18122
|
+
* @example
|
|
18123
|
+
* OFF
|
|
18124
|
+
*/
|
|
17944
18125
|
imciAutoIndex?: string;
|
|
17945
18126
|
ownerAccount?: string;
|
|
17946
18127
|
ownerId?: number;
|
|
@@ -18764,10 +18945,10 @@ export class ModifyDBClusterDescriptionResponse extends $tea.Model {
|
|
|
18764
18945
|
export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
18765
18946
|
/**
|
|
18766
18947
|
* @remarks
|
|
18767
|
-
* Specifies whether to
|
|
18948
|
+
* Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
|
|
18768
18949
|
*
|
|
18769
|
-
* * **Enable
|
|
18770
|
-
* * **Disable**
|
|
18950
|
+
* * **Enable**: enables automatic association of newly added nodes with the cluster endpoint.
|
|
18951
|
+
* * **Disable** (default): disables automatic association of newly added nodes with the cluster endpoint.
|
|
18771
18952
|
*
|
|
18772
18953
|
* @example
|
|
18773
18954
|
* Enable
|
|
@@ -18803,60 +18984,74 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18803
18984
|
DBEndpointId?: string;
|
|
18804
18985
|
/**
|
|
18805
18986
|
* @remarks
|
|
18806
|
-
* The advanced configurations of the cluster endpoint, which are in the JSON format. You can
|
|
18987
|
+
* The advanced configurations of the cluster endpoint, which are in the JSON format. You can configure the consistency level, transaction splitting, and connection pool settings, and specify whether the primary node accepts read requests.
|
|
18807
18988
|
*
|
|
18808
|
-
* *
|
|
18989
|
+
* * The load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
|
|
18809
18990
|
*
|
|
18810
|
-
* * **0
|
|
18991
|
+
* * **0** (default): connections-based load balancing
|
|
18811
18992
|
* * **1**: active requests-based load balancing
|
|
18812
18993
|
*
|
|
18813
|
-
* * Specifies whether to
|
|
18994
|
+
* * Specifies whether to allow the primary node to accept read requests. Format: `{\\"MasterAcceptReads\\":\\"Specification about whether to allow the primary node to accept read requests\\"}`. Valid values:
|
|
18814
18995
|
*
|
|
18815
|
-
* * **on**
|
|
18816
|
-
* * **off
|
|
18996
|
+
* * **on** (default): allows the primary node to accept read requests.
|
|
18997
|
+
* * **off**: does not allow the primary node to accept read requests.
|
|
18817
18998
|
*
|
|
18818
|
-
* * Specifies whether to enable the transaction splitting feature
|
|
18999
|
+
* * Specifies whether to enable the transaction splitting feature. Format: `{\\"DistributedTransaction\\":\\"Specification about whether to enable the transaction splitting feature\\"}`. Valid values:
|
|
18819
19000
|
*
|
|
18820
|
-
* * **on**
|
|
18821
|
-
* * **off
|
|
19001
|
+
* * **on** (default): enables the transaction splitting feature.
|
|
19002
|
+
* * **off**: disables the transaction splitting feature.
|
|
18822
19003
|
*
|
|
18823
|
-
* *
|
|
19004
|
+
* * The consistency level. Format: `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
|
|
18824
19005
|
*
|
|
18825
19006
|
* * **0**: eventual consistency (weak)
|
|
18826
|
-
* * **1
|
|
19007
|
+
* * **1** (default): session consistency (medium)
|
|
18827
19008
|
* * **2**: global consistency (strong)
|
|
18828
19009
|
*
|
|
18829
|
-
* *
|
|
19010
|
+
* * The global consistency timeout. Format: `{\\"ConsistTimeout\\":\\"Global consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 20. Unit: ms.
|
|
18830
19011
|
*
|
|
18831
|
-
*
|
|
19012
|
+
* * The session consistency timeout. Format: `{\\"ConsistSessionTimeout\\":\\"Session consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 0. Unit: ms.
|
|
19013
|
+
*
|
|
19014
|
+
* * The global (or session) consistency timeout policy. Format: `{\\"ConsistTimeoutAction\\":\\"Consistency timeout policy\\"}`. Valid values:
|
|
19015
|
+
*
|
|
19016
|
+
* * **0** (default): PolarProxy sends read requests to the primary node.
|
|
19017
|
+
* * **1**: PolarProxy returns the "wait replication complete timeout, please retry" error message to the application.
|
|
19018
|
+
*
|
|
19019
|
+
* * Specifies whether to enable the connection pool feature. Format: `{\\"ConnectionPersist\\":\\"Specification about whether to enable the connection pool feature\\"}`. Valid values:
|
|
19020
|
+
*
|
|
19021
|
+
* * **off** (default): disables the connection pool feature.
|
|
18832
19022
|
* * **Session**: enables the session-level connection pool.
|
|
18833
19023
|
* * **Transaction**: enables the transaction-level connection pool.
|
|
18834
19024
|
*
|
|
18835
|
-
* * Specifies whether to enable the parallel query feature
|
|
19025
|
+
* * Specifies whether to enable the parallel query feature. Format: `{\\"MaxParallelDegree\\":\\"Specification about whether to enable the parallel query feature\\"}`. Valid values:
|
|
18836
19026
|
*
|
|
18837
|
-
* * **on
|
|
18838
|
-
* * **off**
|
|
19027
|
+
* * **on**: enables the parallel query feature.
|
|
19028
|
+
* * **off** (default): disables the parallel query feature.
|
|
18839
19029
|
*
|
|
18840
|
-
* * Specifies whether to enable the automatic request distribution
|
|
19030
|
+
* * Specifies whether to enable the automatic request distribution among row store and column store nodes feature. Format: `{\\"EnableHtapImci\\":\\"Specification about whether to enable automatic request distribution among row store and column store nodes feature\\"}`. Valid values:
|
|
18841
19031
|
*
|
|
18842
|
-
* * **on
|
|
18843
|
-
* * **off**
|
|
19032
|
+
* * **on**: enables the automatic request distribution among row store and column store nodes feature.
|
|
19033
|
+
* * **off** (default): disables the automatic request distribution among row store and column store nodes feature.
|
|
18844
19034
|
*
|
|
18845
|
-
* * Specifies whether to enable the overload protection feature
|
|
19035
|
+
* * Specifies whether to enable the overload protection feature. Format: `{\\"EnableOverloadThrottle\\":\\"Specification about whether to enable the overload protection feature\\"}`. Valid values:
|
|
18846
19036
|
*
|
|
18847
|
-
* * **on
|
|
18848
|
-
* * **off**
|
|
19037
|
+
* * **on**: enables the overload protection feature.
|
|
19038
|
+
* * **off** (default): disables the overload protection feature.
|
|
18849
19039
|
*
|
|
18850
19040
|
* >
|
|
18851
19041
|
*
|
|
18852
|
-
* * You can
|
|
19042
|
+
* * You can configure the transaction splitting, connection pool, and overload protection settings, and specify whether the primary node accepts read requests settings for the cluster endpoint of a PolarDB for MySQL cluster only if ReadWriteMode of the cluster endpoint is set to Read and Write (Automatic Read/Write Splitting).
|
|
19043
|
+
*
|
|
19044
|
+
* * If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read-only**, you can specify the **Connections-based Load Balancing** or **Active Request-based Load Balancing** policy for the cluster endpoint. If ReadWriteMode of the cluster endpoint of a PolarDB for MySQL cluster is set to **Read/Write (Automatic Read/Write Splitting)**, you can specify only the **Active Request-based Load Balancing** policy for the cluster endpoint.
|
|
19045
|
+
*
|
|
19046
|
+
* * You can enable automatic request distribution among column store and row store nodes for the cluster endpoint of a PolarDB for MySQL cluster if ReadWriteMode of the cluster endpoint is set to **Read and Write (Automatic Read/Write Splitting)**, or if the ReadWriteMode of the cluster endpoint is set to **Read-only** and the load balancing policy is set to **Active requests-based load balancing**.
|
|
18853
19047
|
*
|
|
18854
|
-
* * If the read /write mode of a PolarDB for MySQL cluster is set to **Read-only**, the **Connection-based SLB** and **Active Request-based SLB** SLB policies are supported. The **Read-write (Automatic read /write splitting) **mode of the cluster supports** Active Request-based SLB** policy.
|
|
18855
|
-
* * If ReadWriteMode is set to **ReadWrite** for the cluster endpoint of a PolarDB for MySQL cluster or if ReadWriteMode is set to **ReadOnly** and the load balancing policy is set to **active requests-based load balancing**, the automatic request distribution between row store and column store nodes feature is supported.
|
|
18856
19048
|
* * Only PolarDB for MySQL supports global consistency.
|
|
18857
|
-
*
|
|
18858
|
-
* * You can
|
|
18859
|
-
*
|
|
19049
|
+
*
|
|
19050
|
+
* * You can set the consistency level of the cluster endpoint of a PolarDB for MySQL cluster only to **0** if **ReadWriteMode** of the cluster endpoint is set to **ReadOnly**.
|
|
19051
|
+
*
|
|
19052
|
+
* * You can configure the settings for the consistency level, transaction splitting, and connection pool features, and specify whether the primary node accepts read requests settings at a time. Example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
|
|
19053
|
+
*
|
|
19054
|
+
* * The configuration for transaction splitting is limited by the configuration for the consistency level. For example, if you set the consistency level to **0**, you cannot enable transaction splitting. If you set the consistency level to **1** or **2**, you can enable transaction splitting.
|
|
18860
19055
|
*
|
|
18861
19056
|
* @example
|
|
18862
19057
|
* {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
|
|
@@ -18885,7 +19080,24 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18885
19080
|
nodes?: string;
|
|
18886
19081
|
ownerAccount?: string;
|
|
18887
19082
|
ownerId?: number;
|
|
19083
|
+
/**
|
|
19084
|
+
* @remarks
|
|
19085
|
+
* Global consistency timeout policy. Valid values:
|
|
19086
|
+
*
|
|
19087
|
+
* * **0**: sends the request to the primary node.
|
|
19088
|
+
* * **2**: downgrades the consistency level of a query to inconsistent read when a global consistent read in the query times out. No error message is returned to the client.
|
|
19089
|
+
*
|
|
19090
|
+
* @example
|
|
19091
|
+
* 0
|
|
19092
|
+
*/
|
|
18888
19093
|
polarSccTimeoutAction?: string;
|
|
19094
|
+
/**
|
|
19095
|
+
* @remarks
|
|
19096
|
+
* Global consistency timeout.
|
|
19097
|
+
*
|
|
19098
|
+
* @example
|
|
19099
|
+
* 100
|
|
19100
|
+
*/
|
|
18889
19101
|
polarSccWaitTimeout?: string;
|
|
18890
19102
|
/**
|
|
18891
19103
|
* @remarks
|
|
@@ -18900,6 +19112,21 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18900
19112
|
readWriteMode?: string;
|
|
18901
19113
|
resourceOwnerAccount?: string;
|
|
18902
19114
|
resourceOwnerId?: number;
|
|
19115
|
+
/**
|
|
19116
|
+
* @remarks
|
|
19117
|
+
* Specifies whether to enable the global consistency (high-performance mode) feature for the nodes. Valid values:
|
|
19118
|
+
*
|
|
19119
|
+
* * **ON**
|
|
19120
|
+
* * **OFF**
|
|
19121
|
+
*
|
|
19122
|
+
* Valid values:
|
|
19123
|
+
*
|
|
19124
|
+
* * on
|
|
19125
|
+
* * off
|
|
19126
|
+
*
|
|
19127
|
+
* @example
|
|
19128
|
+
* on
|
|
19129
|
+
*/
|
|
18903
19130
|
sccMode?: string;
|
|
18904
19131
|
static names(): { [key: string]: string } {
|
|
18905
19132
|
return {
|
|
@@ -24479,8 +24706,11 @@ export class UpgradeDBClusterVersionRequest extends $tea.Model {
|
|
|
24479
24706
|
* @remarks
|
|
24480
24707
|
* The earliest start time to run the task that updates the kernel version of the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
|
|
24481
24708
|
*
|
|
24482
|
-
* >
|
|
24483
|
-
*
|
|
24709
|
+
* >
|
|
24710
|
+
*
|
|
24711
|
+
* * The earliest start time of the task can be a point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in time from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`.
|
|
24712
|
+
*
|
|
24713
|
+
* * If you do not specify this parameter, the kernel update task runs immediately after you submit the request.
|
|
24484
24714
|
*
|
|
24485
24715
|
* @example
|
|
24486
24716
|
* 2021-01-14T09:00:00Z
|
|
@@ -25035,46 +25265,73 @@ export class DescribeAccountsResponseBodyAccounts extends $tea.Model {
|
|
|
25035
25265
|
|
|
25036
25266
|
export class DescribeActivationCodesResponseBodyItems extends $tea.Model {
|
|
25037
25267
|
/**
|
|
25268
|
+
* @remarks
|
|
25269
|
+
* The time when the activation code takes effect.
|
|
25270
|
+
*
|
|
25038
25271
|
* @example
|
|
25039
25272
|
* 2024-10-16 16:46:20
|
|
25040
25273
|
*/
|
|
25041
25274
|
activateAt?: string;
|
|
25042
25275
|
/**
|
|
25276
|
+
* @remarks
|
|
25277
|
+
* The description of the activation code.
|
|
25278
|
+
*
|
|
25043
25279
|
* @example
|
|
25044
25280
|
* testCode
|
|
25045
25281
|
*/
|
|
25046
25282
|
description?: string;
|
|
25047
25283
|
/**
|
|
25284
|
+
* @remarks
|
|
25285
|
+
* The time when the activation code expires.
|
|
25286
|
+
*
|
|
25048
25287
|
* @example
|
|
25049
25288
|
* 2054-10-16 16:46:20
|
|
25050
25289
|
*/
|
|
25051
25290
|
expireAt?: string;
|
|
25052
25291
|
/**
|
|
25292
|
+
* @remarks
|
|
25293
|
+
* The time when the activation code was generated.
|
|
25294
|
+
*
|
|
25053
25295
|
* @example
|
|
25054
25296
|
* 2024-10-16 16:46:20
|
|
25055
25297
|
*/
|
|
25056
25298
|
gmtCreated?: string;
|
|
25057
25299
|
/**
|
|
25300
|
+
* @remarks
|
|
25301
|
+
* The time when the activation code was updated.
|
|
25302
|
+
*
|
|
25058
25303
|
* @example
|
|
25059
25304
|
* 2024-10-16 16:46:20
|
|
25060
25305
|
*/
|
|
25061
25306
|
gmtModified?: string;
|
|
25062
25307
|
/**
|
|
25308
|
+
* @remarks
|
|
25309
|
+
* The activation code ID.
|
|
25310
|
+
*
|
|
25063
25311
|
* @example
|
|
25064
25312
|
* 123
|
|
25065
25313
|
*/
|
|
25066
25314
|
id?: number;
|
|
25067
25315
|
/**
|
|
25316
|
+
* @remarks
|
|
25317
|
+
* The media access control (MAC) address used in the generation of the activation code.
|
|
25318
|
+
*
|
|
25068
25319
|
* @example
|
|
25069
25320
|
* 12:34:56:78:98:00
|
|
25070
25321
|
*/
|
|
25071
25322
|
macAddress?: string;
|
|
25072
25323
|
/**
|
|
25324
|
+
* @remarks
|
|
25325
|
+
* The name of the activation code.
|
|
25326
|
+
*
|
|
25073
25327
|
* @example
|
|
25074
25328
|
* testName
|
|
25075
25329
|
*/
|
|
25076
25330
|
name?: string;
|
|
25077
25331
|
/**
|
|
25332
|
+
* @remarks
|
|
25333
|
+
* The unique identifier of the database.
|
|
25334
|
+
*
|
|
25078
25335
|
* @example
|
|
25079
25336
|
* 1234567890123456
|
|
25080
25337
|
*/
|
|
@@ -25713,6 +25970,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25713
25970
|
* 8
|
|
25714
25971
|
*/
|
|
25715
25972
|
cpu?: string;
|
|
25973
|
+
essdMaxStorageCapacity?: string;
|
|
25716
25974
|
/**
|
|
25717
25975
|
* @remarks
|
|
25718
25976
|
* The maximum number of concurrent connections in the cluster.
|
|
@@ -25769,6 +26027,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25769
26027
|
* 1000000
|
|
25770
26028
|
*/
|
|
25771
26029
|
pl3MaxIOPS?: string;
|
|
26030
|
+
polarStoreMaxStorageCapacity?: string;
|
|
25772
26031
|
/**
|
|
25773
26032
|
* @remarks
|
|
25774
26033
|
* The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.
|
|
@@ -25817,6 +26076,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25817
26076
|
classGroup: 'ClassGroup',
|
|
25818
26077
|
classTypeLevel: 'ClassTypeLevel',
|
|
25819
26078
|
cpu: 'Cpu',
|
|
26079
|
+
essdMaxStorageCapacity: 'EssdMaxStorageCapacity',
|
|
25820
26080
|
maxConnections: 'MaxConnections',
|
|
25821
26081
|
maxIOPS: 'MaxIOPS',
|
|
25822
26082
|
maxStorageCapacity: 'MaxStorageCapacity',
|
|
@@ -25824,6 +26084,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25824
26084
|
pl1MaxIOPS: 'Pl1MaxIOPS',
|
|
25825
26085
|
pl2MaxIOPS: 'Pl2MaxIOPS',
|
|
25826
26086
|
pl3MaxIOPS: 'Pl3MaxIOPS',
|
|
26087
|
+
polarStoreMaxStorageCapacity: 'PolarStoreMaxStorageCapacity',
|
|
25827
26088
|
psl4MaxIOPS: 'Psl4MaxIOPS',
|
|
25828
26089
|
psl5MaxIOPS: 'Psl5MaxIOPS',
|
|
25829
26090
|
referenceExtPrice: 'ReferenceExtPrice',
|
|
@@ -25837,6 +26098,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25837
26098
|
classGroup: 'string',
|
|
25838
26099
|
classTypeLevel: 'string',
|
|
25839
26100
|
cpu: 'string',
|
|
26101
|
+
essdMaxStorageCapacity: 'string',
|
|
25840
26102
|
maxConnections: 'string',
|
|
25841
26103
|
maxIOPS: 'string',
|
|
25842
26104
|
maxStorageCapacity: 'string',
|
|
@@ -25844,6 +26106,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25844
26106
|
pl1MaxIOPS: 'string',
|
|
25845
26107
|
pl2MaxIOPS: 'string',
|
|
25846
26108
|
pl3MaxIOPS: 'string',
|
|
26109
|
+
polarStoreMaxStorageCapacity: 'string',
|
|
25847
26110
|
psl4MaxIOPS: 'string',
|
|
25848
26111
|
psl5MaxIOPS: 'string',
|
|
25849
26112
|
referenceExtPrice: 'string',
|
|
@@ -26024,6 +26287,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26024
26287
|
* polar.mysql.x4.large
|
|
26025
26288
|
*/
|
|
26026
26289
|
DBNodeClass?: string;
|
|
26290
|
+
DBNodeDescription?: string;
|
|
26027
26291
|
/**
|
|
26028
26292
|
* @remarks
|
|
26029
26293
|
* Node ID.
|
|
@@ -26216,6 +26480,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26216
26480
|
cpuCores: 'CpuCores',
|
|
26217
26481
|
creationTime: 'CreationTime',
|
|
26218
26482
|
DBNodeClass: 'DBNodeClass',
|
|
26483
|
+
DBNodeDescription: 'DBNodeDescription',
|
|
26219
26484
|
DBNodeId: 'DBNodeId',
|
|
26220
26485
|
DBNodeRole: 'DBNodeRole',
|
|
26221
26486
|
DBNodeStatus: 'DBNodeStatus',
|
|
@@ -26245,6 +26510,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26245
26510
|
cpuCores: 'string',
|
|
26246
26511
|
creationTime: 'string',
|
|
26247
26512
|
DBNodeClass: 'string',
|
|
26513
|
+
DBNodeDescription: 'string',
|
|
26248
26514
|
DBNodeId: 'string',
|
|
26249
26515
|
DBNodeRole: 'string',
|
|
26250
26516
|
DBNodeStatus: 'string',
|
|
@@ -26686,7 +26952,10 @@ export class DescribeDBClusterEndpointsResponseBodyItems extends $tea.Model {
|
|
|
26686
26952
|
export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems extends $tea.Model {
|
|
26687
26953
|
/**
|
|
26688
26954
|
* @remarks
|
|
26689
|
-
*
|
|
26955
|
+
* Indicates whether SSL encryption is enabled. Valid values:
|
|
26956
|
+
*
|
|
26957
|
+
* * **Enabled**
|
|
26958
|
+
* * **Disabled**
|
|
26690
26959
|
*
|
|
26691
26960
|
* @example
|
|
26692
26961
|
* pc-**************.rwlb.rds.aliyuncs.com
|
|
@@ -26694,7 +26963,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26694
26963
|
connectionString?: string;
|
|
26695
26964
|
/**
|
|
26696
26965
|
* @remarks
|
|
26697
|
-
* The
|
|
26966
|
+
* The description of a migration exception. If no exception occurs during the migration, an empty string is returned.
|
|
26698
26967
|
*
|
|
26699
26968
|
* @example
|
|
26700
26969
|
* 192.***.***.10
|
|
@@ -26702,11 +26971,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26702
26971
|
IPAddress?: string;
|
|
26703
26972
|
/**
|
|
26704
26973
|
* @remarks
|
|
26705
|
-
* The
|
|
26706
|
-
*
|
|
26707
|
-
* * **Public**: the public endpoint
|
|
26708
|
-
* * **Private**: the internal endpoint (VPC)
|
|
26709
|
-
* * **Inner**: the internal endpoint (classic network)
|
|
26974
|
+
* The ID of the endpoint.
|
|
26710
26975
|
*
|
|
26711
26976
|
* @example
|
|
26712
26977
|
* Private
|
|
@@ -26714,7 +26979,11 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26714
26979
|
netType?: string;
|
|
26715
26980
|
/**
|
|
26716
26981
|
* @remarks
|
|
26717
|
-
* The
|
|
26982
|
+
* The type of the endpoint. Valid values:
|
|
26983
|
+
*
|
|
26984
|
+
* * **Cluster**: the default cluster endpoint
|
|
26985
|
+
* * **Primary**: the primary endpoint
|
|
26986
|
+
* * **Custom**: the custom endpoint
|
|
26718
26987
|
*
|
|
26719
26988
|
* @example
|
|
26720
26989
|
* 3306
|
|
@@ -26722,10 +26991,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26722
26991
|
port?: string;
|
|
26723
26992
|
/**
|
|
26724
26993
|
* @remarks
|
|
26725
|
-
*
|
|
26726
|
-
*
|
|
26727
|
-
* * **Enabled**
|
|
26728
|
-
* * **Disabled**
|
|
26994
|
+
* The ID of the request.
|
|
26729
26995
|
*
|
|
26730
26996
|
* @example
|
|
26731
26997
|
* Enabled
|
|
@@ -26733,7 +26999,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26733
26999
|
SSLEnabled?: string;
|
|
26734
27000
|
/**
|
|
26735
27001
|
* @remarks
|
|
26736
|
-
* The
|
|
27002
|
+
* The read/write mode. Valid values:
|
|
27003
|
+
*
|
|
27004
|
+
* * ReadWrite: receives and forwards read and write requests (automatic read-write splitting).
|
|
27005
|
+
* * ReadOnly (default): receives and forwards read requests only.
|
|
26737
27006
|
*
|
|
26738
27007
|
* @example
|
|
26739
27008
|
* vpc-**********
|
|
@@ -26741,7 +27010,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26741
27010
|
VPCId?: string;
|
|
26742
27011
|
/**
|
|
26743
27012
|
* @remarks
|
|
26744
|
-
* The
|
|
27013
|
+
* The IP address of the endpoint.
|
|
26745
27014
|
*
|
|
26746
27015
|
* @example
|
|
26747
27016
|
* vsw-**********
|
|
@@ -26779,12 +27048,12 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26779
27048
|
export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends $tea.Model {
|
|
26780
27049
|
/**
|
|
26781
27050
|
* @remarks
|
|
26782
|
-
*
|
|
27051
|
+
* The VPC ID.
|
|
26783
27052
|
*/
|
|
26784
27053
|
addressItems?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems[];
|
|
26785
27054
|
/**
|
|
26786
27055
|
* @remarks
|
|
26787
|
-
* The
|
|
27056
|
+
* The expiration time of the replication between ApsaraDB RDS and PolarDB. The time is in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.
|
|
26788
27057
|
*
|
|
26789
27058
|
* @example
|
|
26790
27059
|
* pe-***********
|
|
@@ -26792,11 +27061,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26792
27061
|
DBEndpointId?: string;
|
|
26793
27062
|
/**
|
|
26794
27063
|
* @remarks
|
|
26795
|
-
* The
|
|
26796
|
-
*
|
|
26797
|
-
* * **Cluster**: the default cluster endpoint
|
|
26798
|
-
* * **Primary**: the primary endpoint
|
|
26799
|
-
* * **Custom**: the custom endpoint
|
|
27064
|
+
* The ID of the cluster.
|
|
26800
27065
|
*
|
|
26801
27066
|
* @example
|
|
26802
27067
|
* Cluster
|
|
@@ -26804,10 +27069,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26804
27069
|
endpointType?: string;
|
|
26805
27070
|
/**
|
|
26806
27071
|
* @remarks
|
|
26807
|
-
* The
|
|
27072
|
+
* The synchronization direction. Valid values:
|
|
26808
27073
|
*
|
|
26809
|
-
* *
|
|
26810
|
-
* *
|
|
27074
|
+
* * **RDS2POLARDB**: Data is replicated from an ApsaraDB RDS instance to a PolarDB cluster.
|
|
27075
|
+
* * **POLARDB2RDS**: Data is replicated from a PolarDB cluster to an ApsaraDB RDS instance.
|
|
26811
27076
|
*
|
|
26812
27077
|
* @example
|
|
26813
27078
|
* ReadOnly
|
|
@@ -26839,7 +27104,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26839
27104
|
export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems extends $tea.Model {
|
|
26840
27105
|
/**
|
|
26841
27106
|
* @remarks
|
|
26842
|
-
*
|
|
27107
|
+
* Indicates whether SSL encryption is enabled. Valid values:
|
|
27108
|
+
*
|
|
27109
|
+
* * **Enabled**
|
|
27110
|
+
* * **Disabled**
|
|
26843
27111
|
*
|
|
26844
27112
|
* @example
|
|
26845
27113
|
* rm-***********.mysql.rds.aliyuncs.com
|
|
@@ -26847,7 +27115,10 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26847
27115
|
connectionString?: string;
|
|
26848
27116
|
/**
|
|
26849
27117
|
* @remarks
|
|
26850
|
-
* The
|
|
27118
|
+
* The type of the source database. Valid values:
|
|
27119
|
+
*
|
|
27120
|
+
* * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
|
|
27121
|
+
* * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
|
|
26851
27122
|
*
|
|
26852
27123
|
* @example
|
|
26853
27124
|
* 172.***.***.173
|
|
@@ -26855,11 +27126,7 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26855
27126
|
IPAddress?: string;
|
|
26856
27127
|
/**
|
|
26857
27128
|
* @remarks
|
|
26858
|
-
* The
|
|
26859
|
-
*
|
|
26860
|
-
* * **Public**: the public endpoint
|
|
26861
|
-
* * **Private**: the internal endpoint (VPC)
|
|
26862
|
-
* * **Inner**: the internal endpoint (classic network)
|
|
27129
|
+
* The ID of the endpoint.
|
|
26863
27130
|
*
|
|
26864
27131
|
* @example
|
|
26865
27132
|
* Private
|
|
@@ -26867,26 +27134,23 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26867
27134
|
netType?: string;
|
|
26868
27135
|
/**
|
|
26869
27136
|
* @remarks
|
|
26870
|
-
* The
|
|
27137
|
+
* The type of the endpoint. Valid values:
|
|
27138
|
+
*
|
|
27139
|
+
* * **Normal**: the standard endpoint
|
|
27140
|
+
* * **ReadWriteSplitting**: the read/write splitting endpoint
|
|
26871
27141
|
*
|
|
26872
27142
|
* @example
|
|
26873
27143
|
* 3306
|
|
26874
27144
|
*/
|
|
26875
27145
|
port?: string;
|
|
26876
27146
|
/**
|
|
26877
|
-
* @remarks
|
|
26878
|
-
* Indicates whether SSL encryption is enabled. Valid values:
|
|
26879
|
-
*
|
|
26880
|
-
* * **Enabled**
|
|
26881
|
-
* * **Disabled**
|
|
26882
|
-
*
|
|
26883
27147
|
* @example
|
|
26884
27148
|
* Enabled
|
|
26885
27149
|
*/
|
|
26886
27150
|
SSLEnabled?: string;
|
|
26887
27151
|
/**
|
|
26888
27152
|
* @remarks
|
|
26889
|
-
* The
|
|
27153
|
+
* The instance type.
|
|
26890
27154
|
*
|
|
26891
27155
|
* @example
|
|
26892
27156
|
* vpc-************
|
|
@@ -26894,7 +27158,7 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26894
27158
|
VPCId?: string;
|
|
26895
27159
|
/**
|
|
26896
27160
|
* @remarks
|
|
26897
|
-
* The
|
|
27161
|
+
* The IP address of the endpoint.
|
|
26898
27162
|
*
|
|
26899
27163
|
* @example
|
|
26900
27164
|
* vsw-**************
|
|
@@ -26932,13 +27196,10 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26932
27196
|
export class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.Model {
|
|
26933
27197
|
/**
|
|
26934
27198
|
* @remarks
|
|
26935
|
-
*
|
|
27199
|
+
* The VPC ID.
|
|
26936
27200
|
*/
|
|
26937
27201
|
addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
|
|
26938
27202
|
/**
|
|
26939
|
-
* @remarks
|
|
26940
|
-
* The role of the source database instance.
|
|
26941
|
-
*
|
|
26942
27203
|
* @example
|
|
26943
27204
|
* ReadOnly
|
|
26944
27205
|
* Maxscale
|
|
@@ -26946,20 +27207,11 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.
|
|
|
26946
27207
|
*/
|
|
26947
27208
|
custinsType?: string;
|
|
26948
27209
|
/**
|
|
26949
|
-
* @remarks
|
|
26950
|
-
* The ID of the endpoint.
|
|
26951
|
-
*
|
|
26952
27210
|
* @example
|
|
26953
27211
|
* rm-************-normal
|
|
26954
27212
|
*/
|
|
26955
27213
|
DBEndpointId?: string;
|
|
26956
27214
|
/**
|
|
26957
|
-
* @remarks
|
|
26958
|
-
* The type of the endpoint. Valid values:
|
|
26959
|
-
*
|
|
26960
|
-
* * **Normal**: the standard endpoint
|
|
26961
|
-
* * **ReadWriteSplitting**: the read/write splitting endpoint
|
|
26962
|
-
*
|
|
26963
27215
|
* @example
|
|
26964
27216
|
* Normal
|
|
26965
27217
|
*/
|
|
@@ -30155,66 +30407,111 @@ export class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGr
|
|
|
30155
30407
|
|
|
30156
30408
|
export class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
|
|
30157
30409
|
/**
|
|
30410
|
+
* @remarks
|
|
30411
|
+
* The number of generated activation codes.
|
|
30412
|
+
*
|
|
30158
30413
|
* @example
|
|
30159
30414
|
* 10
|
|
30160
30415
|
*/
|
|
30161
30416
|
activatedCodeCount?: number;
|
|
30162
30417
|
/**
|
|
30418
|
+
* @remarks
|
|
30419
|
+
* The maximum number of activation codes that you can apply for.
|
|
30420
|
+
*
|
|
30163
30421
|
* @example
|
|
30164
30422
|
* 10
|
|
30165
30423
|
*/
|
|
30166
30424
|
activationCodeQuota?: number;
|
|
30167
30425
|
/**
|
|
30426
|
+
* @remarks
|
|
30427
|
+
* The ID of the Alibaba Cloud order. The ID of a virtual order may be returned.
|
|
30428
|
+
*
|
|
30168
30429
|
* @example
|
|
30169
30430
|
* 227638319690519
|
|
30170
30431
|
*/
|
|
30171
30432
|
aliyunOrderId?: string;
|
|
30172
30433
|
/**
|
|
30434
|
+
* @remarks
|
|
30435
|
+
* Indicates whether the SystemIdentifier parameter can be left empty when the system generates an activation code.
|
|
30436
|
+
*
|
|
30173
30437
|
* @example
|
|
30174
30438
|
* false
|
|
30175
30439
|
*/
|
|
30176
30440
|
allowEmptySystemIdentifier?: boolean;
|
|
30177
30441
|
/**
|
|
30442
|
+
* @remarks
|
|
30443
|
+
* The engine of the PolarDB cluster. Valid values: PG, Oracle, and MySQL.
|
|
30444
|
+
*
|
|
30178
30445
|
* @example
|
|
30179
30446
|
* PG
|
|
30180
30447
|
*/
|
|
30181
30448
|
engine?: string;
|
|
30182
30449
|
/**
|
|
30450
|
+
* @remarks
|
|
30451
|
+
* The time when the order was created.
|
|
30452
|
+
*
|
|
30183
30453
|
* @example
|
|
30184
30454
|
* 2022-02-11 03:14:15
|
|
30185
30455
|
*/
|
|
30186
30456
|
gmtCreated?: string;
|
|
30187
30457
|
/**
|
|
30458
|
+
* @remarks
|
|
30459
|
+
* The time when the order was updated.
|
|
30460
|
+
*
|
|
30188
30461
|
* @example
|
|
30189
30462
|
* 2022-02-11 03:14:15
|
|
30190
30463
|
*/
|
|
30191
30464
|
gmtModified?: string;
|
|
30192
30465
|
/**
|
|
30466
|
+
* @remarks
|
|
30467
|
+
* Indicates whether the order is a virtual order. Pre-generation of activation codes is allowed for virtual orders.
|
|
30468
|
+
*
|
|
30193
30469
|
* @example
|
|
30194
30470
|
* false
|
|
30195
30471
|
*/
|
|
30196
30472
|
isVirtualOrder?: boolean;
|
|
30197
30473
|
/**
|
|
30474
|
+
* @remarks
|
|
30475
|
+
* Indicates whether the virtual order is frozen. Generation of activation codes is not allowed for frozen virtual orders.
|
|
30476
|
+
*
|
|
30198
30477
|
* @example
|
|
30199
30478
|
* false
|
|
30200
30479
|
*/
|
|
30201
30480
|
isVirtualOrderFrozen?: boolean;
|
|
30202
30481
|
/**
|
|
30482
|
+
* @remarks
|
|
30483
|
+
* The type of the package. Valid values:
|
|
30484
|
+
*
|
|
30485
|
+
* * single_node_subscribe: Single-node Edition (Subscription).
|
|
30486
|
+
* * single_node_long_term: Single-node Edition (Long-term).
|
|
30487
|
+
* * primary_backup_subscribe: HA Edition (Subscription).
|
|
30488
|
+
* * primary_backup_long_term: HA Edition (Long-term).
|
|
30489
|
+
* * pre_generation_long_term: Pre-generated (Long-term).
|
|
30490
|
+
*
|
|
30203
30491
|
* @example
|
|
30204
30492
|
* single_node_subscribe
|
|
30205
30493
|
*/
|
|
30206
30494
|
packageType?: string;
|
|
30207
30495
|
/**
|
|
30496
|
+
* @remarks
|
|
30497
|
+
* The validity period of the package. Valid values: 1 year and 30 years.
|
|
30498
|
+
*
|
|
30208
30499
|
* @example
|
|
30209
30500
|
* 1 year
|
|
30210
30501
|
*/
|
|
30211
30502
|
packageValidity?: string;
|
|
30212
30503
|
/**
|
|
30504
|
+
* @remarks
|
|
30505
|
+
* The purchase channel. Valid values: aliyun_market and aliyun_public. aliyun_market indicates Alibaba Cloud Marketplace. aliyun_public indicates the PolarDB buy page.
|
|
30506
|
+
*
|
|
30213
30507
|
* @example
|
|
30214
30508
|
* aliyun_public
|
|
30215
30509
|
*/
|
|
30216
30510
|
purchaseChannel?: string;
|
|
30217
30511
|
/**
|
|
30512
|
+
* @remarks
|
|
30513
|
+
* The ID of the virtual order.
|
|
30514
|
+
*
|
|
30218
30515
|
* @example
|
|
30219
30516
|
* 227638319690519
|
|
30220
30517
|
*/
|
|
@@ -32896,7 +33193,7 @@ export default class Client extends OpenApi {
|
|
|
32896
33193
|
}
|
|
32897
33194
|
|
|
32898
33195
|
/**
|
|
32899
|
-
*
|
|
33196
|
+
* Generates a lightweight license activation code.
|
|
32900
33197
|
*
|
|
32901
33198
|
* @param request - CreateActivationCodeRequest
|
|
32902
33199
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -32959,7 +33256,7 @@ export default class Client extends OpenApi {
|
|
|
32959
33256
|
}
|
|
32960
33257
|
|
|
32961
33258
|
/**
|
|
32962
|
-
*
|
|
33259
|
+
* Generates a lightweight license activation code.
|
|
32963
33260
|
*
|
|
32964
33261
|
* @param request - CreateActivationCodeRequest
|
|
32965
33262
|
* @returns CreateActivationCodeResponse
|
|
@@ -33139,6 +33436,10 @@ export default class Client extends OpenApi {
|
|
|
33139
33436
|
query["BackupRetentionPolicyOnClusterDeletion"] = request.backupRetentionPolicyOnClusterDeletion;
|
|
33140
33437
|
}
|
|
33141
33438
|
|
|
33439
|
+
if (!Util.isUnset(request.burstingEnabled)) {
|
|
33440
|
+
query["BurstingEnabled"] = request.burstingEnabled;
|
|
33441
|
+
}
|
|
33442
|
+
|
|
33142
33443
|
if (!Util.isUnset(request.clientToken)) {
|
|
33143
33444
|
query["ClientToken"] = request.clientToken;
|
|
33144
33445
|
}
|
|
@@ -34012,7 +34313,7 @@ export default class Client extends OpenApi {
|
|
|
34012
34313
|
}
|
|
34013
34314
|
|
|
34014
34315
|
/**
|
|
34015
|
-
*
|
|
34316
|
+
* Creates or obtains a virtual license order.
|
|
34016
34317
|
*
|
|
34017
34318
|
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
34018
34319
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -34059,7 +34360,7 @@ export default class Client extends OpenApi {
|
|
|
34059
34360
|
}
|
|
34060
34361
|
|
|
34061
34362
|
/**
|
|
34062
|
-
*
|
|
34363
|
+
* Creates or obtains a virtual license order.
|
|
34063
34364
|
*
|
|
34064
34365
|
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
34065
34366
|
* @returns CreateOrGetVirtualLicenseOrderResponse
|
|
@@ -35268,7 +35569,7 @@ export default class Client extends OpenApi {
|
|
|
35268
35569
|
}
|
|
35269
35570
|
|
|
35270
35571
|
/**
|
|
35271
|
-
*
|
|
35572
|
+
* Queries a list of activation codes.
|
|
35272
35573
|
*
|
|
35273
35574
|
* @param request - DescribeActivationCodesRequest
|
|
35274
35575
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -35323,7 +35624,7 @@ export default class Client extends OpenApi {
|
|
|
35323
35624
|
}
|
|
35324
35625
|
|
|
35325
35626
|
/**
|
|
35326
|
-
*
|
|
35627
|
+
* Queries a list of activation codes.
|
|
35327
35628
|
*
|
|
35328
35629
|
* @param request - DescribeActivationCodesRequest
|
|
35329
35630
|
* @returns DescribeActivationCodesResponse
|
|
@@ -36228,11 +36529,10 @@ export default class Client extends OpenApi {
|
|
|
36228
36529
|
}
|
|
36229
36530
|
|
|
36230
36531
|
/**
|
|
36231
|
-
*
|
|
36532
|
+
* The ID of the synchronous task.
|
|
36232
36533
|
*
|
|
36233
36534
|
* @remarks
|
|
36234
|
-
*
|
|
36235
|
-
* * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
|
|
36535
|
+
* The ID of the request.
|
|
36236
36536
|
*
|
|
36237
36537
|
* @param request - DescribeDBClusterMigrationRequest
|
|
36238
36538
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -36279,11 +36579,10 @@ export default class Client extends OpenApi {
|
|
|
36279
36579
|
}
|
|
36280
36580
|
|
|
36281
36581
|
/**
|
|
36282
|
-
*
|
|
36582
|
+
* The ID of the synchronous task.
|
|
36283
36583
|
*
|
|
36284
36584
|
* @remarks
|
|
36285
|
-
*
|
|
36286
|
-
* * Before you call this operation, make sure that a one-click upgrade task has been created for the cluster. You can call the [CreateDBCluster](https://help.aliyun.com/document_detail/98169.html) operation to create an upgrade task. Set the **CreationOption** parameter to **MigrationFromRDS**.
|
|
36585
|
+
* The ID of the request.
|
|
36287
36586
|
*
|
|
36288
36587
|
* @param request - DescribeDBClusterMigrationRequest
|
|
36289
36588
|
* @returns DescribeDBClusterMigrationResponse
|
|
@@ -37886,7 +38185,7 @@ export default class Client extends OpenApi {
|
|
|
37886
38185
|
}
|
|
37887
38186
|
|
|
37888
38187
|
/**
|
|
37889
|
-
*
|
|
38188
|
+
* Queries a list of license orders.
|
|
37890
38189
|
*
|
|
37891
38190
|
* @param request - DescribeLicenseOrdersRequest
|
|
37892
38191
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -37953,7 +38252,7 @@ export default class Client extends OpenApi {
|
|
|
37953
38252
|
}
|
|
37954
38253
|
|
|
37955
38254
|
/**
|
|
37956
|
-
*
|
|
38255
|
+
* Queries a list of license orders.
|
|
37957
38256
|
*
|
|
37958
38257
|
* @param request - DescribeLicenseOrdersRequest
|
|
37959
38258
|
* @returns DescribeLicenseOrdersResponse
|
|
@@ -43186,7 +43485,7 @@ export default class Client extends OpenApi {
|
|
|
43186
43485
|
}
|
|
43187
43486
|
|
|
43188
43487
|
/**
|
|
43189
|
-
* Temporarily changes the node configurations
|
|
43488
|
+
* Temporarily changes the node configurations.
|
|
43190
43489
|
*
|
|
43191
43490
|
* @param request - TempModifyDBNodeRequest
|
|
43192
43491
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -43253,7 +43552,7 @@ export default class Client extends OpenApi {
|
|
|
43253
43552
|
}
|
|
43254
43553
|
|
|
43255
43554
|
/**
|
|
43256
|
-
* Temporarily changes the node configurations
|
|
43555
|
+
* Temporarily changes the node configurations.
|
|
43257
43556
|
*
|
|
43258
43557
|
* @param request - TempModifyDBNodeRequest
|
|
43259
43558
|
* @returns TempModifyDBNodeResponse
|