@alicloud/polardb20170801 8.2.2 → 8.2.4

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.
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateApplicationResponseBodyComponents extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the child component.
8
+ * The child component ID.
9
9
  *
10
10
  * @example
11
11
  * pac-********************
@@ -35,7 +35,7 @@ export class CreateApplicationResponseBodyComponents extends $dara.Model {
35
35
  export class CreateApplicationResponseBody extends $dara.Model {
36
36
  /**
37
37
  * @remarks
38
- * The ID of the application.
38
+ * The application ID.
39
39
  *
40
40
  * @example
41
41
  * pa-********************
@@ -43,12 +43,12 @@ export class CreateApplicationResponseBody extends $dara.Model {
43
43
  applicationId?: string;
44
44
  /**
45
45
  * @remarks
46
- * A list of child components.
46
+ * The list of child components.
47
47
  */
48
48
  components?: CreateApplicationResponseBodyComponents[];
49
49
  /**
50
50
  * @remarks
51
- * The description of the application.
51
+ * The application description.
52
52
  *
53
53
  * @example
54
54
  * myapp
@@ -56,7 +56,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
56
56
  description?: string;
57
57
  /**
58
58
  * @remarks
59
- * The ID of the generated order.
59
+ * The generated order ID.
60
60
  *
61
61
  * @example
62
62
  * 2148126708*****
@@ -64,7 +64,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
64
64
  orderId?: string;
65
65
  /**
66
66
  * @remarks
67
- * The ID of the request.
67
+ * The request ID.
68
68
  *
69
69
  * @example
70
70
  * 3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
@@ -72,7 +72,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
72
72
  requestId?: string;
73
73
  /**
74
74
  * @remarks
75
- * Indicates whether the resources are sufficient. This parameter is returned only when `DryRun` is set to `true`.
75
+ * Indicates whether resources are sufficient. This parameter is returned only when DryRun is set to true.
76
76
  *
77
77
  * @example
78
78
  * true
@@ -80,7 +80,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
80
80
  resourceAvailable?: boolean;
81
81
  /**
82
82
  * @remarks
83
- * The ID of the resource group.
83
+ * The resource group ID.
84
84
  *
85
85
  * @example
86
86
  * rg-********************
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateApplicationShrinkRequestTag extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The key of the tag.
8
+ * The tag key.
9
9
  *
10
10
  * @example
11
11
  * testKey
@@ -13,7 +13,7 @@ export class CreateApplicationShrinkRequestTag extends $dara.Model {
13
13
  key?: string;
14
14
  /**
15
15
  * @remarks
16
- * The value of the tag.
16
+ * The tag value.
17
17
  *
18
18
  * @example
19
19
  * testValue
@@ -45,7 +45,7 @@ export class CreateApplicationShrinkRequestTag extends $dara.Model {
45
45
  export class CreateApplicationShrinkRequest extends $dara.Model {
46
46
  /**
47
47
  * @remarks
48
- * The ID of an existing model operator instance to associate. This parameter is effective only when ApplicationType is set to polarclaw.
48
+ * The ID of an existing model operator instance to associate. This parameter takes effect only when ApplicationType is set to polarclaw.
49
49
  *
50
50
  * @example
51
51
  * pm-xxxxxx
@@ -53,13 +53,19 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
53
53
  AIDBClusterId?: string;
54
54
  /**
55
55
  * @remarks
56
- * The type of the application. Valid values:
56
+ * The AgenticDB branch specification.
57
57
  *
58
- * - supabase: Creates a managed Supabase application.
59
- *
60
- * - raycluster: Creates a managed Ray Cluster application.
58
+ * @example
59
+ * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
60
+ */
61
+ agenticDBBranchSpecShrink?: string;
62
+ /**
63
+ * @remarks
64
+ * The application type. Valid values:
61
65
  *
62
- * - polarclaw: Creates a managed PolarClaw application.
66
+ * - supabase: Set this value to create a managed Supabase application.
67
+ * - raycluster: Set this value to create a managed Ray Cluster application.
68
+ * - polarclaw: Set this value to create a managed PolarClaw application.
63
69
  *
64
70
  * This parameter is required.
65
71
  *
@@ -69,7 +75,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
69
75
  applicationType?: string;
70
76
  /**
71
77
  * @remarks
72
- * The CPU architecture. Valid value:
78
+ * The CPU architecture. Valid values:
73
79
  *
74
80
  * - x86
75
81
  *
@@ -89,7 +95,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
89
95
  authProvider?: string;
90
96
  /**
91
97
  * @remarks
92
- * The configuration of the authentication provider.
98
+ * The authentication provider configuration.
93
99
  *
94
100
  * @example
95
101
  * xxx
@@ -97,7 +103,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
97
103
  authProviderConfig?: string;
98
104
  /**
99
105
  * @remarks
100
- * Specifies whether to automatically create and bind an Elastic IP Address (EIP).
106
+ * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
101
107
  *
102
108
  * @example
103
109
  * qwen3-max
@@ -105,11 +111,9 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
105
111
  autoAllocatePublicEip?: boolean;
106
112
  /**
107
113
  * @remarks
108
- * Specifies whether to automatically create a PolarFS cold storage instance. Valid values:
109
- *
110
- * - false (default): Does not automatically create the instance.
111
- *
112
- * - true: Automatically creates the instance.
114
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
115
+ * * false (default): Automatic creation is disabled.
116
+ * * true: Automatic creation is enabled.
113
117
  *
114
118
  * @example
115
119
  * false
@@ -125,11 +129,9 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
125
129
  autoRenew?: boolean;
126
130
  /**
127
131
  * @remarks
128
- * Specifies whether to automatically use a coupon. Valid values:
129
- *
130
- * - true (default): Uses a coupon.
131
- *
132
- * - false: Does not use a coupon.
132
+ * Specifies whether to automatically use coupons. Valid values:
133
+ * * true (default): Use coupons.
134
+ * * false: Do not use coupons.
133
135
  *
134
136
  * @example
135
137
  * true
@@ -137,12 +139,12 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
137
139
  autoUseCoupon?: boolean;
138
140
  /**
139
141
  * @remarks
140
- * A list of custom child components for the application.
142
+ * The list of user-defined application subcomponents.
141
143
  */
142
144
  componentsShrink?: string;
143
145
  /**
144
146
  * @remarks
145
- * The ID of the PolarDB instance that the application depends on.
147
+ * The instance ID of the PolarDB instance on which the application depends.
146
148
  *
147
149
  * @example
148
150
  * pc-**************
@@ -158,7 +160,20 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
158
160
  description?: string;
159
161
  /**
160
162
  * @remarks
161
- * The default value is `false`. If you set this parameter to `true`, the system only checks the parameters and resources without creating the actual resources.
163
+ * The list of expected DNAT entries for NAT mapping. Specify this parameter together with VpcNatGatewayId. This parameter can be left empty, which indicates that no DNAT entries are created.
164
+ */
165
+ dnatEntriesShrink?: string;
166
+ /**
167
+ * @remarks
168
+ * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
169
+ *
170
+ * @example
171
+ * 10.64.0.10
172
+ */
173
+ dnatIpAddress?: string;
174
+ /**
175
+ * @remarks
176
+ * Default value: `false`. If you set this parameter to `true`, only parameter and resource validation is performed without actually creating the resource.
162
177
  *
163
178
  * @example
164
179
  * false
@@ -166,22 +181,22 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
166
181
  dryRun?: boolean;
167
182
  /**
168
183
  * @remarks
169
- * A list of custom server-side endpoints. By default, a VPC Endpoint is created.
184
+ * The list of user-defined service endpoints. By default, a VPC endpoint is created.
170
185
  */
171
186
  endpointsShrink?: string;
172
187
  /**
173
188
  * @remarks
174
- * This parameter is required for knowledge applications.
189
+ * Required for knowledge applications.
175
190
  */
176
191
  knowledgeApplicationSpecShrink?: string;
177
192
  /**
178
193
  * @remarks
179
- * This parameter is required for mem0 applications.
194
+ * Required for mem0 applications.
180
195
  */
181
196
  memApplicationSpecShrink?: string;
182
197
  /**
183
198
  * @remarks
184
- * The model API. This parameter is effective only when ApplicationType is set to polarclaw.
199
+ * The model API. This parameter takes effect only when ApplicationType is set to polarclaw.
185
200
  *
186
201
  * @example
187
202
  * openai-completions
@@ -189,7 +204,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
189
204
  modelApi?: string;
190
205
  /**
191
206
  * @remarks
192
- * The API key for the model. This parameter is effective only when ApplicationType is set to polarclaw.
207
+ * The model API key. This parameter takes effect only when ApplicationType is set to polarclaw.
193
208
  *
194
209
  * @example
195
210
  * sk-xxxxxx
@@ -197,7 +212,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
197
212
  modelApiKey?: string;
198
213
  /**
199
214
  * @remarks
200
- * The URL of the model. This parameter is effective only when ApplicationType is set to polarclaw.
215
+ * The model base URL. This parameter takes effect only when ApplicationType is set to polarclaw.
201
216
  *
202
217
  * @example
203
218
  * https://dashscope.aliyuncs.com/compatible-mode/v1
@@ -205,13 +220,11 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
205
220
  modelBaseUrl?: string;
206
221
  /**
207
222
  * @remarks
208
- * The source of the model. Valid values:
209
- *
210
- * - bailian: Alibaba Cloud Model Studio model.
223
+ * The model source. Valid values:
211
224
  *
212
- * - custom: A custom model.
213
- *
214
- * - maas: PolarDB model operator.
225
+ * * bailian: Alibaba Cloud Model Studio model.
226
+ * * custom: Custom model.
227
+ * * maas: PolarDB model operator.
215
228
  *
216
229
  * @example
217
230
  * bailian
@@ -219,7 +232,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
219
232
  modelFrom?: string;
220
233
  /**
221
234
  * @remarks
222
- * The name of the model. This parameter is effective only when ApplicationType is set to polarclaw.
235
+ * The model name. This parameter takes effect only when ApplicationType is set to polarclaw.
223
236
  *
224
237
  * @example
225
238
  * qwen3-max
@@ -227,12 +240,12 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
227
240
  modelName?: string;
228
241
  /**
229
242
  * @remarks
230
- * A list of parameters.
243
+ * The list of parameters.
231
244
  */
232
245
  parametersShrink?: string;
233
246
  /**
234
247
  * @remarks
235
- * The billing method.
248
+ * The billing type.
236
249
  *
237
250
  * @example
238
251
  * Postpaid
@@ -240,7 +253,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
240
253
  payType?: string;
241
254
  /**
242
255
  * @remarks
243
- * The subscription period type.
256
+ * The subscription type (yearly or monthly).
244
257
  *
245
258
  * @example
246
259
  * Year
@@ -248,12 +261,10 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
248
261
  period?: string;
249
262
  /**
250
263
  * @remarks
251
- * The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance. This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application.
252
- *
253
- * This feature is currently supported only by the following applications:
264
+ * The instance ID of the Polarlakebase cold storage or high-performance edition. Default value: empty. If specified, the corresponding storage is mounted to the application.
254
265
  *
266
+ * Currently, only the following applications support this parameter:
255
267
  * - supabase
256
- *
257
268
  * - raycluster
258
269
  *
259
270
  * @example
@@ -270,7 +281,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
270
281
  promotionCode?: string;
271
282
  /**
272
283
  * @remarks
273
- * The region. The default value is the region of the instance.
284
+ * The region. Default value: the region of the instance.
274
285
  *
275
286
  * @example
276
287
  * cn-beijing
@@ -278,7 +289,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
278
289
  regionId?: string;
279
290
  /**
280
291
  * @remarks
281
- * The ID of the resource group.
292
+ * The resource group ID.
282
293
  *
283
294
  * @example
284
295
  * rg-********************
@@ -286,7 +297,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
286
297
  resourceGroupId?: string;
287
298
  /**
288
299
  * @remarks
289
- * The ID of the security group.
300
+ * The security group ID.
290
301
  *
291
302
  * @example
292
303
  * sg-********************
@@ -294,7 +305,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
294
305
  securityGroupId?: string;
295
306
  /**
296
307
  * @remarks
297
- * The name of the IP address whitelist group. The default value is `default`.
308
+ * The name of the IP whitelist group. Default value: `default`.
298
309
  *
299
310
  * @example
300
311
  * default
@@ -302,7 +313,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
302
313
  securityIPArrayName?: string;
303
314
  /**
304
315
  * @remarks
305
- * The IP address whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
316
+ * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
306
317
  *
307
318
  * @example
308
319
  * 127.0.0.1,172.17.0.0/24
@@ -318,7 +329,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
318
329
  securityIPType?: string;
319
330
  /**
320
331
  * @remarks
321
- * The ID of the skill template.
332
+ * The skill template ID.
322
333
  *
323
334
  * @example
324
335
  * xxx
@@ -326,7 +337,15 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
326
337
  skillTemplateId?: string;
327
338
  /**
328
339
  * @remarks
329
- * The tag.
340
+ * The list of application storages.
341
+ *
342
+ * @example
343
+ * [{"StorageType":"oss","StorageInstanceId":"pfs-xxxx","EndpointId":"pe-xxxx"}]
344
+ */
345
+ storagesShrink?: string;
346
+ /**
347
+ * @remarks
348
+ * The tags.
330
349
  */
331
350
  tag?: CreateApplicationShrinkRequestTag[];
332
351
  /**
@@ -347,7 +366,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
347
366
  usedTime?: string;
348
367
  /**
349
368
  * @remarks
350
- * The vSwitch. The default value is the current vSwitch in the primary zone of the instance.
369
+ * The vSwitch. Default value: the vSwitch in the primary zone of the instance.
351
370
  *
352
371
  * @example
353
372
  * vsw-*********************
@@ -355,7 +374,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
355
374
  vSwitchId?: string;
356
375
  /**
357
376
  * @remarks
358
- * The ID of the Virtual Private Cloud (VPC).
377
+ * The VPC ID.
359
378
  *
360
379
  * @example
361
380
  * vpc-********************
@@ -363,7 +382,15 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
363
382
  vpcId?: string;
364
383
  /**
365
384
  * @remarks
366
- * The zone. The default value is the primary zone of the instance.
385
+ * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in an active state.
386
+ *
387
+ * @example
388
+ * ngw-xxx
389
+ */
390
+ vpcNatGatewayId?: string;
391
+ /**
392
+ * @remarks
393
+ * The zone. Default value: the primary zone of the instance.
367
394
  *
368
395
  * @example
369
396
  * cn-beijing-k
@@ -372,6 +399,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
372
399
  static names(): { [key: string]: string } {
373
400
  return {
374
401
  AIDBClusterId: 'AIDBClusterId',
402
+ agenticDBBranchSpecShrink: 'AgenticDBBranchSpec',
375
403
  applicationType: 'ApplicationType',
376
404
  architecture: 'Architecture',
377
405
  authProvider: 'AuthProvider',
@@ -383,6 +411,8 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
383
411
  componentsShrink: 'Components',
384
412
  DBClusterId: 'DBClusterId',
385
413
  description: 'Description',
414
+ dnatEntriesShrink: 'DnatEntries',
415
+ dnatIpAddress: 'DnatIpAddress',
386
416
  dryRun: 'DryRun',
387
417
  endpointsShrink: 'Endpoints',
388
418
  knowledgeApplicationSpecShrink: 'KnowledgeApplicationSpec',
@@ -404,11 +434,13 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
404
434
  securityIPList: 'SecurityIPList',
405
435
  securityIPType: 'SecurityIPType',
406
436
  skillTemplateId: 'SkillTemplateId',
437
+ storagesShrink: 'Storages',
407
438
  tag: 'Tag',
408
439
  targetVersion: 'TargetVersion',
409
440
  usedTime: 'UsedTime',
410
441
  vSwitchId: 'VSwitchId',
411
442
  vpcId: 'VpcId',
443
+ vpcNatGatewayId: 'VpcNatGatewayId',
412
444
  zoneId: 'ZoneId',
413
445
  };
414
446
  }
@@ -416,6 +448,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
416
448
  static types(): { [key: string]: any } {
417
449
  return {
418
450
  AIDBClusterId: 'string',
451
+ agenticDBBranchSpecShrink: 'string',
419
452
  applicationType: 'string',
420
453
  architecture: 'string',
421
454
  authProvider: 'string',
@@ -427,6 +460,8 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
427
460
  componentsShrink: 'string',
428
461
  DBClusterId: 'string',
429
462
  description: 'string',
463
+ dnatEntriesShrink: 'string',
464
+ dnatIpAddress: 'string',
430
465
  dryRun: 'boolean',
431
466
  endpointsShrink: 'string',
432
467
  knowledgeApplicationSpecShrink: 'string',
@@ -448,11 +483,13 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
448
483
  securityIPList: 'string',
449
484
  securityIPType: 'string',
450
485
  skillTemplateId: 'string',
486
+ storagesShrink: 'string',
451
487
  tag: { 'type': 'array', 'itemType': CreateApplicationShrinkRequestTag },
452
488
  targetVersion: 'string',
453
489
  usedTime: 'string',
454
490
  vSwitchId: 'string',
455
491
  vpcId: 'string',
492
+ vpcNatGatewayId: 'string',
456
493
  zoneId: 'string',
457
494
  };
458
495
  }