@alicloud/polardb20170801 7.7.0 → 7.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +37 -6
- package/dist/client.js +85 -8
- package/dist/client.js.map +1 -1
- package/dist/models/AddPolarFsPathMappingRequest.d.ts +6 -4
- package/dist/models/AddPolarFsPathMappingRequest.js +4 -0
- package/dist/models/AddPolarFsPathMappingRequest.js.map +1 -1
- package/dist/models/AddPolarFsPathMappingResponseBody.d.ts +1 -1
- package/dist/models/CreateBatchConsumerRequest.d.ts +19 -7
- package/dist/models/CreateBatchConsumerRequest.js +4 -0
- package/dist/models/CreateBatchConsumerRequest.js.map +1 -1
- package/dist/models/CreateBatchConsumerResponseBody.d.ts +90 -2
- package/dist/models/CreateBatchConsumerResponseBody.js +22 -0
- package/dist/models/CreateBatchConsumerResponseBody.js.map +1 -1
- package/dist/models/CreateDbclusterRequest.d.ts +47 -261
- package/dist/models/CreateDbclusterRequest.js.map +1 -1
- package/dist/models/CreateDbclusterResponseBody.d.ts +14 -0
- package/dist/models/CreateDbclusterResponseBody.js.map +1 -1
- package/dist/models/CreateGwConsumerOrderRequest.d.ts +76 -0
- package/dist/models/CreateGwConsumerOrderRequest.js +68 -0
- package/dist/models/CreateGwConsumerOrderRequest.js.map +1 -0
- package/dist/models/CreateGwConsumerOrderResponse.d.ts +19 -0
- package/dist/models/CreateGwConsumerOrderResponse.js +69 -0
- package/dist/models/CreateGwConsumerOrderResponse.js.map +1 -0
- package/dist/models/CreateGwConsumerOrderResponseBody.d.ts +53 -0
- package/dist/models/CreateGwConsumerOrderResponseBody.js +66 -0
- package/dist/models/CreateGwConsumerOrderResponseBody.js.map +1 -0
- package/dist/models/DescribeApplicationLogsRequest.d.ts +4 -4
- package/dist/models/DescribeApplicationPerformanceRequest.d.ts +38 -15
- package/dist/models/DescribeApplicationPerformanceRequest.js.map +1 -1
- package/dist/models/DescribeApplicationPerformanceResponseBody.d.ts +7 -4
- package/dist/models/DescribeApplicationPerformanceResponseBody.js.map +1 -1
- package/dist/models/ModifyDbclusterSslrequest.d.ts +14 -9
- package/dist/models/ModifyDbclusterSslrequest.js +2 -0
- package/dist/models/ModifyDbclusterSslrequest.js.map +1 -1
- package/dist/models/RestartPolarClawGatewayRequest.d.ts +7 -0
- package/dist/models/RestartPolarClawGatewayRequest.js.map +1 -1
- package/dist/models/RestartPolarClawGatewayResponseBody.d.ts +36 -0
- package/dist/models/RestartPolarClawGatewayResponseBody.js.map +1 -1
- package/dist/models/model.d.ts +3 -0
- package/dist/models/model.js +29 -23
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +96 -8
- package/src/models/AddPolarFsPathMappingRequest.ts +10 -4
- package/src/models/AddPolarFsPathMappingResponseBody.ts +1 -1
- package/src/models/CreateBatchConsumerRequest.ts +23 -7
- package/src/models/CreateBatchConsumerResponseBody.ts +112 -2
- package/src/models/CreateDbclusterRequest.ts +51 -265
- package/src/models/CreateDbclusterResponseBody.ts +14 -0
- package/src/models/CreateGwConsumerOrderRequest.ts +99 -0
- package/src/models/CreateGwConsumerOrderResponse.ts +40 -0
- package/src/models/CreateGwConsumerOrderResponseBody.ts +74 -0
- package/src/models/DescribeApplicationLogsRequest.ts +4 -4
- package/src/models/DescribeApplicationPerformanceRequest.ts +38 -15
- package/src/models/DescribeApplicationPerformanceResponseBody.ts +7 -4
- package/src/models/ModifyDbclusterSslrequest.ts +16 -9
- package/src/models/RestartPolarClawGatewayRequest.ts +7 -0
- package/src/models/RestartPolarClawGatewayResponseBody.ts +36 -0
- package/src/models/model.ts +3 -0
|
@@ -4,8 +4,6 @@ export declare class CreateDBClusterRequestTag extends $dara.Model {
|
|
|
4
4
|
* @remarks
|
|
5
5
|
* The tag key. To add multiple tags to the cluster at a time, click **Add** to add tag keys.
|
|
6
6
|
*
|
|
7
|
-
* > You can add up to 20 tag pairs at a time. `Tag.N.Key` corresponds to `Tag.N.Value`.
|
|
8
|
-
*
|
|
9
7
|
* @example
|
|
10
8
|
* type
|
|
11
9
|
*/
|
|
@@ -14,8 +12,6 @@ export declare class CreateDBClusterRequestTag extends $dara.Model {
|
|
|
14
12
|
* @remarks
|
|
15
13
|
* The tag value. To add multiple tags to the cluster at a time, click **Add** to add tag values.
|
|
16
14
|
*
|
|
17
|
-
* > You can add up to 20 tag pairs at a time. `Tag.N.Value` corresponds to `Tag.N.Key`.
|
|
18
|
-
*
|
|
19
15
|
* @example
|
|
20
16
|
* test
|
|
21
17
|
*/
|
|
@@ -32,18 +28,34 @@ export declare class CreateDBClusterRequestTag extends $dara.Model {
|
|
|
32
28
|
});
|
|
33
29
|
}
|
|
34
30
|
export declare class CreateDBClusterRequest extends $dara.Model {
|
|
31
|
+
/**
|
|
32
|
+
* @remarks
|
|
33
|
+
* The Agentic cluster description.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* pagc-******
|
|
37
|
+
*/
|
|
35
38
|
agenticDbClusterDescription?: string;
|
|
39
|
+
/**
|
|
40
|
+
* @remarks
|
|
41
|
+
* The Agentic cluster ID.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* pagc-******
|
|
45
|
+
*/
|
|
36
46
|
agenticDbClusterId?: string;
|
|
47
|
+
/**
|
|
48
|
+
* @remarks
|
|
49
|
+
* The Agentic database engine type. Valid values:
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* dedicated
|
|
53
|
+
*/
|
|
37
54
|
agenticDbType?: string;
|
|
38
55
|
/**
|
|
39
56
|
* @remarks
|
|
40
57
|
* Specifies whether to enable No-activity Suspension. Valid values:
|
|
41
58
|
*
|
|
42
|
-
* - **true**: Enabled.
|
|
43
|
-
*
|
|
44
|
-
* - **false**: Disabled. This is the default value.
|
|
45
|
-
* > Only serverless clusters support this parameter.
|
|
46
|
-
*
|
|
47
59
|
* @example
|
|
48
60
|
* true
|
|
49
61
|
*/
|
|
@@ -51,8 +63,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
51
63
|
/**
|
|
52
64
|
* @remarks
|
|
53
65
|
* The CPU architecture. Valid values:
|
|
54
|
-
* - X86
|
|
55
|
-
* - ARM
|
|
56
66
|
*
|
|
57
67
|
* @example
|
|
58
68
|
* X86
|
|
@@ -62,13 +72,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
62
72
|
* @remarks
|
|
63
73
|
* Specifies whether to enable auto-renewal. Valid values:
|
|
64
74
|
*
|
|
65
|
-
* - **true**: Auto-renewal is enabled.
|
|
66
|
-
* - **false**: Auto-renewal is disabled.
|
|
67
|
-
*
|
|
68
|
-
* Default value: **false**.
|
|
69
|
-
*
|
|
70
|
-
* > This parameter takes effect only when **PayType** is set to **Prepaid**.
|
|
71
|
-
*
|
|
72
75
|
* @example
|
|
73
76
|
* true
|
|
74
77
|
*/
|
|
@@ -76,8 +79,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
76
79
|
/**
|
|
77
80
|
* @remarks
|
|
78
81
|
* Specifies whether to automatically use coupons. Valid values:
|
|
79
|
-
* * true (default): Coupons are used.
|
|
80
|
-
* * false: Coupons are not used.
|
|
81
82
|
*
|
|
82
83
|
* @example
|
|
83
84
|
* true
|
|
@@ -85,14 +86,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
85
86
|
autoUseCoupon?: boolean;
|
|
86
87
|
/**
|
|
87
88
|
* @remarks
|
|
88
|
-
* The data retention policy
|
|
89
|
-
* * **ALL**: All backups are retained for long-term retention (LTR).
|
|
90
|
-
* * **LATEST**: The last backup is retained for long-term retention (LTR). An automatic backup is performed before deletion.
|
|
91
|
-
* * **NONE**: No backups are retained when the cluster is deleted.
|
|
92
|
-
*
|
|
93
|
-
* Default value: **NONE**, which means no backups are retained when the cluster is deleted.
|
|
94
|
-
* >* This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
95
|
-
* >* Serverless clusters do not support this parameter.
|
|
89
|
+
* The data retention policy for backups when the cluster is deleted. Valid values:
|
|
96
90
|
*
|
|
97
91
|
* @example
|
|
98
92
|
* NONE
|
|
@@ -102,18 +96,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
102
96
|
* @remarks
|
|
103
97
|
* Specifies whether to enable I/O performance burst for the ESSD AutoPL cloud disk. Valid values:
|
|
104
98
|
*
|
|
105
|
-
* - **true**: Enabled.
|
|
106
|
-
* - **false**: Disabled. This is the default value.
|
|
107
|
-
*
|
|
108
|
-
* > This parameter is supported only when StorageType is set to ESSDAUTOPL.
|
|
109
|
-
*
|
|
110
99
|
* @example
|
|
111
100
|
* false
|
|
112
101
|
*/
|
|
113
102
|
burstingEnabled?: string;
|
|
114
103
|
/**
|
|
115
104
|
* @remarks
|
|
116
|
-
* The client token that is used to ensure the idempotence of the request. The value is generated by the client and
|
|
105
|
+
* The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and is unique among different requests. The value is case-sensitive and cannot exceed 64 ASCII characters in length.
|
|
117
106
|
*
|
|
118
107
|
* @example
|
|
119
108
|
* 6000170000591aed949d0f5********************
|
|
@@ -123,21 +112,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
123
112
|
* @remarks
|
|
124
113
|
* The point in time at which data is cloned. Valid values:
|
|
125
114
|
*
|
|
126
|
-
* - **LATEST**: The latest point in time.
|
|
127
|
-
* - **BackupID**: A historical backup set ID. Specify the actual backup set ID.
|
|
128
|
-
* - **Timestamp**: A historical point in time. Specify the actual time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
|
|
129
|
-
*
|
|
130
|
-
* Default value: **LATEST**.
|
|
131
|
-
*
|
|
132
|
-
* > If **CreationOption** is set to **CloneFromRDS**, this parameter can only be set to **LATEST**.
|
|
133
|
-
*
|
|
134
115
|
* @example
|
|
135
116
|
* LATEST
|
|
136
117
|
*/
|
|
137
118
|
cloneDataPoint?: string;
|
|
138
119
|
/**
|
|
139
120
|
* @remarks
|
|
140
|
-
* The cloud service provider
|
|
121
|
+
* The cloud service provider to which the instance belongs.
|
|
141
122
|
*
|
|
142
123
|
* @example
|
|
143
124
|
* ENS
|
|
@@ -145,7 +126,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
145
126
|
cloudProvider?: string;
|
|
146
127
|
/**
|
|
147
128
|
* @remarks
|
|
148
|
-
* The network type of the cluster.
|
|
129
|
+
* The network type of the cluster. Currently, only Virtual Private Cloud (VPC) is supported. Set the value to **VPC**.
|
|
149
130
|
*
|
|
150
131
|
* @example
|
|
151
132
|
* VPC
|
|
@@ -154,17 +135,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
154
135
|
/**
|
|
155
136
|
* @remarks
|
|
156
137
|
* The edition of the cluster. Valid values:
|
|
157
|
-
* * **Normal**: Cluster Edition. This is the default value.
|
|
158
|
-
* * **Basic**: Single Node Edition.
|
|
159
|
-
* * **ArchiveNormal**: X-Engine Edition.
|
|
160
|
-
* * **NormalMultimaster**: Multi-master Cluster Edition.
|
|
161
|
-
* * **SENormal**: Standard Edition.
|
|
162
|
-
*
|
|
163
|
-
* > * **MySQL** **5.6**, **5.7**, **8.0**, **PostgreSQL** **14**, and **Oracle syntax-compatible 2.0** support **Basic**.
|
|
164
|
-
* > * **MySQL** **8.0** supports **ArchiveNormal** and **NormalMultimaster**.
|
|
165
|
-
* > * **MySQL** **5.6**, **5.7**, **8.0**, and **PostgreSQL** **14** support **SENormal**.
|
|
166
|
-
*
|
|
167
|
-
* For more information about editions, see [Product editions](https://help.aliyun.com/document_detail/183258.html).
|
|
168
138
|
*
|
|
169
139
|
* @example
|
|
170
140
|
* Normal
|
|
@@ -174,45 +144,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
174
144
|
* @remarks
|
|
175
145
|
* The method used to create the cluster. Valid values:
|
|
176
146
|
*
|
|
177
|
-
* * **Normal**: Creates a new PolarDB cluster. For console operations, see the following topics:
|
|
178
|
-
*
|
|
179
|
-
* * [Create a PolarDB for MySQL database cluster](https://help.aliyun.com/document_detail/58769.html)
|
|
180
|
-
* * [Create a PolarDB for PostgreSQL database cluster](https://help.aliyun.com/document_detail/118063.html)
|
|
181
|
-
* * [Create a PolarDB for PostgreSQL (Compatible with Oracle) database cluster](https://help.aliyun.com/document_detail/118182.html)
|
|
182
|
-
*
|
|
183
|
-
* * **CloneFromPolarDB**: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, see the following topics:
|
|
184
|
-
*
|
|
185
|
-
* * [Clone a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/87966.html)
|
|
186
|
-
* * [Clone a PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/118108.html)
|
|
187
|
-
* * [Clone a PolarDB for PostgreSQL (Compatible with Oracle) cluster](https://help.aliyun.com/document_detail/118221.html)
|
|
188
|
-
*
|
|
189
|
-
* * **RecoverFromRecyclebin**: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, see the following topics:
|
|
190
|
-
*
|
|
191
|
-
* * [Restore a released PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/164880.html)
|
|
192
|
-
* * [Restore a released PolarDB for PostgreSQL cluster](https://help.aliyun.com/document_detail/432844.html)
|
|
193
|
-
* * [Restore a released PolarDB for PostgreSQL (Compatible with Oracle) cluster](https://help.aliyun.com/document_detail/424632.html)
|
|
194
|
-
*
|
|
195
|
-
* * **CloneFromRDS**: Clones data from an existing ApsaraDB RDS instance to a new PolarDB cluster. For console operations, see [Clone an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/121812.html).
|
|
196
|
-
*
|
|
197
|
-
* * **MigrationFromRDS**: Migrates data from an existing ApsaraDB RDS instance to a new PolarDB cluster. The created PolarDB cluster is in read-only pattern and has binary logging enabled by default. For console operations, see [Upgrade an ApsaraDB RDS for MySQL instance to a PolarDB for MySQL cluster](https://help.aliyun.com/document_detail/121582.html).
|
|
198
|
-
*
|
|
199
|
-
* * **CreateGdnStandby**: Creates a secondary cluster. For console operations, see [Add a secondary cluster](https://help.aliyun.com/document_detail/160381.html).
|
|
200
|
-
*
|
|
201
|
-
* * **UpgradeFromPolarDB**: Performs instance migration from PolarDB. For console operations, see [Major engine version upgrade](https://help.aliyun.com/document_detail/459712.html).
|
|
202
|
-
*
|
|
203
|
-
* Default value: **Normal**.
|
|
204
|
-
*
|
|
205
|
-
* > When **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**, you can set this parameter to **CreateGdnStandby**.
|
|
206
|
-
*
|
|
207
147
|
* @example
|
|
208
148
|
* Normal
|
|
209
149
|
*/
|
|
210
150
|
creationOption?: string;
|
|
211
151
|
/**
|
|
212
152
|
* @remarks
|
|
213
|
-
* The name
|
|
214
|
-
* * It cannot start with `http://` or `https://`.
|
|
215
|
-
* * It must be 2 to 256 characters in length.
|
|
153
|
+
* The cluster name. The cluster name must meet the following requirements:
|
|
216
154
|
*
|
|
217
155
|
* @example
|
|
218
156
|
* test
|
|
@@ -220,13 +158,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
220
158
|
DBClusterDescription?: string;
|
|
221
159
|
/**
|
|
222
160
|
* @remarks
|
|
223
|
-
* The minor engine
|
|
224
|
-
*
|
|
225
|
-
* - **8.0.2**
|
|
226
|
-
*
|
|
227
|
-
* - **8.0.1**
|
|
228
|
-
*
|
|
229
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL** and **DBVersion** is set to **8.0**.
|
|
161
|
+
* The minor version of the database engine. Valid values:
|
|
230
162
|
*
|
|
231
163
|
* @example
|
|
232
164
|
* 8.0.1
|
|
@@ -234,17 +166,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
234
166
|
DBMinorVersion?: string;
|
|
235
167
|
/**
|
|
236
168
|
* @remarks
|
|
237
|
-
* The node
|
|
238
|
-
*
|
|
239
|
-
* - PolarDB for MySQL: [Compute node specifications](https://help.aliyun.com/document_detail/102542.html).
|
|
240
|
-
* - PolarDB for PostgreSQL (Compatible with Oracle): [Compute node specifications](https://help.aliyun.com/document_detail/207921.html).
|
|
241
|
-
* - PolarDB for PostgreSQL: [Compute node specifications](https://help.aliyun.com/document_detail/209380.html).
|
|
242
|
-
*
|
|
243
|
-
* > - To create a serverless cluster for PolarDB for MySQL Cluster Edition, set this parameter to **polar.mysql.sl.small**.
|
|
244
|
-
* > - To create a serverless cluster for PolarDB for MySQL Standard Edition, set this parameter to **polar.mysql.sl.small.c**.
|
|
245
|
-
* > - To create a serverless cluster for PolarDB for PostgreSQL Cluster Edition, set this parameter to **polar.pg.sl.small**.
|
|
246
|
-
* > - To create a serverless cluster for PolarDB for PostgreSQL Standard Edition, set this parameter to **polar.pg.sl.small.c**.
|
|
247
|
-
* > - To create a serverless cluster for PolarDB for PostgreSQL (Compatible with Oracle), set this parameter to **polar.o.sl.small**.
|
|
169
|
+
* The node specifications. For details, see the following topics:
|
|
248
170
|
*
|
|
249
171
|
* @example
|
|
250
172
|
* polar.mysql.x4.medium
|
|
@@ -253,11 +175,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
253
175
|
/**
|
|
254
176
|
* @remarks
|
|
255
177
|
* The number of nodes for Standard Edition and Enterprise Edition. Valid values:
|
|
256
|
-
* - Standard Edition: 1 to 8 (supports 1 read/write node and 7 read-only nodes).
|
|
257
|
-
* - Enterprise Edition: 1 to 16 (supports 1 read/write node and 15 read-only nodes).
|
|
258
|
-
* > - Enterprise Edition has 2 nodes by default. Standard Edition has 1 node by default.
|
|
259
|
-
* > - Only PolarDB for MySQL supports this parameter.
|
|
260
|
-
* > - Changing the number of nodes for Multi-master Cluster Edition clusters is not supported.
|
|
261
178
|
*
|
|
262
179
|
* @example
|
|
263
180
|
* 1
|
|
@@ -267,10 +184,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
267
184
|
* @remarks
|
|
268
185
|
* The database engine type. Valid values:
|
|
269
186
|
*
|
|
270
|
-
* - **MySQL**
|
|
271
|
-
* - **PostgreSQL**
|
|
272
|
-
* - **Oracle**
|
|
273
|
-
*
|
|
274
187
|
* This parameter is required.
|
|
275
188
|
*
|
|
276
189
|
* @example
|
|
@@ -280,22 +193,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
280
193
|
/**
|
|
281
194
|
* @remarks
|
|
282
195
|
* The database engine version.
|
|
283
|
-
* * Valid values for MySQL:
|
|
284
|
-
* * **5.6**
|
|
285
|
-
* * **5.7**
|
|
286
|
-
* * **8.0**
|
|
287
|
-
* * Valid values for PostgreSQL:
|
|
288
|
-
* * **11**
|
|
289
|
-
* * **14**
|
|
290
|
-
* * **15**
|
|
291
|
-
* <props="china">
|
|
292
|
-
*
|
|
293
|
-
* > To create a serverless cluster for PolarDB for PostgreSQL, only version 14 is supported.
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
* * Valid values for Oracle:
|
|
297
|
-
* * **11**
|
|
298
|
-
* * **14**
|
|
299
196
|
*
|
|
300
197
|
* This parameter is required.
|
|
301
198
|
*
|
|
@@ -305,8 +202,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
305
202
|
DBVersion?: string;
|
|
306
203
|
/**
|
|
307
204
|
* @remarks
|
|
308
|
-
* The
|
|
309
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
205
|
+
* The time zone of the cluster (UTC). The value can be set to any time frame within the range of **-12:00 to +13:00**, such as **00:00**. Default value: **SYSTEM**. The default time zone is the same as the time zone of the region.
|
|
310
206
|
*
|
|
311
207
|
* @example
|
|
312
208
|
* SYSTEM
|
|
@@ -322,9 +218,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
322
218
|
ensRegionId?: string;
|
|
323
219
|
/**
|
|
324
220
|
* @remarks
|
|
325
|
-
* The
|
|
326
|
-
*
|
|
327
|
-
* > This parameter is required when **CreationOption** is set to **CreateGdnStandby**.
|
|
221
|
+
* The global database network (GDN) ID.
|
|
328
222
|
*
|
|
329
223
|
* @example
|
|
330
224
|
* gdn-***********
|
|
@@ -332,14 +226,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
332
226
|
GDNId?: string;
|
|
333
227
|
/**
|
|
334
228
|
* @remarks
|
|
335
|
-
* Specifies whether
|
|
336
|
-
*
|
|
337
|
-
* - **ON** (default): Enables the hot standby storage cluster.
|
|
338
|
-
* - **OFF**: Disables the hot standby cluster.
|
|
339
|
-
* - **STANDBY**: Enables the hot standby cluster.
|
|
340
|
-
* - **EQUAL**: Enables both the hot standby storage cluster and the hot standby compute cluster.
|
|
341
|
-
* - **3AZ**: Enables multi-zone strong data consistency.
|
|
342
|
-
* > **STANDBY** takes effect only for PolarDB for PostgreSQL.
|
|
229
|
+
* Specifies whether the hot standby cluster is enabled. Valid values:
|
|
343
230
|
*
|
|
344
231
|
* @example
|
|
345
232
|
* ON
|
|
@@ -347,11 +234,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
347
234
|
hotStandbyCluster?: string;
|
|
348
235
|
/**
|
|
349
236
|
* @remarks
|
|
350
|
-
* Specifies whether to enable the
|
|
351
|
-
*
|
|
352
|
-
* - **ON**: Binary logging is enabled for the cluster.
|
|
353
|
-
* - **OFF**: Binary logging is disabled for the cluster.
|
|
354
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
237
|
+
* Specifies whether to enable the Binlog feature. Valid values:
|
|
355
238
|
*
|
|
356
239
|
* @example
|
|
357
240
|
* ON
|
|
@@ -361,10 +244,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
361
244
|
* @remarks
|
|
362
245
|
* Specifies whether to enable the X-Engine storage engine. Valid values:
|
|
363
246
|
*
|
|
364
|
-
* - **ON**: The X-Engine engine is enabled for the cluster.
|
|
365
|
-
* - **OFF**: The X-Engine engine is disabled for the cluster.
|
|
366
|
-
* > This parameter takes effect only when **CreationOption** is not set to **CreateGdnStandby**, **DBType** is set to **MySQL**, and **DBVersion** is set to **8.0**. The memory specification of nodes with X-Engine enabled must be 8 GB or more.
|
|
367
|
-
*
|
|
368
247
|
* @example
|
|
369
248
|
* ON
|
|
370
249
|
*/
|
|
@@ -372,7 +251,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
372
251
|
/**
|
|
373
252
|
* @remarks
|
|
374
253
|
* The percentage of memory allocated to the X-Engine storage engine. Valid values: integers from 10 to 90.
|
|
375
|
-
* > This parameter takes effect only when **LooseXEngine** is set to **ON**.
|
|
376
254
|
*
|
|
377
255
|
* @example
|
|
378
256
|
* 50
|
|
@@ -381,11 +259,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
381
259
|
/**
|
|
382
260
|
* @remarks
|
|
383
261
|
* Specifies whether table names are case-sensitive. Valid values:
|
|
384
|
-
* * **1**: Table names are case-insensitive.
|
|
385
|
-
* * **0**: Table names are case-sensitive.
|
|
386
|
-
*
|
|
387
|
-
* Default value: **1**.
|
|
388
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
389
262
|
*
|
|
390
263
|
* @example
|
|
391
264
|
* 1
|
|
@@ -395,9 +268,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
395
268
|
ownerId?: number;
|
|
396
269
|
/**
|
|
397
270
|
* @remarks
|
|
398
|
-
* The
|
|
399
|
-
*
|
|
400
|
-
* > You can call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to query the parameter template list in the specified region, including the parameter template ID.
|
|
271
|
+
* The parameter template ID.
|
|
401
272
|
*
|
|
402
273
|
* @example
|
|
403
274
|
* pcpg-**************
|
|
@@ -407,9 +278,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
407
278
|
* @remarks
|
|
408
279
|
* The billing method. Valid values:
|
|
409
280
|
*
|
|
410
|
-
* - **Postpaid**: pay-as-you-go.
|
|
411
|
-
* - **Prepaid**: subscription.
|
|
412
|
-
*
|
|
413
281
|
* This parameter is required.
|
|
414
282
|
*
|
|
415
283
|
* @example
|
|
@@ -418,10 +286,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
418
286
|
payType?: string;
|
|
419
287
|
/**
|
|
420
288
|
* @remarks
|
|
421
|
-
* This parameter is required when
|
|
422
|
-
*
|
|
423
|
-
* - **Year**: The subscription period is measured in years.
|
|
424
|
-
* - **Month**: The subscription period is measured in months.
|
|
289
|
+
* This parameter is required when PayType is set to **Prepaid**. Specifies whether the subscription cluster uses a yearly or monthly billing cycle.
|
|
425
290
|
*
|
|
426
291
|
* @example
|
|
427
292
|
* Month
|
|
@@ -438,8 +303,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
438
303
|
/**
|
|
439
304
|
* @remarks
|
|
440
305
|
* <p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.</p>
|
|
441
|
-
* <p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>Baseline performance = min{1,800 + 50 × capacity, 50,000}.</p>
|
|
442
|
-
* <note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>This parameter is supported only when StorageType is set to ESSDAUTOPL.</note>
|
|
443
306
|
*
|
|
444
307
|
* @example
|
|
445
308
|
* 1000
|
|
@@ -449,26 +312,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
449
312
|
* @remarks
|
|
450
313
|
* The specification of the database proxy for Standard Edition. Valid values:
|
|
451
314
|
*
|
|
452
|
-
* - **polar.maxscale.g2.medium.c**: 2 cores.
|
|
453
|
-
* - **polar.maxscale.g2.large.c**: 4 cores.
|
|
454
|
-
* - **polar.maxscale.g2.xlarge.c**: 8 cores.
|
|
455
|
-
* - **polar.maxscale.g2.2xlarge.c**: 16 cores.
|
|
456
|
-
* - **polar.maxscale.g2.3xlarge.c**: 24 cores.
|
|
457
|
-
* - **polar.maxscale.g2.4xlarge.c**: 32 cores.
|
|
458
|
-
* - **polar.maxscale.g2.8xlarge.c**: 64 cores.
|
|
459
|
-
*
|
|
460
315
|
* @example
|
|
461
316
|
* polar.maxscale.g2.medium.c
|
|
462
317
|
*/
|
|
463
318
|
proxyClass?: string;
|
|
464
319
|
/**
|
|
465
320
|
* @remarks
|
|
466
|
-
* The
|
|
467
|
-
* - **EXCLUSIVE**: Dedicated Enterprise Edition.
|
|
468
|
-
* - **GENERAL**: Standard Enterprise Edition.
|
|
469
|
-
* > The proxy type must match the type that corresponds to the node specifications of the cluster:
|
|
470
|
-
* > - If the node specifications are General-purpose, set the proxy type to Standard Enterprise Edition.
|
|
471
|
-
* > - If the node specifications are Dedicated, set the proxy type to Dedicated Enterprise Edition.
|
|
321
|
+
* The database proxy type. Valid values:
|
|
472
322
|
*
|
|
473
323
|
* @example
|
|
474
324
|
* Exclusive
|
|
@@ -478,8 +328,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
478
328
|
* @remarks
|
|
479
329
|
* The region ID.
|
|
480
330
|
*
|
|
481
|
-
* > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available regions.
|
|
482
|
-
*
|
|
483
331
|
* This parameter is required.
|
|
484
332
|
*
|
|
485
333
|
* @example
|
|
@@ -498,8 +346,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
498
346
|
resourceOwnerId?: number;
|
|
499
347
|
/**
|
|
500
348
|
* @remarks
|
|
501
|
-
* The maximum scaling limit
|
|
502
|
-
* > Only serverless clusters support this parameter.
|
|
349
|
+
* The maximum scaling limit per node. Valid values: 1 PCU to 32 PCUs.
|
|
503
350
|
*
|
|
504
351
|
* @example
|
|
505
352
|
* 3
|
|
@@ -507,9 +354,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
507
354
|
scaleMax?: string;
|
|
508
355
|
/**
|
|
509
356
|
* @remarks
|
|
510
|
-
* The minimum scaling limit
|
|
511
|
-
*
|
|
512
|
-
* > Only serverless clusters support this parameter.
|
|
357
|
+
* The minimum scaling limit per node. Valid values: 1 PCU to 31 PCUs.
|
|
513
358
|
*
|
|
514
359
|
* @example
|
|
515
360
|
* 1
|
|
@@ -518,7 +363,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
518
363
|
/**
|
|
519
364
|
* @remarks
|
|
520
365
|
* The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
|
|
521
|
-
* > Only serverless clusters support this parameter.
|
|
522
366
|
*
|
|
523
367
|
* @example
|
|
524
368
|
* 4
|
|
@@ -527,7 +371,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
527
371
|
/**
|
|
528
372
|
* @remarks
|
|
529
373
|
* The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
|
|
530
|
-
* > Only serverless clusters support this parameter.
|
|
531
374
|
*
|
|
532
375
|
* @example
|
|
533
376
|
* 2
|
|
@@ -535,8 +378,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
535
378
|
scaleRoNumMin?: string;
|
|
536
379
|
/**
|
|
537
380
|
* @remarks
|
|
538
|
-
* The IP
|
|
539
|
-
* > You can specify multiple IP addresses. Separate multiple IP addresses with commas (,).
|
|
381
|
+
* The IP whitelist of the PolarDB cluster.
|
|
540
382
|
*
|
|
541
383
|
* @example
|
|
542
384
|
* 10.***.***.***
|
|
@@ -544,8 +386,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
544
386
|
securityIPList?: string;
|
|
545
387
|
/**
|
|
546
388
|
* @remarks
|
|
547
|
-
* The serverless type.
|
|
548
|
-
* > Only serverless clusters support this parameter.
|
|
389
|
+
* The serverless type. The value is fixed as **AgileServerless**.
|
|
549
390
|
*
|
|
550
391
|
* @example
|
|
551
392
|
* AgileServerless
|
|
@@ -553,11 +394,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
553
394
|
serverlessType?: string;
|
|
554
395
|
/**
|
|
555
396
|
* @remarks
|
|
556
|
-
*
|
|
557
|
-
* * If **CreationOption** is set to **MigrationFromRDS** or **CloneFromRDS**, set this parameter to instance ID of the source ApsaraDB RDS instance. The source ApsaraDB RDS instance must run RDS MySQL 5.6, 5.7, or 8.0 on RDS High-availability Edition.
|
|
558
|
-
*
|
|
559
|
-
* * If **CreationOption** is set to **CloneFromPolarDB**, set this parameter to instance ID of the source PolarDB cluster. The cloned cluster and the source cluster have the same DBType by default. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the cloned cluster.
|
|
560
|
-
* * If **CreationOption** is set to **RecoverFromRecyclebin**, set this parameter to instance ID of the released source PolarDB cluster. The recovered cluster and the source cluster must have the same DBType. For example, if the source cluster runs MySQL 8.0, set **DBType** to **MySQL** and **DBVersion** to **8.0** for the recovered cluster.
|
|
397
|
+
* The instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when **CreationOption** is set to **MigrationFromRDS**, **CloneFromRDS**, **CloneFromPolarDB**, or **RecoverFromRecyclebin**.
|
|
561
398
|
*
|
|
562
399
|
* @example
|
|
563
400
|
* rm-*************
|
|
@@ -575,18 +412,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
575
412
|
* @remarks
|
|
576
413
|
* The zone of the hot standby cluster.
|
|
577
414
|
*
|
|
578
|
-
* > This parameter takes effect only when the hot standby cluster or multi-zone strong data consistency is enabled.
|
|
579
|
-
*
|
|
580
415
|
* @example
|
|
581
416
|
* cn-hangzhou-g
|
|
582
417
|
*/
|
|
583
418
|
standbyAZ?: string;
|
|
584
419
|
/**
|
|
585
420
|
* @remarks
|
|
586
|
-
* Specifies whether to enable automatic storage scaling for Standard Edition
|
|
587
|
-
*
|
|
588
|
-
* - Enable: Automatic storage scaling is enabled.
|
|
589
|
-
* - Disable: Automatic storage scaling is shutdown.
|
|
421
|
+
* Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:
|
|
590
422
|
*
|
|
591
423
|
* @example
|
|
592
424
|
* Enable
|
|
@@ -595,23 +427,11 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
595
427
|
/**
|
|
596
428
|
* @remarks
|
|
597
429
|
* Specifies whether to enable cloud disk encryption. Valid values:
|
|
598
|
-
*
|
|
599
|
-
* - **true**: Cloud disk encryption is enabled.
|
|
600
|
-
* - **false**: Cloud disk encryption is disabled. This is the default value.
|
|
601
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
602
|
-
*
|
|
603
|
-
* > This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.
|
|
604
430
|
*/
|
|
605
431
|
storageEncryption?: boolean;
|
|
606
432
|
/**
|
|
607
433
|
* @remarks
|
|
608
|
-
* The ID of the custom
|
|
609
|
-
*
|
|
610
|
-
* You can view the key ID in the Key Management Service (KMS) console or create a new key.
|
|
611
|
-
*
|
|
612
|
-
* > This parameter takes effect only when **DBType** is set to **MySQL**.
|
|
613
|
-
*
|
|
614
|
-
* > This parameter takes effect only when **StorageType** is set to a Standard Edition storage type.
|
|
434
|
+
* The key ID of the custom Key Management Service (KMS) key for cloud disk encryption in the same region as the instance. Specifying this parameter automatically enables cloud disk encryption, which cannot be disabled after being enabled. Leave this parameter empty to use the default service key for cloud disk encryption.
|
|
615
435
|
*
|
|
616
436
|
* @example
|
|
617
437
|
* 1022xxxxxxxx
|
|
@@ -621,19 +441,13 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
621
441
|
* @remarks
|
|
622
442
|
* The billing type for storage. Valid values:
|
|
623
443
|
*
|
|
624
|
-
* - Postpaid: pay-by-capacity (pay-as-you-go).
|
|
625
|
-
* - Prepaid: pay-by-space (subscription).
|
|
626
|
-
*
|
|
627
444
|
* @example
|
|
628
445
|
* Prepaid
|
|
629
446
|
*/
|
|
630
447
|
storagePayType?: string;
|
|
631
448
|
/**
|
|
632
449
|
* @remarks
|
|
633
|
-
* The storage space for
|
|
634
|
-
* > - Valid values for PolarDB for MySQL Enterprise Edition: 10 to 50000.
|
|
635
|
-
* > - Valid values for PolarDB for MySQL Standard Edition: 20 to 64000.
|
|
636
|
-
* > - When the Standard Edition storage type is ESSDAUTOPL, valid values are 40 to 64000 with a minimum step of 10. Only values such as 40, 50, 60, and so on are accepted.
|
|
450
|
+
* The storage space for the space-based billing (subscription) plan. Unit: GB.
|
|
637
451
|
*
|
|
638
452
|
* @example
|
|
639
453
|
* 50
|
|
@@ -641,16 +455,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
641
455
|
storageSpace?: number;
|
|
642
456
|
/**
|
|
643
457
|
* @remarks
|
|
644
|
-
*
|
|
645
|
-
* - **PSL5**
|
|
646
|
-
* - **PSL4**
|
|
647
|
-
*
|
|
648
|
-
* Valid values for Standard Edition storage type:
|
|
649
|
-
* - **ESSDPL0**
|
|
650
|
-
* - **ESSDPL1**
|
|
651
|
-
* - **ESSDPL2**
|
|
652
|
-
* - **ESSDPL3**
|
|
653
|
-
* - **ESSDAUTOPL**
|
|
458
|
+
* The storage type for Enterprise Edition. Valid values:
|
|
654
459
|
*
|
|
655
460
|
* @example
|
|
656
461
|
* PSL4
|
|
@@ -658,9 +463,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
658
463
|
storageType?: string;
|
|
659
464
|
/**
|
|
660
465
|
* @remarks
|
|
661
|
-
*
|
|
662
|
-
*
|
|
663
|
-
* > The maximum value is 32000.
|
|
466
|
+
* The upper limit of automatic storage scaling for the Standard Edition cluster. Unit: GB.
|
|
664
467
|
*
|
|
665
468
|
* @example
|
|
666
469
|
* 800
|
|
@@ -668,11 +471,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
668
471
|
storageUpperBound?: number;
|
|
669
472
|
/**
|
|
670
473
|
* @remarks
|
|
671
|
-
* Specifies whether multi-zone strong data consistency
|
|
672
|
-
*
|
|
673
|
-
* - **ON**: Multi-zone strong data consistency is enabled. This value applies to the Standard Edition 3AZ scenario.
|
|
674
|
-
*
|
|
675
|
-
* - **OFF**: Multi-zone strong data consistency is disabled.
|
|
474
|
+
* Specifies whether to enable multi-zone strong data consistency for the cluster. Valid values:
|
|
676
475
|
*
|
|
677
476
|
* @example
|
|
678
477
|
* ON
|
|
@@ -682,13 +481,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
682
481
|
* @remarks
|
|
683
482
|
* Specifies whether to enable Transparent Data Encryption (TDE). Valid values:
|
|
684
483
|
*
|
|
685
|
-
* - **true**: TDE is enabled.
|
|
686
|
-
* - **false**: TDE is disabled. This is the default value.
|
|
687
|
-
*
|
|
688
|
-
* > * This parameter takes effect only when **DBType** is set to **PostgreSQL** or **Oracle**.
|
|
689
|
-
* > * You can call the [ModifyDBClusterTDE](https://help.aliyun.com/document_detail/167982.html) operation to enable TDE for a PolarDB for MySQL cluster.
|
|
690
|
-
* > * TDE cannot be disabled after it is enabled.
|
|
691
|
-
*
|
|
692
484
|
* @example
|
|
693
485
|
* true
|
|
694
486
|
*/
|
|
@@ -708,9 +500,7 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
708
500
|
targetMinorVersion?: string;
|
|
709
501
|
/**
|
|
710
502
|
* @remarks
|
|
711
|
-
* This parameter is required when
|
|
712
|
-
* - When **Period** is set to **Month**, the valid values of **UsedTime** are integers in the range of `[1-9]`.
|
|
713
|
-
* - When **Period** is set to **Year**, the valid values of **UsedTime** are integers in the range of `[1-3]`.
|
|
503
|
+
* This parameter is required when PayType is set to **Prepaid**.
|
|
714
504
|
*
|
|
715
505
|
* @example
|
|
716
506
|
* 1
|
|
@@ -728,8 +518,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
728
518
|
* @remarks
|
|
729
519
|
* The vSwitch ID.
|
|
730
520
|
*
|
|
731
|
-
* > If you specify VPCId, you must also specify VSwitchId.
|
|
732
|
-
*
|
|
733
521
|
* @example
|
|
734
522
|
* vsw-**********
|
|
735
523
|
*/
|
|
@@ -738,8 +526,6 @@ export declare class CreateDBClusterRequest extends $dara.Model {
|
|
|
738
526
|
* @remarks
|
|
739
527
|
* The zone ID.
|
|
740
528
|
*
|
|
741
|
-
* > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available zones.
|
|
742
|
-
*
|
|
743
529
|
* @example
|
|
744
530
|
* cn-hangzhou-j
|
|
745
531
|
*/
|