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