@alicloud/polardb20170801 5.2.0 → 5.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +439 -155
- package/dist/client.js +31 -16
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +457 -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,11 @@ 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
|
+
*/
|
|
5734
|
+
accountName?: string;
|
|
5634
5735
|
/**
|
|
5635
5736
|
* @remarks
|
|
5636
5737
|
* The cluster ID.
|
|
@@ -5649,10 +5750,10 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5649
5750
|
requestId?: string;
|
|
5650
5751
|
/**
|
|
5651
5752
|
* @remarks
|
|
5652
|
-
* The
|
|
5753
|
+
* The status of the PolarDB for AI feature. Valid values:
|
|
5653
5754
|
*
|
|
5654
|
-
* * **1**:
|
|
5655
|
-
* * **2**:
|
|
5755
|
+
* * **1**: enabled.
|
|
5756
|
+
* * **2**: disabled.
|
|
5656
5757
|
*
|
|
5657
5758
|
* @example
|
|
5658
5759
|
* 1
|
|
@@ -5660,7 +5761,7 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5660
5761
|
status?: string;
|
|
5661
5762
|
/**
|
|
5662
5763
|
* @remarks
|
|
5663
|
-
* The
|
|
5764
|
+
* The description of the status of the PolarDB for AI feature.
|
|
5664
5765
|
*
|
|
5665
5766
|
* @example
|
|
5666
5767
|
* Closed State
|
|
@@ -5668,6 +5769,7 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5668
5769
|
statusName?: string;
|
|
5669
5770
|
static names(): { [key: string]: string } {
|
|
5670
5771
|
return {
|
|
5772
|
+
accountName: 'AccountName',
|
|
5671
5773
|
DBClusterId: 'DBClusterId',
|
|
5672
5774
|
requestId: 'RequestId',
|
|
5673
5775
|
status: 'Status',
|
|
@@ -5677,6 +5779,7 @@ export class DescribeAITaskStatusResponseBody extends $tea.Model {
|
|
|
5677
5779
|
|
|
5678
5780
|
static types(): { [key: string]: any } {
|
|
5679
5781
|
return {
|
|
5782
|
+
accountName: 'string',
|
|
5680
5783
|
DBClusterId: 'string',
|
|
5681
5784
|
requestId: 'string',
|
|
5682
5785
|
status: 'string',
|
|
@@ -6037,6 +6140,8 @@ export class DescribeActivationCodeDetailsResponse extends $tea.Model {
|
|
|
6037
6140
|
export class DescribeActivationCodesRequest extends $tea.Model {
|
|
6038
6141
|
/**
|
|
6039
6142
|
* @remarks
|
|
6143
|
+
* The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
|
|
6144
|
+
*
|
|
6040
6145
|
* This parameter is required.
|
|
6041
6146
|
*
|
|
6042
6147
|
* @example
|
|
@@ -6046,11 +6151,17 @@ export class DescribeActivationCodesRequest extends $tea.Model {
|
|
|
6046
6151
|
ownerAccount?: string;
|
|
6047
6152
|
ownerId?: number;
|
|
6048
6153
|
/**
|
|
6154
|
+
* @remarks
|
|
6155
|
+
* The page number.
|
|
6156
|
+
*
|
|
6049
6157
|
* @example
|
|
6050
6158
|
* 1
|
|
6051
6159
|
*/
|
|
6052
6160
|
pageNumber?: number;
|
|
6053
6161
|
/**
|
|
6162
|
+
* @remarks
|
|
6163
|
+
* The number of entries per page.
|
|
6164
|
+
*
|
|
6054
6165
|
* @example
|
|
6055
6166
|
* 30
|
|
6056
6167
|
*/
|
|
@@ -6087,26 +6198,39 @@ export class DescribeActivationCodesRequest extends $tea.Model {
|
|
|
6087
6198
|
}
|
|
6088
6199
|
|
|
6089
6200
|
export class DescribeActivationCodesResponseBody extends $tea.Model {
|
|
6201
|
+
/**
|
|
6202
|
+
* @remarks
|
|
6203
|
+
* The queried activation codes.
|
|
6204
|
+
*/
|
|
6090
6205
|
items?: DescribeActivationCodesResponseBodyItems[];
|
|
6091
6206
|
/**
|
|
6207
|
+
* @remarks
|
|
6208
|
+
* The page number.
|
|
6209
|
+
*
|
|
6092
6210
|
* @example
|
|
6093
6211
|
* 1
|
|
6094
6212
|
*/
|
|
6095
6213
|
pageNumber?: number;
|
|
6096
6214
|
/**
|
|
6215
|
+
* @remarks
|
|
6216
|
+
* The number of entries returned on the current page.
|
|
6217
|
+
*
|
|
6097
6218
|
* @example
|
|
6098
6219
|
* 1
|
|
6099
6220
|
*/
|
|
6100
6221
|
pageRecordCount?: number;
|
|
6101
6222
|
/**
|
|
6102
6223
|
* @remarks
|
|
6103
|
-
*
|
|
6224
|
+
* The request ID.
|
|
6104
6225
|
*
|
|
6105
6226
|
* @example
|
|
6106
6227
|
* 65D7ACE6-4A61-4B6E-B357-8CB24A******
|
|
6107
6228
|
*/
|
|
6108
6229
|
requestId?: string;
|
|
6109
6230
|
/**
|
|
6231
|
+
* @remarks
|
|
6232
|
+
* The total number of entries returned.
|
|
6233
|
+
*
|
|
6110
6234
|
* @example
|
|
6111
6235
|
* 1
|
|
6112
6236
|
*/
|
|
@@ -6174,7 +6298,7 @@ export class DescribeAutoRenewAttributeRequest extends $tea.Model {
|
|
|
6174
6298
|
ownerId?: number;
|
|
6175
6299
|
/**
|
|
6176
6300
|
* @remarks
|
|
6177
|
-
* 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.
|
|
6178
6302
|
*
|
|
6179
6303
|
* @example
|
|
6180
6304
|
* 1
|
|
@@ -6182,7 +6306,7 @@ export class DescribeAutoRenewAttributeRequest extends $tea.Model {
|
|
|
6182
6306
|
pageNumber?: number;
|
|
6183
6307
|
/**
|
|
6184
6308
|
* @remarks
|
|
6185
|
-
* The number of entries
|
|
6309
|
+
* The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.
|
|
6186
6310
|
*
|
|
6187
6311
|
* @example
|
|
6188
6312
|
* 30
|
|
@@ -7098,6 +7222,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7098
7222
|
* 24A1990B-4F6E-482B-B8CB-75C612******
|
|
7099
7223
|
*/
|
|
7100
7224
|
requestId?: string;
|
|
7225
|
+
totalLevel2BackupSize?: string;
|
|
7101
7226
|
/**
|
|
7102
7227
|
* @remarks
|
|
7103
7228
|
* The total number of returned entries.
|
|
@@ -7112,6 +7237,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7112
7237
|
pageNumber: 'PageNumber',
|
|
7113
7238
|
pageRecordCount: 'PageRecordCount',
|
|
7114
7239
|
requestId: 'RequestId',
|
|
7240
|
+
totalLevel2BackupSize: 'TotalLevel2BackupSize',
|
|
7115
7241
|
totalRecordCount: 'TotalRecordCount',
|
|
7116
7242
|
};
|
|
7117
7243
|
}
|
|
@@ -7122,6 +7248,7 @@ export class DescribeBackupsResponseBody extends $tea.Model {
|
|
|
7122
7248
|
pageNumber: 'string',
|
|
7123
7249
|
pageRecordCount: 'string',
|
|
7124
7250
|
requestId: 'string',
|
|
7251
|
+
totalLevel2BackupSize: 'string',
|
|
7125
7252
|
totalRecordCount: 'string',
|
|
7126
7253
|
};
|
|
7127
7254
|
}
|
|
@@ -7651,6 +7778,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
7651
7778
|
* 5,242,880
|
|
7652
7779
|
*/
|
|
7653
7780
|
blktagUsed?: number;
|
|
7781
|
+
burstingEnabled?: string;
|
|
7654
7782
|
/**
|
|
7655
7783
|
* @remarks
|
|
7656
7784
|
* [Product Series](https://help.aliyun.com/document_detail/183258.html), with values as follows:
|
|
@@ -8180,6 +8308,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
8180
8308
|
architecture: 'Architecture',
|
|
8181
8309
|
blktagTotal: 'BlktagTotal',
|
|
8182
8310
|
blktagUsed: 'BlktagUsed',
|
|
8311
|
+
burstingEnabled: 'BurstingEnabled',
|
|
8183
8312
|
category: 'Category',
|
|
8184
8313
|
compressStorageMode: 'CompressStorageMode',
|
|
8185
8314
|
compressStorageUsed: 'CompressStorageUsed',
|
|
@@ -8247,6 +8376,7 @@ export class DescribeDBClusterAttributeResponseBody extends $tea.Model {
|
|
|
8247
8376
|
architecture: 'string',
|
|
8248
8377
|
blktagTotal: 'number',
|
|
8249
8378
|
blktagUsed: 'number',
|
|
8379
|
+
burstingEnabled: 'string',
|
|
8250
8380
|
category: 'string',
|
|
8251
8381
|
compressStorageMode: 'string',
|
|
8252
8382
|
compressStorageUsed: 'number',
|
|
@@ -8895,7 +9025,11 @@ export class DescribeDBClusterEndpointsResponse extends $tea.Model {
|
|
|
8895
9025
|
export class DescribeDBClusterMigrationRequest extends $tea.Model {
|
|
8896
9026
|
/**
|
|
8897
9027
|
* @remarks
|
|
8898
|
-
* 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)
|
|
8899
9033
|
*
|
|
8900
9034
|
* This parameter is required.
|
|
8901
9035
|
*
|
|
@@ -8935,7 +9069,10 @@ export class DescribeDBClusterMigrationRequest extends $tea.Model {
|
|
|
8935
9069
|
export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
8936
9070
|
/**
|
|
8937
9071
|
* @remarks
|
|
8938
|
-
* The
|
|
9072
|
+
* The mode of the source ApsaraDB RDS instance. Valid values:
|
|
9073
|
+
*
|
|
9074
|
+
* * **rw**: read and write mode
|
|
9075
|
+
* * **ro**: read-only mode
|
|
8939
9076
|
*
|
|
8940
9077
|
* @example
|
|
8941
9078
|
* test
|
|
@@ -8943,12 +9080,12 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8943
9080
|
comment?: string;
|
|
8944
9081
|
/**
|
|
8945
9082
|
* @remarks
|
|
8946
|
-
* The
|
|
9083
|
+
* The port number.
|
|
8947
9084
|
*/
|
|
8948
9085
|
DBClusterEndpointList?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointList[];
|
|
8949
9086
|
/**
|
|
8950
9087
|
* @remarks
|
|
8951
|
-
* The
|
|
9088
|
+
* The replication latency between the ApsaraDB RDS instance and the PolarDB cluster. Unit: seconds.
|
|
8952
9089
|
*
|
|
8953
9090
|
* @example
|
|
8954
9091
|
* pc-****************
|
|
@@ -8956,10 +9093,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8956
9093
|
DBClusterId?: string;
|
|
8957
9094
|
/**
|
|
8958
9095
|
* @remarks
|
|
8959
|
-
*
|
|
8960
|
-
*
|
|
8961
|
-
* * **rw**: read and write mode
|
|
8962
|
-
* * **ro**: read-only mode
|
|
9096
|
+
* Details about the endpoints.
|
|
8963
9097
|
*
|
|
8964
9098
|
* @example
|
|
8965
9099
|
* ro
|
|
@@ -8967,7 +9101,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8967
9101
|
DBClusterReadWriteMode?: string;
|
|
8968
9102
|
/**
|
|
8969
9103
|
* @remarks
|
|
8970
|
-
* The
|
|
9104
|
+
* The vSwitch ID.
|
|
8971
9105
|
*
|
|
8972
9106
|
* @example
|
|
8973
9107
|
* 0
|
|
@@ -8975,7 +9109,11 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8975
9109
|
delayedSeconds?: number;
|
|
8976
9110
|
/**
|
|
8977
9111
|
* @remarks
|
|
8978
|
-
* 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)
|
|
8979
9117
|
*
|
|
8980
9118
|
* @example
|
|
8981
9119
|
* dts**********618bs
|
|
@@ -8983,7 +9121,10 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8983
9121
|
dtsInstanceId?: string;
|
|
8984
9122
|
/**
|
|
8985
9123
|
* @remarks
|
|
8986
|
-
* The
|
|
9124
|
+
* The mode of the PolarDB cluster. Valid values:
|
|
9125
|
+
*
|
|
9126
|
+
* * **rw**: read and write mode
|
|
9127
|
+
* * **ro**: read-only mode
|
|
8987
9128
|
*
|
|
8988
9129
|
* @example
|
|
8989
9130
|
* 2020-06-17T01:56:36Z
|
|
@@ -8991,15 +9132,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
8991
9132
|
expiredTime?: string;
|
|
8992
9133
|
/**
|
|
8993
9134
|
* @remarks
|
|
8994
|
-
* The
|
|
8995
|
-
*
|
|
8996
|
-
* * **NO_MIGRATION**: No migration task is running.
|
|
8997
|
-
* * **RDS2POLARDB_CLONING**: Data is being replicated.
|
|
8998
|
-
* * **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.
|
|
8999
|
-
* * **SWITCHING**: Databases are being switched.
|
|
9000
|
-
* * **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.
|
|
9001
|
-
* * **ROLLBACK**: The migration is being rolled back. After the rollback is complete, the value **RDS2POLARDB_SYNCING** is returned.
|
|
9002
|
-
* * **CLOSING_MIGRATION**: The migration task is being terminated.
|
|
9135
|
+
* The endpoint.
|
|
9003
9136
|
*
|
|
9004
9137
|
* @example
|
|
9005
9138
|
* RDS2POLARDB_SYNCING
|
|
@@ -9007,15 +9140,12 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9007
9140
|
migrationStatus?: string;
|
|
9008
9141
|
/**
|
|
9009
9142
|
* @remarks
|
|
9010
|
-
* The
|
|
9143
|
+
* The port number.
|
|
9011
9144
|
*/
|
|
9012
9145
|
rdsEndpointList?: DescribeDBClusterMigrationResponseBodyRdsEndpointList[];
|
|
9013
9146
|
/**
|
|
9014
9147
|
* @remarks
|
|
9015
|
-
* The
|
|
9016
|
-
*
|
|
9017
|
-
* * **rw**: read and write mode
|
|
9018
|
-
* * **ro**: read-only mode
|
|
9148
|
+
* The ID of the synchronous task.
|
|
9019
9149
|
*
|
|
9020
9150
|
* @example
|
|
9021
9151
|
* rw
|
|
@@ -9023,7 +9153,7 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9023
9153
|
rdsReadWriteMode?: string;
|
|
9024
9154
|
/**
|
|
9025
9155
|
* @remarks
|
|
9026
|
-
* The ID of the
|
|
9156
|
+
* The ID of the source ApsaraDB RDS instance.
|
|
9027
9157
|
*
|
|
9028
9158
|
* @example
|
|
9029
9159
|
* F2A9EFA7-915F-4572-8299-85A307******
|
|
@@ -9031,29 +9161,28 @@ export class DescribeDBClusterMigrationResponseBody extends $tea.Model {
|
|
|
9031
9161
|
requestId?: string;
|
|
9032
9162
|
/**
|
|
9033
9163
|
* @remarks
|
|
9034
|
-
* The
|
|
9164
|
+
* The endpoints of the ApsaraDB RDS instance.
|
|
9035
9165
|
*
|
|
9036
9166
|
* @example
|
|
9037
9167
|
* rm-************
|
|
9038
9168
|
*/
|
|
9039
9169
|
sourceRDSDBInstanceId?: string;
|
|
9040
9170
|
/**
|
|
9041
|
-
* @remarks
|
|
9042
|
-
* The type of the source database. Valid values:
|
|
9043
|
-
*
|
|
9044
|
-
* * **PolarDBMySQL**: The source database is a PolarDB for MySQL database when the major version of your PolarDB cluster is upgraded.
|
|
9045
|
-
* * **RDS**: The source database is an ApsaraDB RDS database when data is migrated from ApsaraDB RDS to PolarDB for MySQL.
|
|
9046
|
-
*
|
|
9047
9171
|
* @example
|
|
9048
9172
|
* PolarDBMySQL
|
|
9049
9173
|
*/
|
|
9050
9174
|
srcDbType?: string;
|
|
9051
9175
|
/**
|
|
9052
9176
|
* @remarks
|
|
9053
|
-
* The
|
|
9177
|
+
* The migration state of the PolarDB cluster. Valid values:
|
|
9054
9178
|
*
|
|
9055
|
-
* * **
|
|
9056
|
-
* * **
|
|
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.
|
|
9057
9186
|
*
|
|
9058
9187
|
* @example
|
|
9059
9188
|
* RDS2POLARDB
|
|
@@ -11506,9 +11635,7 @@ export class DescribeDBProxyPerformanceRequest extends $tea.Model {
|
|
|
11506
11635
|
DBEndpointId?: string;
|
|
11507
11636
|
/**
|
|
11508
11637
|
* @remarks
|
|
11509
|
-
*
|
|
11510
|
-
*
|
|
11511
|
-
* > 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.
|
|
11512
11639
|
*
|
|
11513
11640
|
* @example
|
|
11514
11641
|
* pi-******************
|
|
@@ -13048,6 +13175,9 @@ export class DescribeLicenseOrderDetailsResponse extends $tea.Model {
|
|
|
13048
13175
|
|
|
13049
13176
|
export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
13050
13177
|
/**
|
|
13178
|
+
* @remarks
|
|
13179
|
+
* The ID of the Alibaba Cloud order. The value can be the ID of a virtual order.
|
|
13180
|
+
*
|
|
13051
13181
|
* @example
|
|
13052
13182
|
* 239618016570503
|
|
13053
13183
|
*/
|
|
@@ -13055,27 +13185,49 @@ export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
|
13055
13185
|
ownerAccount?: string;
|
|
13056
13186
|
ownerId?: number;
|
|
13057
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
|
+
*
|
|
13058
13197
|
* @example
|
|
13059
13198
|
* single_node_subscribe
|
|
13060
13199
|
*/
|
|
13061
13200
|
packageType?: string;
|
|
13062
13201
|
/**
|
|
13202
|
+
* @remarks
|
|
13203
|
+
* The page number.
|
|
13204
|
+
*
|
|
13063
13205
|
* @example
|
|
13064
13206
|
* 1
|
|
13065
13207
|
*/
|
|
13066
13208
|
pageNumber?: number;
|
|
13067
13209
|
/**
|
|
13210
|
+
* @remarks
|
|
13211
|
+
* The number of entries per page.
|
|
13212
|
+
*
|
|
13068
13213
|
* @example
|
|
13069
13214
|
* 30
|
|
13070
13215
|
*/
|
|
13071
13216
|
pageSize?: number;
|
|
13072
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
|
+
*
|
|
13073
13221
|
* @example
|
|
13074
13222
|
* aliyun_market
|
|
13075
13223
|
*/
|
|
13076
13224
|
purchaseChannel?: string;
|
|
13077
13225
|
resourceOwnerAccount?: string;
|
|
13078
13226
|
resourceOwnerId?: number;
|
|
13227
|
+
/**
|
|
13228
|
+
* @remarks
|
|
13229
|
+
* Specifies whether to query only virtual orders.
|
|
13230
|
+
*/
|
|
13079
13231
|
virtualOrder?: boolean;
|
|
13080
13232
|
static names(): { [key: string]: string } {
|
|
13081
13233
|
return {
|
|
@@ -13113,23 +13265,39 @@ export class DescribeLicenseOrdersRequest extends $tea.Model {
|
|
|
13113
13265
|
}
|
|
13114
13266
|
|
|
13115
13267
|
export class DescribeLicenseOrdersResponseBody extends $tea.Model {
|
|
13268
|
+
/**
|
|
13269
|
+
* @remarks
|
|
13270
|
+
* The queried orders.
|
|
13271
|
+
*/
|
|
13116
13272
|
items?: DescribeLicenseOrdersResponseBodyItems[];
|
|
13117
13273
|
/**
|
|
13274
|
+
* @remarks
|
|
13275
|
+
* The page number.
|
|
13276
|
+
*
|
|
13118
13277
|
* @example
|
|
13119
13278
|
* 1
|
|
13120
13279
|
*/
|
|
13121
13280
|
pageNumber?: number;
|
|
13122
13281
|
/**
|
|
13282
|
+
* @remarks
|
|
13283
|
+
* The number of entries returned on the current page.
|
|
13284
|
+
*
|
|
13123
13285
|
* @example
|
|
13124
13286
|
* 12
|
|
13125
13287
|
*/
|
|
13126
13288
|
pageRecordCount?: number;
|
|
13127
13289
|
/**
|
|
13290
|
+
* @remarks
|
|
13291
|
+
* The request ID.
|
|
13292
|
+
*
|
|
13128
13293
|
* @example
|
|
13129
13294
|
* 34458CD3-33E0-4624-BFEF-840C15******
|
|
13130
13295
|
*/
|
|
13131
13296
|
requestId?: string;
|
|
13132
13297
|
/**
|
|
13298
|
+
* @remarks
|
|
13299
|
+
* The total number of entries returned.
|
|
13300
|
+
*
|
|
13133
13301
|
* @example
|
|
13134
13302
|
* 50
|
|
13135
13303
|
*/
|
|
@@ -16371,9 +16539,9 @@ export class EvaluateRegionResourceRequest extends $tea.Model {
|
|
|
16371
16539
|
* @remarks
|
|
16372
16540
|
* The cluster link type. The backend randomly selects the default value. Valid values:
|
|
16373
16541
|
*
|
|
16374
|
-
* * **lvs
|
|
16375
|
-
* * **proxy**: proxy server
|
|
16376
|
-
* * **dns**: domain name system
|
|
16542
|
+
* * **lvs**: Linux virtual server.
|
|
16543
|
+
* * **proxy**: proxy server.
|
|
16544
|
+
* * **dns**: domain name system.
|
|
16377
16545
|
*
|
|
16378
16546
|
* @example
|
|
16379
16547
|
* lvs
|
|
@@ -16443,9 +16611,9 @@ export class EvaluateRegionResourceRequest extends $tea.Model {
|
|
|
16443
16611
|
dispenseMode?: string;
|
|
16444
16612
|
/**
|
|
16445
16613
|
* @remarks
|
|
16446
|
-
* Specifies whether
|
|
16614
|
+
* Specifies whether to create Maxscale. Valid values:
|
|
16447
16615
|
*
|
|
16448
|
-
* * **true**
|
|
16616
|
+
* * **true** (default)
|
|
16449
16617
|
* * **false**
|
|
16450
16618
|
*
|
|
16451
16619
|
* This parameter is required.
|
|
@@ -17938,6 +18106,22 @@ export class ModifyDBClusterRequest extends $tea.Model {
|
|
|
17938
18106
|
* 0
|
|
17939
18107
|
*/
|
|
17940
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
|
+
*/
|
|
17941
18125
|
imciAutoIndex?: string;
|
|
17942
18126
|
ownerAccount?: string;
|
|
17943
18127
|
ownerId?: number;
|
|
@@ -18761,10 +18945,10 @@ export class ModifyDBClusterDescriptionResponse extends $tea.Model {
|
|
|
18761
18945
|
export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
18762
18946
|
/**
|
|
18763
18947
|
* @remarks
|
|
18764
|
-
* Specifies whether to
|
|
18948
|
+
* Specifies whether to enable automatic association of newly added nodes with the cluster endpoint. Valid values:
|
|
18765
18949
|
*
|
|
18766
|
-
* * **Enable
|
|
18767
|
-
* * **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.
|
|
18768
18952
|
*
|
|
18769
18953
|
* @example
|
|
18770
18954
|
* Enable
|
|
@@ -18800,60 +18984,74 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18800
18984
|
DBEndpointId?: string;
|
|
18801
18985
|
/**
|
|
18802
18986
|
* @remarks
|
|
18803
|
-
* 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.
|
|
18804
18988
|
*
|
|
18805
|
-
* *
|
|
18989
|
+
* * The load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
|
|
18806
18990
|
*
|
|
18807
|
-
* * **0
|
|
18991
|
+
* * **0** (default): connections-based load balancing
|
|
18808
18992
|
* * **1**: active requests-based load balancing
|
|
18809
18993
|
*
|
|
18810
|
-
* * 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:
|
|
18811
18995
|
*
|
|
18812
|
-
* * **on**
|
|
18813
|
-
* * **off
|
|
18996
|
+
* * **on** (default): allows the primary node to accept read requests.
|
|
18997
|
+
* * **off**: does not allow the primary node to accept read requests.
|
|
18814
18998
|
*
|
|
18815
|
-
* * 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:
|
|
18816
19000
|
*
|
|
18817
|
-
* * **on**
|
|
18818
|
-
* * **off
|
|
19001
|
+
* * **on** (default): enables the transaction splitting feature.
|
|
19002
|
+
* * **off**: disables the transaction splitting feature.
|
|
18819
19003
|
*
|
|
18820
|
-
* *
|
|
19004
|
+
* * The consistency level. Format: `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
|
|
18821
19005
|
*
|
|
18822
19006
|
* * **0**: eventual consistency (weak)
|
|
18823
|
-
* * **1
|
|
19007
|
+
* * **1** (default): session consistency (medium)
|
|
18824
19008
|
* * **2**: global consistency (strong)
|
|
18825
19009
|
*
|
|
18826
|
-
* *
|
|
19010
|
+
* * The global consistency timeout. Format: `{\\"ConsistTimeout\\":\\"Global consistency timeout\\"}`. Valid values: 0 to 60,000. Default value: 20. Unit: ms.
|
|
18827
19011
|
*
|
|
18828
|
-
*
|
|
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.
|
|
18829
19022
|
* * **Session**: enables the session-level connection pool.
|
|
18830
19023
|
* * **Transaction**: enables the transaction-level connection pool.
|
|
18831
19024
|
*
|
|
18832
|
-
* * 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:
|
|
18833
19026
|
*
|
|
18834
|
-
* * **on
|
|
18835
|
-
* * **off**
|
|
19027
|
+
* * **on**: enables the parallel query feature.
|
|
19028
|
+
* * **off** (default): disables the parallel query feature.
|
|
18836
19029
|
*
|
|
18837
|
-
* * 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:
|
|
18838
19031
|
*
|
|
18839
|
-
* * **on
|
|
18840
|
-
* * **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.
|
|
18841
19034
|
*
|
|
18842
|
-
* * 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:
|
|
18843
19036
|
*
|
|
18844
|
-
* * **on
|
|
18845
|
-
* * **off**
|
|
19037
|
+
* * **on**: enables the overload protection feature.
|
|
19038
|
+
* * **off** (default): disables the overload protection feature.
|
|
18846
19039
|
*
|
|
18847
19040
|
* >
|
|
18848
19041
|
*
|
|
18849
|
-
* * 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**.
|
|
18850
19047
|
*
|
|
18851
|
-
* * 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.
|
|
18852
|
-
* * 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.
|
|
18853
19048
|
* * Only PolarDB for MySQL supports global consistency.
|
|
18854
|
-
*
|
|
18855
|
-
* * You can
|
|
18856
|
-
*
|
|
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.
|
|
18857
19055
|
*
|
|
18858
19056
|
* @example
|
|
18859
19057
|
* {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
|
|
@@ -18882,7 +19080,24 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18882
19080
|
nodes?: string;
|
|
18883
19081
|
ownerAccount?: string;
|
|
18884
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
|
+
*/
|
|
18885
19093
|
polarSccTimeoutAction?: string;
|
|
19094
|
+
/**
|
|
19095
|
+
* @remarks
|
|
19096
|
+
* Global consistency timeout.
|
|
19097
|
+
*
|
|
19098
|
+
* @example
|
|
19099
|
+
* 100
|
|
19100
|
+
*/
|
|
18886
19101
|
polarSccWaitTimeout?: string;
|
|
18887
19102
|
/**
|
|
18888
19103
|
* @remarks
|
|
@@ -18897,6 +19112,21 @@ export class ModifyDBClusterEndpointRequest extends $tea.Model {
|
|
|
18897
19112
|
readWriteMode?: string;
|
|
18898
19113
|
resourceOwnerAccount?: string;
|
|
18899
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
|
+
*/
|
|
18900
19130
|
sccMode?: string;
|
|
18901
19131
|
static names(): { [key: string]: string } {
|
|
18902
19132
|
return {
|
|
@@ -24476,8 +24706,11 @@ export class UpgradeDBClusterVersionRequest extends $tea.Model {
|
|
|
24476
24706
|
* @remarks
|
|
24477
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.
|
|
24478
24708
|
*
|
|
24479
|
-
* >
|
|
24480
|
-
*
|
|
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.
|
|
24481
24714
|
*
|
|
24482
24715
|
* @example
|
|
24483
24716
|
* 2021-01-14T09:00:00Z
|
|
@@ -25032,46 +25265,73 @@ export class DescribeAccountsResponseBodyAccounts extends $tea.Model {
|
|
|
25032
25265
|
|
|
25033
25266
|
export class DescribeActivationCodesResponseBodyItems extends $tea.Model {
|
|
25034
25267
|
/**
|
|
25268
|
+
* @remarks
|
|
25269
|
+
* The time when the activation code takes effect.
|
|
25270
|
+
*
|
|
25035
25271
|
* @example
|
|
25036
25272
|
* 2024-10-16 16:46:20
|
|
25037
25273
|
*/
|
|
25038
25274
|
activateAt?: string;
|
|
25039
25275
|
/**
|
|
25276
|
+
* @remarks
|
|
25277
|
+
* The description of the activation code.
|
|
25278
|
+
*
|
|
25040
25279
|
* @example
|
|
25041
25280
|
* testCode
|
|
25042
25281
|
*/
|
|
25043
25282
|
description?: string;
|
|
25044
25283
|
/**
|
|
25284
|
+
* @remarks
|
|
25285
|
+
* The time when the activation code expires.
|
|
25286
|
+
*
|
|
25045
25287
|
* @example
|
|
25046
25288
|
* 2054-10-16 16:46:20
|
|
25047
25289
|
*/
|
|
25048
25290
|
expireAt?: string;
|
|
25049
25291
|
/**
|
|
25292
|
+
* @remarks
|
|
25293
|
+
* The time when the activation code was generated.
|
|
25294
|
+
*
|
|
25050
25295
|
* @example
|
|
25051
25296
|
* 2024-10-16 16:46:20
|
|
25052
25297
|
*/
|
|
25053
25298
|
gmtCreated?: string;
|
|
25054
25299
|
/**
|
|
25300
|
+
* @remarks
|
|
25301
|
+
* The time when the activation code was updated.
|
|
25302
|
+
*
|
|
25055
25303
|
* @example
|
|
25056
25304
|
* 2024-10-16 16:46:20
|
|
25057
25305
|
*/
|
|
25058
25306
|
gmtModified?: string;
|
|
25059
25307
|
/**
|
|
25308
|
+
* @remarks
|
|
25309
|
+
* The activation code ID.
|
|
25310
|
+
*
|
|
25060
25311
|
* @example
|
|
25061
25312
|
* 123
|
|
25062
25313
|
*/
|
|
25063
25314
|
id?: number;
|
|
25064
25315
|
/**
|
|
25316
|
+
* @remarks
|
|
25317
|
+
* The media access control (MAC) address used in the generation of the activation code.
|
|
25318
|
+
*
|
|
25065
25319
|
* @example
|
|
25066
25320
|
* 12:34:56:78:98:00
|
|
25067
25321
|
*/
|
|
25068
25322
|
macAddress?: string;
|
|
25069
25323
|
/**
|
|
25324
|
+
* @remarks
|
|
25325
|
+
* The name of the activation code.
|
|
25326
|
+
*
|
|
25070
25327
|
* @example
|
|
25071
25328
|
* testName
|
|
25072
25329
|
*/
|
|
25073
25330
|
name?: string;
|
|
25074
25331
|
/**
|
|
25332
|
+
* @remarks
|
|
25333
|
+
* The unique identifier of the database.
|
|
25334
|
+
*
|
|
25075
25335
|
* @example
|
|
25076
25336
|
* 1234567890123456
|
|
25077
25337
|
*/
|
|
@@ -25710,6 +25970,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25710
25970
|
* 8
|
|
25711
25971
|
*/
|
|
25712
25972
|
cpu?: string;
|
|
25973
|
+
essdMaxStorageCapacity?: string;
|
|
25713
25974
|
/**
|
|
25714
25975
|
* @remarks
|
|
25715
25976
|
* The maximum number of concurrent connections in the cluster.
|
|
@@ -25766,6 +26027,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25766
26027
|
* 1000000
|
|
25767
26028
|
*/
|
|
25768
26029
|
pl3MaxIOPS?: string;
|
|
26030
|
+
polarStoreMaxStorageCapacity?: string;
|
|
25769
26031
|
/**
|
|
25770
26032
|
* @remarks
|
|
25771
26033
|
* The maximum Input/output operations per second (IOPS) for PolarStore Level 4 (PSL4). Unit: operations per second.
|
|
@@ -25814,6 +26076,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25814
26076
|
classGroup: 'ClassGroup',
|
|
25815
26077
|
classTypeLevel: 'ClassTypeLevel',
|
|
25816
26078
|
cpu: 'Cpu',
|
|
26079
|
+
essdMaxStorageCapacity: 'EssdMaxStorageCapacity',
|
|
25817
26080
|
maxConnections: 'MaxConnections',
|
|
25818
26081
|
maxIOPS: 'MaxIOPS',
|
|
25819
26082
|
maxStorageCapacity: 'MaxStorageCapacity',
|
|
@@ -25821,6 +26084,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25821
26084
|
pl1MaxIOPS: 'Pl1MaxIOPS',
|
|
25822
26085
|
pl2MaxIOPS: 'Pl2MaxIOPS',
|
|
25823
26086
|
pl3MaxIOPS: 'Pl3MaxIOPS',
|
|
26087
|
+
polarStoreMaxStorageCapacity: 'PolarStoreMaxStorageCapacity',
|
|
25824
26088
|
psl4MaxIOPS: 'Psl4MaxIOPS',
|
|
25825
26089
|
psl5MaxIOPS: 'Psl5MaxIOPS',
|
|
25826
26090
|
referenceExtPrice: 'ReferenceExtPrice',
|
|
@@ -25834,6 +26098,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25834
26098
|
classGroup: 'string',
|
|
25835
26099
|
classTypeLevel: 'string',
|
|
25836
26100
|
cpu: 'string',
|
|
26101
|
+
essdMaxStorageCapacity: 'string',
|
|
25837
26102
|
maxConnections: 'string',
|
|
25838
26103
|
maxIOPS: 'string',
|
|
25839
26104
|
maxStorageCapacity: 'string',
|
|
@@ -25841,6 +26106,7 @@ export class DescribeClassListResponseBodyItems extends $tea.Model {
|
|
|
25841
26106
|
pl1MaxIOPS: 'string',
|
|
25842
26107
|
pl2MaxIOPS: 'string',
|
|
25843
26108
|
pl3MaxIOPS: 'string',
|
|
26109
|
+
polarStoreMaxStorageCapacity: 'string',
|
|
25844
26110
|
psl4MaxIOPS: 'string',
|
|
25845
26111
|
psl5MaxIOPS: 'string',
|
|
25846
26112
|
referenceExtPrice: 'string',
|
|
@@ -26021,6 +26287,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26021
26287
|
* polar.mysql.x4.large
|
|
26022
26288
|
*/
|
|
26023
26289
|
DBNodeClass?: string;
|
|
26290
|
+
DBNodeDescription?: string;
|
|
26024
26291
|
/**
|
|
26025
26292
|
* @remarks
|
|
26026
26293
|
* Node ID.
|
|
@@ -26213,6 +26480,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26213
26480
|
cpuCores: 'CpuCores',
|
|
26214
26481
|
creationTime: 'CreationTime',
|
|
26215
26482
|
DBNodeClass: 'DBNodeClass',
|
|
26483
|
+
DBNodeDescription: 'DBNodeDescription',
|
|
26216
26484
|
DBNodeId: 'DBNodeId',
|
|
26217
26485
|
DBNodeRole: 'DBNodeRole',
|
|
26218
26486
|
DBNodeStatus: 'DBNodeStatus',
|
|
@@ -26242,6 +26510,7 @@ export class DescribeDBClusterAttributeResponseBodyDBNodes extends $tea.Model {
|
|
|
26242
26510
|
cpuCores: 'string',
|
|
26243
26511
|
creationTime: 'string',
|
|
26244
26512
|
DBNodeClass: 'string',
|
|
26513
|
+
DBNodeDescription: 'string',
|
|
26245
26514
|
DBNodeId: 'string',
|
|
26246
26515
|
DBNodeRole: 'string',
|
|
26247
26516
|
DBNodeStatus: 'string',
|
|
@@ -26683,7 +26952,10 @@ export class DescribeDBClusterEndpointsResponseBodyItems extends $tea.Model {
|
|
|
26683
26952
|
export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems extends $tea.Model {
|
|
26684
26953
|
/**
|
|
26685
26954
|
* @remarks
|
|
26686
|
-
*
|
|
26955
|
+
* Indicates whether SSL encryption is enabled. Valid values:
|
|
26956
|
+
*
|
|
26957
|
+
* * **Enabled**
|
|
26958
|
+
* * **Disabled**
|
|
26687
26959
|
*
|
|
26688
26960
|
* @example
|
|
26689
26961
|
* pc-**************.rwlb.rds.aliyuncs.com
|
|
@@ -26691,7 +26963,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26691
26963
|
connectionString?: string;
|
|
26692
26964
|
/**
|
|
26693
26965
|
* @remarks
|
|
26694
|
-
* The
|
|
26966
|
+
* The description of a migration exception. If no exception occurs during the migration, an empty string is returned.
|
|
26695
26967
|
*
|
|
26696
26968
|
* @example
|
|
26697
26969
|
* 192.***.***.10
|
|
@@ -26699,11 +26971,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26699
26971
|
IPAddress?: string;
|
|
26700
26972
|
/**
|
|
26701
26973
|
* @remarks
|
|
26702
|
-
* The
|
|
26703
|
-
*
|
|
26704
|
-
* * **Public**: the public endpoint
|
|
26705
|
-
* * **Private**: the internal endpoint (VPC)
|
|
26706
|
-
* * **Inner**: the internal endpoint (classic network)
|
|
26974
|
+
* The ID of the endpoint.
|
|
26707
26975
|
*
|
|
26708
26976
|
* @example
|
|
26709
26977
|
* Private
|
|
@@ -26711,7 +26979,11 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26711
26979
|
netType?: string;
|
|
26712
26980
|
/**
|
|
26713
26981
|
* @remarks
|
|
26714
|
-
* 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
|
|
26715
26987
|
*
|
|
26716
26988
|
* @example
|
|
26717
26989
|
* 3306
|
|
@@ -26719,10 +26991,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26719
26991
|
port?: string;
|
|
26720
26992
|
/**
|
|
26721
26993
|
* @remarks
|
|
26722
|
-
*
|
|
26723
|
-
*
|
|
26724
|
-
* * **Enabled**
|
|
26725
|
-
* * **Disabled**
|
|
26994
|
+
* The ID of the request.
|
|
26726
26995
|
*
|
|
26727
26996
|
* @example
|
|
26728
26997
|
* Enabled
|
|
@@ -26730,7 +26999,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26730
26999
|
SSLEnabled?: string;
|
|
26731
27000
|
/**
|
|
26732
27001
|
* @remarks
|
|
26733
|
-
* 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.
|
|
26734
27006
|
*
|
|
26735
27007
|
* @example
|
|
26736
27008
|
* vpc-**********
|
|
@@ -26738,7 +27010,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26738
27010
|
VPCId?: string;
|
|
26739
27011
|
/**
|
|
26740
27012
|
* @remarks
|
|
26741
|
-
* The
|
|
27013
|
+
* The IP address of the endpoint.
|
|
26742
27014
|
*
|
|
26743
27015
|
* @example
|
|
26744
27016
|
* vsw-**********
|
|
@@ -26776,12 +27048,12 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressI
|
|
|
26776
27048
|
export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends $tea.Model {
|
|
26777
27049
|
/**
|
|
26778
27050
|
* @remarks
|
|
26779
|
-
*
|
|
27051
|
+
* The VPC ID.
|
|
26780
27052
|
*/
|
|
26781
27053
|
addressItems?: DescribeDBClusterMigrationResponseBodyDBClusterEndpointListAddressItems[];
|
|
26782
27054
|
/**
|
|
26783
27055
|
* @remarks
|
|
26784
|
-
* 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.
|
|
26785
27057
|
*
|
|
26786
27058
|
* @example
|
|
26787
27059
|
* pe-***********
|
|
@@ -26789,11 +27061,7 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26789
27061
|
DBEndpointId?: string;
|
|
26790
27062
|
/**
|
|
26791
27063
|
* @remarks
|
|
26792
|
-
* The
|
|
26793
|
-
*
|
|
26794
|
-
* * **Cluster**: the default cluster endpoint
|
|
26795
|
-
* * **Primary**: the primary endpoint
|
|
26796
|
-
* * **Custom**: the custom endpoint
|
|
27064
|
+
* The ID of the cluster.
|
|
26797
27065
|
*
|
|
26798
27066
|
* @example
|
|
26799
27067
|
* Cluster
|
|
@@ -26801,10 +27069,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26801
27069
|
endpointType?: string;
|
|
26802
27070
|
/**
|
|
26803
27071
|
* @remarks
|
|
26804
|
-
* The
|
|
27072
|
+
* The synchronization direction. Valid values:
|
|
26805
27073
|
*
|
|
26806
|
-
* *
|
|
26807
|
-
* *
|
|
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.
|
|
26808
27076
|
*
|
|
26809
27077
|
* @example
|
|
26810
27078
|
* ReadOnly
|
|
@@ -26836,7 +27104,10 @@ export class DescribeDBClusterMigrationResponseBodyDBClusterEndpointList extends
|
|
|
26836
27104
|
export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems extends $tea.Model {
|
|
26837
27105
|
/**
|
|
26838
27106
|
* @remarks
|
|
26839
|
-
*
|
|
27107
|
+
* Indicates whether SSL encryption is enabled. Valid values:
|
|
27108
|
+
*
|
|
27109
|
+
* * **Enabled**
|
|
27110
|
+
* * **Disabled**
|
|
26840
27111
|
*
|
|
26841
27112
|
* @example
|
|
26842
27113
|
* rm-***********.mysql.rds.aliyuncs.com
|
|
@@ -26844,7 +27115,10 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26844
27115
|
connectionString?: string;
|
|
26845
27116
|
/**
|
|
26846
27117
|
* @remarks
|
|
26847
|
-
* 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.
|
|
26848
27122
|
*
|
|
26849
27123
|
* @example
|
|
26850
27124
|
* 172.***.***.173
|
|
@@ -26852,11 +27126,7 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26852
27126
|
IPAddress?: string;
|
|
26853
27127
|
/**
|
|
26854
27128
|
* @remarks
|
|
26855
|
-
* The
|
|
26856
|
-
*
|
|
26857
|
-
* * **Public**: the public endpoint
|
|
26858
|
-
* * **Private**: the internal endpoint (VPC)
|
|
26859
|
-
* * **Inner**: the internal endpoint (classic network)
|
|
27129
|
+
* The ID of the endpoint.
|
|
26860
27130
|
*
|
|
26861
27131
|
* @example
|
|
26862
27132
|
* Private
|
|
@@ -26864,26 +27134,23 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26864
27134
|
netType?: string;
|
|
26865
27135
|
/**
|
|
26866
27136
|
* @remarks
|
|
26867
|
-
* The
|
|
27137
|
+
* The type of the endpoint. Valid values:
|
|
27138
|
+
*
|
|
27139
|
+
* * **Normal**: the standard endpoint
|
|
27140
|
+
* * **ReadWriteSplitting**: the read/write splitting endpoint
|
|
26868
27141
|
*
|
|
26869
27142
|
* @example
|
|
26870
27143
|
* 3306
|
|
26871
27144
|
*/
|
|
26872
27145
|
port?: string;
|
|
26873
27146
|
/**
|
|
26874
|
-
* @remarks
|
|
26875
|
-
* Indicates whether SSL encryption is enabled. Valid values:
|
|
26876
|
-
*
|
|
26877
|
-
* * **Enabled**
|
|
26878
|
-
* * **Disabled**
|
|
26879
|
-
*
|
|
26880
27147
|
* @example
|
|
26881
27148
|
* Enabled
|
|
26882
27149
|
*/
|
|
26883
27150
|
SSLEnabled?: string;
|
|
26884
27151
|
/**
|
|
26885
27152
|
* @remarks
|
|
26886
|
-
* The
|
|
27153
|
+
* The instance type.
|
|
26887
27154
|
*
|
|
26888
27155
|
* @example
|
|
26889
27156
|
* vpc-************
|
|
@@ -26891,7 +27158,7 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26891
27158
|
VPCId?: string;
|
|
26892
27159
|
/**
|
|
26893
27160
|
* @remarks
|
|
26894
|
-
* The
|
|
27161
|
+
* The IP address of the endpoint.
|
|
26895
27162
|
*
|
|
26896
27163
|
* @example
|
|
26897
27164
|
* vsw-**************
|
|
@@ -26929,13 +27196,10 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems e
|
|
|
26929
27196
|
export class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.Model {
|
|
26930
27197
|
/**
|
|
26931
27198
|
* @remarks
|
|
26932
|
-
*
|
|
27199
|
+
* The VPC ID.
|
|
26933
27200
|
*/
|
|
26934
27201
|
addressItems?: DescribeDBClusterMigrationResponseBodyRdsEndpointListAddressItems[];
|
|
26935
27202
|
/**
|
|
26936
|
-
* @remarks
|
|
26937
|
-
* The role of the source database instance.
|
|
26938
|
-
*
|
|
26939
27203
|
* @example
|
|
26940
27204
|
* ReadOnly
|
|
26941
27205
|
* Maxscale
|
|
@@ -26943,20 +27207,11 @@ export class DescribeDBClusterMigrationResponseBodyRdsEndpointList extends $tea.
|
|
|
26943
27207
|
*/
|
|
26944
27208
|
custinsType?: string;
|
|
26945
27209
|
/**
|
|
26946
|
-
* @remarks
|
|
26947
|
-
* The ID of the endpoint.
|
|
26948
|
-
*
|
|
26949
27210
|
* @example
|
|
26950
27211
|
* rm-************-normal
|
|
26951
27212
|
*/
|
|
26952
27213
|
DBEndpointId?: string;
|
|
26953
27214
|
/**
|
|
26954
|
-
* @remarks
|
|
26955
|
-
* The type of the endpoint. Valid values:
|
|
26956
|
-
*
|
|
26957
|
-
* * **Normal**: the standard endpoint
|
|
26958
|
-
* * **ReadWriteSplitting**: the read/write splitting endpoint
|
|
26959
|
-
*
|
|
26960
27215
|
* @example
|
|
26961
27216
|
* Normal
|
|
26962
27217
|
*/
|
|
@@ -30152,66 +30407,111 @@ export class DescribeGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGr
|
|
|
30152
30407
|
|
|
30153
30408
|
export class DescribeLicenseOrdersResponseBodyItems extends $tea.Model {
|
|
30154
30409
|
/**
|
|
30410
|
+
* @remarks
|
|
30411
|
+
* The number of generated activation codes.
|
|
30412
|
+
*
|
|
30155
30413
|
* @example
|
|
30156
30414
|
* 10
|
|
30157
30415
|
*/
|
|
30158
30416
|
activatedCodeCount?: number;
|
|
30159
30417
|
/**
|
|
30418
|
+
* @remarks
|
|
30419
|
+
* The maximum number of activation codes that you can apply for.
|
|
30420
|
+
*
|
|
30160
30421
|
* @example
|
|
30161
30422
|
* 10
|
|
30162
30423
|
*/
|
|
30163
30424
|
activationCodeQuota?: number;
|
|
30164
30425
|
/**
|
|
30426
|
+
* @remarks
|
|
30427
|
+
* The ID of the Alibaba Cloud order. The ID of a virtual order may be returned.
|
|
30428
|
+
*
|
|
30165
30429
|
* @example
|
|
30166
30430
|
* 227638319690519
|
|
30167
30431
|
*/
|
|
30168
30432
|
aliyunOrderId?: string;
|
|
30169
30433
|
/**
|
|
30434
|
+
* @remarks
|
|
30435
|
+
* Indicates whether the SystemIdentifier parameter can be left empty when the system generates an activation code.
|
|
30436
|
+
*
|
|
30170
30437
|
* @example
|
|
30171
30438
|
* false
|
|
30172
30439
|
*/
|
|
30173
30440
|
allowEmptySystemIdentifier?: boolean;
|
|
30174
30441
|
/**
|
|
30442
|
+
* @remarks
|
|
30443
|
+
* The engine of the PolarDB cluster. Valid values: PG, Oracle, and MySQL.
|
|
30444
|
+
*
|
|
30175
30445
|
* @example
|
|
30176
30446
|
* PG
|
|
30177
30447
|
*/
|
|
30178
30448
|
engine?: string;
|
|
30179
30449
|
/**
|
|
30450
|
+
* @remarks
|
|
30451
|
+
* The time when the order was created.
|
|
30452
|
+
*
|
|
30180
30453
|
* @example
|
|
30181
30454
|
* 2022-02-11 03:14:15
|
|
30182
30455
|
*/
|
|
30183
30456
|
gmtCreated?: string;
|
|
30184
30457
|
/**
|
|
30458
|
+
* @remarks
|
|
30459
|
+
* The time when the order was updated.
|
|
30460
|
+
*
|
|
30185
30461
|
* @example
|
|
30186
30462
|
* 2022-02-11 03:14:15
|
|
30187
30463
|
*/
|
|
30188
30464
|
gmtModified?: string;
|
|
30189
30465
|
/**
|
|
30466
|
+
* @remarks
|
|
30467
|
+
* Indicates whether the order is a virtual order. Pre-generation of activation codes is allowed for virtual orders.
|
|
30468
|
+
*
|
|
30190
30469
|
* @example
|
|
30191
30470
|
* false
|
|
30192
30471
|
*/
|
|
30193
30472
|
isVirtualOrder?: boolean;
|
|
30194
30473
|
/**
|
|
30474
|
+
* @remarks
|
|
30475
|
+
* Indicates whether the virtual order is frozen. Generation of activation codes is not allowed for frozen virtual orders.
|
|
30476
|
+
*
|
|
30195
30477
|
* @example
|
|
30196
30478
|
* false
|
|
30197
30479
|
*/
|
|
30198
30480
|
isVirtualOrderFrozen?: boolean;
|
|
30199
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
|
+
*
|
|
30200
30491
|
* @example
|
|
30201
30492
|
* single_node_subscribe
|
|
30202
30493
|
*/
|
|
30203
30494
|
packageType?: string;
|
|
30204
30495
|
/**
|
|
30496
|
+
* @remarks
|
|
30497
|
+
* The validity period of the package. Valid values: 1 year and 30 years.
|
|
30498
|
+
*
|
|
30205
30499
|
* @example
|
|
30206
30500
|
* 1 year
|
|
30207
30501
|
*/
|
|
30208
30502
|
packageValidity?: string;
|
|
30209
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
|
+
*
|
|
30210
30507
|
* @example
|
|
30211
30508
|
* aliyun_public
|
|
30212
30509
|
*/
|
|
30213
30510
|
purchaseChannel?: string;
|
|
30214
30511
|
/**
|
|
30512
|
+
* @remarks
|
|
30513
|
+
* The ID of the virtual order.
|
|
30514
|
+
*
|
|
30215
30515
|
* @example
|
|
30216
30516
|
* 227638319690519
|
|
30217
30517
|
*/
|
|
@@ -32893,7 +33193,7 @@ export default class Client extends OpenApi {
|
|
|
32893
33193
|
}
|
|
32894
33194
|
|
|
32895
33195
|
/**
|
|
32896
|
-
*
|
|
33196
|
+
* Generates a lightweight license activation code.
|
|
32897
33197
|
*
|
|
32898
33198
|
* @param request - CreateActivationCodeRequest
|
|
32899
33199
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -32956,7 +33256,7 @@ export default class Client extends OpenApi {
|
|
|
32956
33256
|
}
|
|
32957
33257
|
|
|
32958
33258
|
/**
|
|
32959
|
-
*
|
|
33259
|
+
* Generates a lightweight license activation code.
|
|
32960
33260
|
*
|
|
32961
33261
|
* @param request - CreateActivationCodeRequest
|
|
32962
33262
|
* @returns CreateActivationCodeResponse
|
|
@@ -33136,6 +33436,10 @@ export default class Client extends OpenApi {
|
|
|
33136
33436
|
query["BackupRetentionPolicyOnClusterDeletion"] = request.backupRetentionPolicyOnClusterDeletion;
|
|
33137
33437
|
}
|
|
33138
33438
|
|
|
33439
|
+
if (!Util.isUnset(request.burstingEnabled)) {
|
|
33440
|
+
query["BurstingEnabled"] = request.burstingEnabled;
|
|
33441
|
+
}
|
|
33442
|
+
|
|
33139
33443
|
if (!Util.isUnset(request.clientToken)) {
|
|
33140
33444
|
query["ClientToken"] = request.clientToken;
|
|
33141
33445
|
}
|
|
@@ -34009,7 +34313,7 @@ export default class Client extends OpenApi {
|
|
|
34009
34313
|
}
|
|
34010
34314
|
|
|
34011
34315
|
/**
|
|
34012
|
-
*
|
|
34316
|
+
* Creates or obtains a virtual license order.
|
|
34013
34317
|
*
|
|
34014
34318
|
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
34015
34319
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -34056,7 +34360,7 @@ export default class Client extends OpenApi {
|
|
|
34056
34360
|
}
|
|
34057
34361
|
|
|
34058
34362
|
/**
|
|
34059
|
-
*
|
|
34363
|
+
* Creates or obtains a virtual license order.
|
|
34060
34364
|
*
|
|
34061
34365
|
* @param request - CreateOrGetVirtualLicenseOrderRequest
|
|
34062
34366
|
* @returns CreateOrGetVirtualLicenseOrderResponse
|
|
@@ -35265,7 +35569,7 @@ export default class Client extends OpenApi {
|
|
|
35265
35569
|
}
|
|
35266
35570
|
|
|
35267
35571
|
/**
|
|
35268
|
-
*
|
|
35572
|
+
* Queries a list of activation codes.
|
|
35269
35573
|
*
|
|
35270
35574
|
* @param request - DescribeActivationCodesRequest
|
|
35271
35575
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -35320,7 +35624,7 @@ export default class Client extends OpenApi {
|
|
|
35320
35624
|
}
|
|
35321
35625
|
|
|
35322
35626
|
/**
|
|
35323
|
-
*
|
|
35627
|
+
* Queries a list of activation codes.
|
|
35324
35628
|
*
|
|
35325
35629
|
* @param request - DescribeActivationCodesRequest
|
|
35326
35630
|
* @returns DescribeActivationCodesResponse
|
|
@@ -36225,11 +36529,10 @@ export default class Client extends OpenApi {
|
|
|
36225
36529
|
}
|
|
36226
36530
|
|
|
36227
36531
|
/**
|
|
36228
|
-
*
|
|
36532
|
+
* The ID of the synchronous task.
|
|
36229
36533
|
*
|
|
36230
36534
|
* @remarks
|
|
36231
|
-
*
|
|
36232
|
-
* * 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.
|
|
36233
36536
|
*
|
|
36234
36537
|
* @param request - DescribeDBClusterMigrationRequest
|
|
36235
36538
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -36276,11 +36579,10 @@ export default class Client extends OpenApi {
|
|
|
36276
36579
|
}
|
|
36277
36580
|
|
|
36278
36581
|
/**
|
|
36279
|
-
*
|
|
36582
|
+
* The ID of the synchronous task.
|
|
36280
36583
|
*
|
|
36281
36584
|
* @remarks
|
|
36282
|
-
*
|
|
36283
|
-
* * 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.
|
|
36284
36586
|
*
|
|
36285
36587
|
* @param request - DescribeDBClusterMigrationRequest
|
|
36286
36588
|
* @returns DescribeDBClusterMigrationResponse
|
|
@@ -37883,7 +38185,7 @@ export default class Client extends OpenApi {
|
|
|
37883
38185
|
}
|
|
37884
38186
|
|
|
37885
38187
|
/**
|
|
37886
|
-
*
|
|
38188
|
+
* Queries a list of license orders.
|
|
37887
38189
|
*
|
|
37888
38190
|
* @param request - DescribeLicenseOrdersRequest
|
|
37889
38191
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -37950,7 +38252,7 @@ export default class Client extends OpenApi {
|
|
|
37950
38252
|
}
|
|
37951
38253
|
|
|
37952
38254
|
/**
|
|
37953
|
-
*
|
|
38255
|
+
* Queries a list of license orders.
|
|
37954
38256
|
*
|
|
37955
38257
|
* @param request - DescribeLicenseOrdersRequest
|
|
37956
38258
|
* @returns DescribeLicenseOrdersResponse
|
|
@@ -43183,7 +43485,7 @@ export default class Client extends OpenApi {
|
|
|
43183
43485
|
}
|
|
43184
43486
|
|
|
43185
43487
|
/**
|
|
43186
|
-
* Temporarily changes the node configurations
|
|
43488
|
+
* Temporarily changes the node configurations.
|
|
43187
43489
|
*
|
|
43188
43490
|
* @param request - TempModifyDBNodeRequest
|
|
43189
43491
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -43250,7 +43552,7 @@ export default class Client extends OpenApi {
|
|
|
43250
43552
|
}
|
|
43251
43553
|
|
|
43252
43554
|
/**
|
|
43253
|
-
* Temporarily changes the node configurations
|
|
43555
|
+
* Temporarily changes the node configurations.
|
|
43254
43556
|
*
|
|
43255
43557
|
* @param request - TempModifyDBNodeRequest
|
|
43256
43558
|
* @returns TempModifyDBNodeResponse
|