@alicloud/sae20190506 2.12.3 → 2.12.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.
Files changed (43) hide show
  1. package/dist/client.d.ts +8 -8
  2. package/dist/client.js +23 -8
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateApplicationRequest.d.ts +232 -333
  5. package/dist/models/CreateApplicationRequest.js +29 -1
  6. package/dist/models/CreateApplicationRequest.js.map +1 -1
  7. package/dist/models/CreateApplicationResponseBody.d.ts +14 -21
  8. package/dist/models/CreateApplicationResponseBody.js.map +1 -1
  9. package/dist/models/CreateApplicationShrinkRequest.d.ts +217 -333
  10. package/dist/models/CreateApplicationShrinkRequest.js +2 -0
  11. package/dist/models/CreateApplicationShrinkRequest.js.map +1 -1
  12. package/dist/models/DeployApplicationRequest.d.ts +261 -382
  13. package/dist/models/DeployApplicationRequest.js +29 -1
  14. package/dist/models/DeployApplicationRequest.js.map +1 -1
  15. package/dist/models/DeployApplicationResponseBody.d.ts +20 -27
  16. package/dist/models/DeployApplicationResponseBody.js.map +1 -1
  17. package/dist/models/DeployApplicationShrinkRequest.d.ts +246 -382
  18. package/dist/models/DeployApplicationShrinkRequest.js +2 -0
  19. package/dist/models/DeployApplicationShrinkRequest.js.map +1 -1
  20. package/dist/models/DescribeApplicationConfigResponseBody.d.ts +299 -404
  21. package/dist/models/DescribeApplicationConfigResponseBody.js +29 -1
  22. package/dist/models/DescribeApplicationConfigResponseBody.js.map +1 -1
  23. package/dist/models/ListApplicationsRequest.d.ts +42 -61
  24. package/dist/models/ListApplicationsRequest.js +2 -0
  25. package/dist/models/ListApplicationsRequest.js.map +1 -1
  26. package/dist/models/ListApplicationsResponseBody.d.ts +77 -101
  27. package/dist/models/ListApplicationsResponseBody.js +2 -0
  28. package/dist/models/ListApplicationsResponseBody.js.map +1 -1
  29. package/dist/models/model.d.ts +3 -0
  30. package/dist/models/model.js +37 -31
  31. package/dist/models/model.js.map +1 -1
  32. package/package.json +1 -1
  33. package/src/client.ts +28 -8
  34. package/src/models/CreateApplicationRequest.ts +252 -334
  35. package/src/models/CreateApplicationResponseBody.ts +14 -21
  36. package/src/models/CreateApplicationShrinkRequest.ts +220 -334
  37. package/src/models/DeployApplicationRequest.ts +281 -383
  38. package/src/models/DeployApplicationResponseBody.ts +20 -27
  39. package/src/models/DeployApplicationShrinkRequest.ts +249 -383
  40. package/src/models/DescribeApplicationConfigResponseBody.ts +319 -405
  41. package/src/models/ListApplicationsRequest.ts +44 -61
  42. package/src/models/ListApplicationsResponseBody.ts +79 -101
  43. package/src/models/model.ts +3 -0
@@ -4,10 +4,39 @@ import { InitContainerConfig } from "./InitContainerConfig";
4
4
  import { SidecarContainerConfig } from "./SidecarContainerConfig";
5
5
 
6
6
 
7
+ export class DeployApplicationRequestRaspConfig extends $dara.Model {
8
+ enableRasp?: boolean;
9
+ raspAppKey?: string;
10
+ raspAppName?: string;
11
+ static names(): { [key: string]: string } {
12
+ return {
13
+ enableRasp: 'EnableRasp',
14
+ raspAppKey: 'RaspAppKey',
15
+ raspAppName: 'RaspAppName',
16
+ };
17
+ }
18
+
19
+ static types(): { [key: string]: any } {
20
+ return {
21
+ enableRasp: 'boolean',
22
+ raspAppKey: 'string',
23
+ raspAppName: 'string',
24
+ };
25
+ }
26
+
27
+ validate() {
28
+ super.validate();
29
+ }
30
+
31
+ constructor(map?: { [key: string]: any }) {
32
+ super(map);
33
+ }
34
+ }
35
+
7
36
  export class DeployApplicationRequest extends $dara.Model {
8
37
  /**
9
38
  * @remarks
10
- * The ARN of the RAM role required to pull images across accounts. For more information, see [Authorize cross-account image pulls using RAM roles](https://help.aliyun.com/document_detail/223585.html).
39
+ * The ARN of the RAM role required for cross-account image pulling. For more information, see [Grant permissions across Alibaba Cloud accounts by using a RAM role](https://help.aliyun.com/document_detail/223585.html).
11
40
  *
12
41
  * @example
13
42
  * acs:ram::123456789012****:role/adminrole
@@ -15,7 +44,7 @@ export class DeployApplicationRequest extends $dara.Model {
15
44
  acrAssumeRoleArn?: string;
16
45
  /**
17
46
  * @remarks
18
- * The Container Registry Enterprise Edition instance ID. Required when **ImageUrl** is from Container Registry Enterprise Edition.
47
+ * The Container Registry Enterprise instance ID. This parameter is required when **ImageUrl** is set to a Container Registry Enterprise instance image.
19
48
  *
20
49
  * @example
21
50
  * cri-xxxxxx
@@ -31,7 +60,7 @@ export class DeployApplicationRequest extends $dara.Model {
31
60
  agentVersion?: string;
32
61
  /**
33
62
  * @remarks
34
- * The ALB gateway readiness gate configuration.
63
+ * The ALB gateway ReadinessGate configuration.
35
64
  *
36
65
  * @example
37
66
  * default
@@ -49,11 +78,10 @@ export class DeployApplicationRequest extends $dara.Model {
49
78
  appId?: string;
50
79
  /**
51
80
  * @remarks
52
- * Whether to associate an EIP. Values:
53
- *
54
- * - **true**: Associate.
81
+ * Specifies whether to associate an elastic IP address (EIP). Valid values:
55
82
  *
56
- * - **false**: Do not associate.
83
+ * - **true**: associates an EIP.
84
+ * - **false**: does not associate an EIP.
57
85
  *
58
86
  * @example
59
87
  * true
@@ -61,11 +89,9 @@ export class DeployApplicationRequest extends $dara.Model {
61
89
  associateEip?: boolean;
62
90
  /**
63
91
  * @remarks
64
- * Whether to automatically enable application Auto Scaling rules. Values:
65
- *
66
- * - **true**: Enable.
67
- *
68
- * - **false**: Disable.
92
+ * Specifies whether to automatically enable the application elastic scaling policy. Valid values:
93
+ * - **true**: enabled.
94
+ * - **false**: disabled.
69
95
  *
70
96
  * @example
71
97
  * true
@@ -73,7 +99,7 @@ export class DeployApplicationRequest extends $dara.Model {
73
99
  autoEnableApplicationScalingRule?: boolean;
74
100
  /**
75
101
  * @remarks
76
- * The wait time between batches, in seconds.
102
+ * The interval between deployment batches. Unit: seconds.
77
103
  *
78
104
  * @example
79
105
  * 10
@@ -81,7 +107,7 @@ export class DeployApplicationRequest extends $dara.Model {
81
107
  batchWaitTime?: number;
82
108
  /**
83
109
  * @remarks
84
- * The description of the release task.
110
+ * The description of the change order.
85
111
  *
86
112
  * @example
87
113
  * Start application
@@ -89,7 +115,7 @@ export class DeployApplicationRequest extends $dara.Model {
89
115
  changeOrderDesc?: string;
90
116
  /**
91
117
  * @remarks
92
- * The startup command for your image. This command must be an executable object inside the container. Example:
118
+ * The image startup command. The command must be an executable object in the container. Example:
93
119
  *
94
120
  * ```
95
121
  * command:
@@ -98,8 +124,7 @@ export class DeployApplicationRequest extends $dara.Model {
98
124
  * - >
99
125
  * - file0
100
126
  * ```
101
- *
102
- * In this example, Command="echo" and `CommandArgs=["abc", ">", "file0"]`.
127
+ * Based on the preceding example, `Command="echo", CommandArgs=["abc", ">", "file0"]`.
103
128
  *
104
129
  * @example
105
130
  * echo
@@ -107,11 +132,11 @@ export class DeployApplicationRequest extends $dara.Model {
107
132
  command?: string;
108
133
  /**
109
134
  * @remarks
110
- * The arguments for the startup command **Command**. Format:
135
+ * The arguments of the image startup command. These are the arguments required by the startup command specified in **Command**. Format:
111
136
  *
112
137
  * `["a","b"]`
113
138
  *
114
- * In the earlier example, `CommandArgs=["abc", ">", "file0"]`. The value `["abc", ">", "file0"]` must be converted to a string in JSON array format. Leave this field empty if no arguments are needed.
139
+ * In the preceding example, `CommandArgs=["abc", ">", "file0"]`, where `["abc", ">", "file0"]` must be converted to a String type, and the internal format is a JSON array. If this parameter is not required, leave it empty.
115
140
  *
116
141
  * @example
117
142
  * ["a","b"]
@@ -119,15 +144,14 @@ export class DeployApplicationRequest extends $dara.Model {
119
144
  commandArgs?: string;
120
145
  /**
121
146
  * @remarks
122
- * The mount description for a **ConfigMap**. Use configuration items created on the namespace configuration page to inject configuration into your container. Parameters:
147
+ * The **ConfigMap** mount description. Use a ConfigMap created on the namespace configuration items page to inject configuration information into the container. Settings:
123
148
  *
124
- * - **configMapId**: The ID of the ConfigMap instance. Get it by calling the [ListNamespacedConfigMaps](https://help.aliyun.com/document_detail/176917.html) API.
149
+ * - **configMapId**: the ConfigMap instance ID. You can obtain it by calling the [ListNamespacedConfigMaps](https://help.aliyun.com/document_detail/176917.html) operation.
150
+ * - **key**: the key.
125
151
  *
126
- * - **key**: The key.
152
+ * > You can mount all keys by passing the `sae-sys-configmap-all` parameter.
127
153
  *
128
- * > You can mount all keys by passing `sae-sys-configmap-all`.
129
- *
130
- * - **mountPath**: The mount path.
154
+ * - **mountPath**: the mount path.
131
155
  *
132
156
  * @example
133
157
  * [{"configMapId":16,"key":"test","mountPath":"/tmp"}]
@@ -135,22 +159,14 @@ export class DeployApplicationRequest extends $dara.Model {
135
159
  configMapMountDesc?: string;
136
160
  /**
137
161
  * @remarks
138
- * The CPU required per instance, in milliCPU. Cannot be zero. Supported fixed specifications:
139
- *
162
+ * The CPU resources required for each instance. Unit: millicores. This parameter cannot be set to 0. Only the following defined specifications are supported:
140
163
  * - **500**
141
- *
142
164
  * - **1000**
143
- *
144
165
  * - **2000**
145
- *
146
166
  * - **4000**
147
- *
148
167
  * - **8000**
149
- *
150
168
  * - **12000**
151
- *
152
169
  * - **16000**
153
- *
154
170
  * - **32000**
155
171
  *
156
172
  * @example
@@ -159,11 +175,10 @@ export class DeployApplicationRequest extends $dara.Model {
159
175
  cpu?: number;
160
176
  /**
161
177
  * @remarks
162
- * Custom host mappings inside your container. Values:
163
- *
164
- * - **hostName**: A domain name or hostname.
178
+ * The custom host mapping in the container. Valid values:
165
179
  *
166
- * - **ip**: An IP address.
180
+ * - **hostName**: the domain name or hostname.
181
+ * - **ip**: the IP address.
167
182
  *
168
183
  * @example
169
184
  * [{"hostName":"samplehost","ip":"127.0.0.1"}]
@@ -171,11 +186,10 @@ export class DeployApplicationRequest extends $dara.Model {
171
186
  customHostAlias?: string;
172
187
  /**
173
188
  * @remarks
174
- * The custom image type. Set to an empty string for non-custom images:
189
+ * The custom image type. If the image is not a custom image, set this parameter to an empty string:
175
190
  *
176
- * - internet: Public network image
177
- *
178
- * - intranet: Private network image
191
+ * - internet: public image.
192
+ * - intranet: private image.
179
193
  *
180
194
  * @example
181
195
  * internet
@@ -183,11 +197,9 @@ export class DeployApplicationRequest extends $dara.Model {
183
197
  customImageNetworkType?: string;
184
198
  /**
185
199
  * @remarks
186
- * This parameter applies only to stopped applications. If you call **DeployApplication** on a running application, it deploys immediately.
187
- *
188
- * - **true**: Default. Deploys immediately, applies the new configuration, and starts instances.
189
- *
190
- * - **false**: Applies the new configuration only. Does not start application instances.
200
+ * This parameter takes effect only for applications in the stopped state. If you call the **DeployApplication** operation for a running application, the application is immediately redeployed.
201
+ * - **true**: default value. Deploys immediately, applies the new deployment configuration, and starts instances.
202
+ * - **false**: applies the new deployment configuration only, without starting application instances.
191
203
  *
192
204
  * @example
193
205
  * true
@@ -195,16 +207,12 @@ export class DeployApplicationRequest extends $dara.Model {
195
207
  deploy?: string;
196
208
  /**
197
209
  * @remarks
198
- * The .NET framework version:
210
+ * The version of the .NET framework:
199
211
  *
200
212
  * - .NET 3.1
201
- *
202
213
  * - .NET 5.0
203
- *
204
214
  * - .NET 6.0
205
- *
206
215
  * - .NET 7.0
207
- *
208
216
  * - .NET 8.0
209
217
  *
210
218
  * @example
@@ -213,7 +221,7 @@ export class DeployApplicationRequest extends $dara.Model {
213
221
  dotnet?: string;
214
222
  /**
215
223
  * @remarks
216
- * The version of the application runtime environment for HSF applications, such as Ali-Tomcat containers.
224
+ * The version of the application runtime environment in the HSF framework, such as the Ali-Tomcat container.
217
225
  *
218
226
  * @example
219
227
  * 3.5.3
@@ -221,7 +229,7 @@ export class DeployApplicationRequest extends $dara.Model {
221
229
  edasContainerVersion?: string;
222
230
  /**
223
231
  * @remarks
224
- * The configuration for shared temporary storage.
232
+ * The shared ephemeral storage configuration.
225
233
  *
226
234
  * @example
227
235
  * [{\\"name\\":\\"workdir\\",\\"mountPath\\":\\"/usr/local/tomcat/webapps\\"}]
@@ -229,11 +237,10 @@ export class DeployApplicationRequest extends $dara.Model {
229
237
  emptyDirDesc?: string;
230
238
  /**
231
239
  * @remarks
232
- * Whether to integrate with AHAS. Values:
240
+ * Specifies whether to enable Application High Availability Service (AHAS). Valid values:
233
241
  *
234
- * - **true**: Integrate with AHAS.
235
- *
236
- * - **false**: Do not integrate with AHAS.
242
+ * - **true**: enables AHAS.
243
+ * - **false**: does not enable AHAS.
237
244
  *
238
245
  * @example
239
246
  * false
@@ -241,11 +248,10 @@ export class DeployApplicationRequest extends $dara.Model {
241
248
  enableAhas?: string;
242
249
  /**
243
250
  * @remarks
244
- * Whether to enable CPU Burst:
245
- *
246
- * - true: Enable.
251
+ * Specifies whether to enable the CPU Burst feature:
247
252
  *
248
- * - false: Do not enable.
253
+ * - true: enabled.
254
+ * - false: disabled.
249
255
  *
250
256
  * @example
251
257
  * true
@@ -253,11 +259,10 @@ export class DeployApplicationRequest extends $dara.Model {
253
259
  enableCpuBurst?: boolean;
254
260
  /**
255
261
  * @remarks
256
- * Whether to enable traffic canary rules. These rules apply only to Spring Cloud and Dubbo applications. Values:
257
- *
258
- * - **true**: Enable canary rules.
262
+ * Specifies whether to enable traffic canary release rules. This rule applies only to applications that use the Spring Cloud or Dubbo framework. Valid values:
259
263
  *
260
- * - **false**: Disable canary rules.
264
+ * - **true**: enables canary release rules.
265
+ * - **false**: disables canary release rules.
261
266
  *
262
267
  * @example
263
268
  * false
@@ -265,7 +270,7 @@ export class DeployApplicationRequest extends $dara.Model {
265
270
  enableGreyTagRoute?: boolean;
266
271
  /**
267
272
  * @remarks
268
- * Whether to reuse the namespace Agent version configuration.
273
+ * Specifies whether to reuse the namespace Agent version configuration.
269
274
  *
270
275
  * @example
271
276
  * true
@@ -273,11 +278,10 @@ export class DeployApplicationRequest extends $dara.Model {
273
278
  enableNamespaceAgentVersion?: boolean;
274
279
  /**
275
280
  * @remarks
276
- * Whether to enable the new ARMS feature:
281
+ * Specifies whether to enable the new ARMS feature:
277
282
  *
278
- * - true: Enable.
279
- *
280
- * - false: Do not enable.
283
+ * - true: enabled.
284
+ * - false: disabled.
281
285
  *
282
286
  * @example
283
287
  * true
@@ -285,7 +289,7 @@ export class DeployApplicationRequest extends $dara.Model {
285
289
  enableNewArms?: boolean;
286
290
  /**
287
291
  * @remarks
288
- * Whether to enable Prometheus custom metric collection.
292
+ * Specifies whether to enable custom Prometheus metric collection.
289
293
  *
290
294
  * @example
291
295
  * false
@@ -293,11 +297,10 @@ export class DeployApplicationRequest extends $dara.Model {
293
297
  enablePrometheus?: boolean;
294
298
  /**
295
299
  * @remarks
296
- * Whether to isolate sidecar resources:
297
- *
298
- * - true: Isolate.
300
+ * Specifies whether to enable sidecar resource isolation:
299
301
  *
300
- * - false: Do not isolate.
302
+ * - true: enables isolation.
303
+ * - false: does not enable isolation.
301
304
  *
302
305
  * @example
303
306
  * true
@@ -305,33 +308,20 @@ export class DeployApplicationRequest extends $dara.Model {
305
308
  enableSidecarResourceIsolated?: boolean;
306
309
  /**
307
310
  * @remarks
308
- * The environment variables for your container. You can define custom variables or reference configuration items. To reference a configuration item, first create a ConfigMap instance. For more information, see [CreateConfigMap](https://help.aliyun.com/document_detail/176914.html). Values:
309
- *
311
+ * The container environment variable parameters. You can customize environment variables or reference ConfigMap items. To reference a ConfigMap item, create a ConfigMap instance first. For more information, see [CreateConfigMap](https://help.aliyun.com/document_detail/176914.html). Valid values:
310
312
  * - Custom configuration
311
- *
312
- * - **name**: The name of the environment variable.
313
- *
314
- * - **value**: The value of the environment variable. Takes precedence over valueFrom.
315
- *
316
- * - Reference a configuration item (valueFrom)
317
- *
318
- * - **name**: The name of the environment variable. You can reference a single key or all keys. To reference all keys, use `sae-sys-configmap-all-<configmap-name>`, for example `sae-sys-configmap-all-test1`.
319
- *
320
- * - **valueFrom**: The reference type. Set to `configMapRef`.
321
- *
322
- * - **configMapId**: The ID of the ConfigMap instance.
323
- *
324
- * - **key**: The key. Omit this field if you reference all keys.
325
- *
313
+ * - **name**: the name of the environment variable.
314
+ * - **value**: the value of the environment variable. This takes priority over valueFrom.
315
+ * - Reference a ConfigMap item (valueFrom)
316
+ * - **name**: the name of the environment variable. To reference all keys, enter `sae-sys-configmap-all-<ConfigMap name>`, such as `sae-sys-configmap-all-test1`.
317
+ * - **valueFrom**: the environment variable reference. Set the value to `configMapRef`.
318
+ * - **configMapId**: the ConfigMap ID.
319
+ * - **key**: the key. Do not set this field if you want to reference all keys.
326
320
  * - Reference a secret (valueFrom)
327
- *
328
- * - **name**: The name of the environment variable. You can reference a single key or all keys. To reference all keys, use `sae-sys-secret-all-<secret-name>`, for example `sae-sys-secret-all-test1`.
329
- *
330
- * - **valueFrom**: The reference type. Set to `secretRef`.
331
- *
332
- * - **secretId**: The ID of the secret.
333
- *
334
- * - **key**: The key. Omit this field if you reference all keys.
321
+ * - **name**: the name of the environment variable. To reference all keys, enter `sae-sys-secret-all-<secret name>`, such as `sae-sys-secret-all-test1`.
322
+ * - **valueFrom**: the environment variable reference. Set the value to `secretRef`.
323
+ * - **secretId**: the secret ID.
324
+ * - **key**: the key. Do not set this field if you want to reference all keys.
335
325
  *
336
326
  * @example
337
327
  * [ { "name": "sae-sys-configmap-all-hello", "valueFrom": { "configMapRef": { "configMapId": 100, "key": "" } } }, { "name": "hello", "valueFrom": { "configMapRef": { "configMapId": 101, "key": "php-fpm" } } }, { "name": "sae-sys-secret-all-hello", "valueFrom": { “secretRef": { “secretId": 100, "key": "" } } }, { "name": “password”, "valueFrom": { “secretRef": { “secretId": 101, "key": “password” } } }, { "name": "envtmp", "value": "newenv" } ]
@@ -340,16 +330,11 @@ export class DeployApplicationRequest extends $dara.Model {
340
330
  gpuConfig?: string;
341
331
  /**
342
332
  * @remarks
343
- * The Nginx version:
344
- *
333
+ * The Nginx version.
345
334
  * - nginx 1.20
346
- *
347
335
  * - nginx 1.22
348
- *
349
336
  * - nginx 1.24
350
- *
351
337
  * - nginx 1.26
352
- *
353
338
  * - nginx 1.28
354
339
  *
355
340
  * @example
@@ -358,7 +343,7 @@ export class DeployApplicationRequest extends $dara.Model {
358
343
  html?: string;
359
344
  /**
360
345
  * @remarks
361
- * The ID of the corresponding secret.
346
+ * The corresponding secret ID.
362
347
  *
363
348
  * @example
364
349
  * 10
@@ -366,7 +351,7 @@ export class DeployApplicationRequest extends $dara.Model {
366
351
  imagePullSecrets?: string;
367
352
  /**
368
353
  * @remarks
369
- * The registry address of your image. Required when **Package Type** is **Image**.
354
+ * The image URL. This parameter is required when **Package Type** is set to **Image**.
370
355
  *
371
356
  * @example
372
357
  * registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1
@@ -374,12 +359,12 @@ export class DeployApplicationRequest extends $dara.Model {
374
359
  imageUrl?: string;
375
360
  /**
376
361
  * @remarks
377
- * The initialization container configuration.
362
+ * The init container configuration.
378
363
  */
379
364
  initContainersConfig?: InitContainerConfig[];
380
365
  /**
381
366
  * @remarks
382
- * Startup arguments for your JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`
367
+ * The startup arguments for a JAR package-based application. The default startup command is `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`.
383
368
  *
384
369
  * @example
385
370
  * -Xms4G -Xmx4G
@@ -387,7 +372,7 @@ export class DeployApplicationRequest extends $dara.Model {
387
372
  jarStartArgs?: string;
388
373
  /**
389
374
  * @remarks
390
- * Startup options for your JAR package. Default startup command: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`
375
+ * The startup options for a JAR package-based application. The default startup command is `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`.
391
376
  *
392
377
  * @example
393
378
  * custom-option
@@ -395,21 +380,16 @@ export class DeployApplicationRequest extends $dara.Model {
395
380
  jarStartOptions?: string;
396
381
  /**
397
382
  * @remarks
398
- * The JDK version that your deployment package depends on. Supported versions include the following:
383
+ * The JDK version on which the deployment package depends. Valid values:
399
384
  *
400
385
  * - **Open JDK 8**
401
- *
402
386
  * - **Open JDK 7**
403
- *
404
387
  * - **Dragonwell 11**
405
- *
406
388
  * - **Dragonwell 8**
407
- *
408
389
  * - **openjdk-8u191-jdk-alpine3.9**
409
- *
410
390
  * - **openjdk-7u201-jdk-alpine3.9**
411
391
  *
412
- * This parameter is not supported when **Package Type** is **Image**.
392
+ * This parameter is not supported when **Package Type** is set to **Image**.
413
393
  *
414
394
  * @example
415
395
  * Open JDK 8
@@ -417,13 +397,11 @@ export class DeployApplicationRequest extends $dara.Model {
417
397
  jdk?: string;
418
398
  /**
419
399
  * @remarks
420
- * The configuration for collecting logs to Kafka. Values:
421
- *
422
- * - **kafkaEndpoint**: The endpoint for the Kafka API.
423
- *
424
- * - **kafkaInstanceId**: The Kafka instance ID.
400
+ * The summary of log collection configurations for Kafka. Valid values:
425
401
  *
426
- * - **kafkaConfigs**: The configuration for one or more log entries. For examples and details, see the \\*\\*kafkaConfigs\\*\\* request parameter in this topic.
402
+ * - **kafkaEndpoint**: the endpoint of the Kafka API.
403
+ * - **kafkaInstanceId**: the Kafka instance ID.
404
+ * - **kafkaConfigs**: the configuration summary for one or more log entries. For example values and parameter descriptions, see the **kafkaConfigs** request parameter in this topic.
427
405
  *
428
406
  * @example
429
407
  * {"kafkaEndpoint":"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX","kafkaInstanceId":"alikafka_pre-cn-7pp2l8kr****","kafkaConfigs":[{"logType":"file_log","logDir":"/tmp/a.log","kafkaTopic":"test2"},{"logType":"stdout","logDir":"","kafkaTopic":"test"}]}
@@ -432,35 +410,25 @@ export class DeployApplicationRequest extends $dara.Model {
432
410
  labels?: { [key: string]: string };
433
411
  /**
434
412
  * @remarks
435
- * Health checks for your container. Containers that fail health checks are terminated and restarted. Supported methods:
413
+ * The container health check. Containers that fail the health check are shutdown and recovered. The following methods are supported:
436
414
  *
437
- * - **exec**: For example, `{"exec":{"command":["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}`
415
+ * - **exec**: for example, `{"exec":{"command":["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}`
416
+ * - **httpGet**: for example, `{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}`
417
+ * - **tcpSocket**: for example, `{"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}`
438
418
  *
439
- * - **httpGet**: For example, `{"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}`
419
+ * > Only one method can be selected for health checks.
440
420
  *
441
- * - **tcpSocket**: For example, `{"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}`
442
- *
443
- * > You can select only one health check method.
444
- *
445
- * Parameters:
446
- *
447
- * - **exec.command**: The health check command.
448
- *
449
- * - **httpGet.path**: The path to access.
421
+ * Settings:
450
422
  *
423
+ * - **exec.command**: sets the health check command.
424
+ * - **httpGet.path**: the access path.
451
425
  * - **httpGet.scheme**: **HTTP** or **HTTPS**.
452
- *
453
- * - **httpGet.isContainKeyWord**: **true** means the response contains a keyword. **false** means it does not. If omitted, advanced features are disabled.
454
- *
455
- * - **httpGet.keyWord**: Your custom keyword. Include **isContainKeyWord** when using this field.
456
- *
457
- * - **tcpSocket.port**: The port for TCP connection checks.
458
- *
459
- * - **initialDelaySeconds**: The delay before the first health check, in seconds. Default is 10.
460
- *
461
- * - **periodSeconds**: The interval between health checks, in seconds. Default is 30.
462
- *
463
- * - **timeoutSeconds**: The timeout for each health check, in seconds. Default is 1. If set to 0 or omitted, the default is 1 second.
426
+ * - **httpGet.isContainKeyWord**: **true** indicates that the keyword is included, **false** indicates that the keyword is not included, and the absence of this field indicates that the advanced feature is not used.
427
+ * - **httpGet.keyWord**: the custom keyword. The **isContainKeyWord** field must be present when this parameter is used.
428
+ * - **tcpSocket.port**: the port for TCP connection detection.
429
+ * - **initialDelaySeconds**: sets the initial delay for the health check. Default value: 10. Unit: seconds.
430
+ * - **periodSeconds**: sets the health check epoch. Default value: 30. Unit: seconds.
431
+ * - **timeoutSeconds**: sets the health check timeout period. Default value: 1. Unit: seconds. If this parameter is set to 0 or is not set, the default timeout period is 1 second.
464
432
  *
465
433
  * @example
466
434
  * {"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}
@@ -469,9 +437,9 @@ export class DeployApplicationRequest extends $dara.Model {
469
437
  lokiConfigs?: string;
470
438
  /**
471
439
  * @remarks
472
- * The maximum number of surge instances as a percentage of total instances. Values:
440
+ * The maximum surge instance percentage. Valid values:
473
441
  *
474
- * If the minimum available instances is 100%, the maximum surge cannot be set to 0. If set to -1, the system uses its recommended value: 30% of your current instance count. For example, with 10 instances, 10 × 30% = 3.
442
+ * If the minimum number of available instances is 100%, the maximum surge cannot be set to 0. If this parameter is set to **-1**, the system-recommended value of 30% is used, which is 30% of the current number of instances. For example, if the current number of instances is 10, the value is 10 × 30% = 3.
475
443
  *
476
444
  * @example
477
445
  * -1
@@ -479,9 +447,10 @@ export class DeployApplicationRequest extends $dara.Model {
479
447
  maxSurgeInstanceRatio?: number;
480
448
  /**
481
449
  * @remarks
482
- * The maximum number of surge instances during a rolling update. Values:
450
+ * The maximum number of surge instances. Valid values:
483
451
  *
484
- * If the minimum available instances is 100%, the maximum surge cannot be set to 0. If set to -1, the system uses its recommended value: 30% of your current instance count. For example, with 10 instances, 10 × 30% = 3.
452
+ * If the minimum number of available instances is 100%, the maximum surge cannot be set to 0.
453
+ * If this parameter is set to **-1**, the system-recommended value of 30% is used, which is 30% of the current number of instances. For example, if the current number of instances is 10, the value is 10 × 30% = 3.
485
454
  *
486
455
  * @example
487
456
  * -1
@@ -489,27 +458,17 @@ export class DeployApplicationRequest extends $dara.Model {
489
458
  maxSurgeInstances?: number;
490
459
  /**
491
460
  * @remarks
492
- * The memory required per instance, in MB. Cannot be zero. Memory and CPU are paired. Supported fixed specifications:
493
- *
494
- * - **1024**: Pairs with 500 and 1000 milliCPU.
495
- *
496
- * - **2048**: Pairs with 500, 1000, and 2000 milliCPU.
497
- *
498
- * - **4096**: Pairs with 1000, 2000, and 4000 milliCPU.
499
- *
500
- * - **8192**: Pairs with 2000, 4000, and 8000 milliCPU.
501
- *
502
- * - **12288**: Pairs with 12000 milliCPU.
503
- *
504
- * - **16384**: Pairs with 4000, 8000, and 16000 milliCPU.
505
- *
506
- * - **24576**: Pairs with 12000 milliCPU.
507
- *
508
- * - **32768**: Pairs with 16000 milliCPU.
509
- *
510
- * - **65536**: Pairs with 8000, 16000, and 32000 milliCPU.
511
- *
512
- * - **131072**: Pairs with 32000 milliCPU.
461
+ * The memory required for each instance. Unit: MB. This parameter cannot be set to 0. The memory has a one-to-one mapping with CPU. Only the following defined specifications are supported:
462
+ * - **1024**: corresponds to 500 and 1000 millicores of CPU.
463
+ * - **2048**: corresponds to 500, 1000, and 2000 millicores of CPU.
464
+ * - **4096**: corresponds to 1000, 2000, and 4000 millicores of CPU.
465
+ * - **8192**: corresponds to 2000, 4000, and 8000 millicores of CPU.
466
+ * - **12288**: corresponds to 12000 millicores of CPU.
467
+ * - **16384**: corresponds to 4000, 8000, and 16000 millicores of CPU.
468
+ * - **24576**: corresponds to 12000 millicores of CPU.
469
+ * - **32768**: corresponds to 16000 millicores of CPU.
470
+ * - **65536**: corresponds to 8000, 16000, and 32000 millicores of CPU.
471
+ * - **131072**: corresponds to 32000 millicores of CPU.
513
472
  *
514
473
  * @example
515
474
  * 1024
@@ -517,15 +476,12 @@ export class DeployApplicationRequest extends $dara.Model {
517
476
  memory?: number;
518
477
  /**
519
478
  * @remarks
520
- * Select a Nacos registry center. Values:
479
+ * Specifies the Nacos registry. Valid values:
480
+ * - **0**: Serverless App Engine built-in Nacos.
481
+ * - **1**: self-managed Nacos.
482
+ * - **2**: Microservices Engine (MSE) commercial edition Nacos.
521
483
  *
522
- * - **0**: Built-in Nacos in SAE.
523
- *
524
- * - **1**: Self-managed Nacos.
525
- *
526
- * - **2**: MSE Nacos Commercial Edition.
527
- *
528
- * > If you select built-in Nacos in SAE, you cannot retrieve its configuration.
484
+ * > If you select Serverless App Engine built-in Nacos, you cannot obtain the configuration of the built-in Nacos.
529
485
  *
530
486
  * @example
531
487
  * "0"
@@ -533,7 +489,7 @@ export class DeployApplicationRequest extends $dara.Model {
533
489
  microRegistration?: string;
534
490
  /**
535
491
  * @remarks
536
- * The registry configuration. Applies only when the registry type is MSE Nacos Enterprise Edition.
492
+ * The registry configuration, which takes effect only when the registry type is MSE Nacos Enterprise Edition.
537
493
  *
538
494
  * @example
539
495
  * {\\"instanceId\\":\\"mse-cn-zvp2bh6h70r\\",\\"namespace\\":\\"4c0aa74f-57cb-423c-b6af-5d9f2d0e3dbd\\"}
@@ -541,23 +497,23 @@ export class DeployApplicationRequest extends $dara.Model {
541
497
  microRegistrationConfig?: string;
542
498
  /**
543
499
  * @remarks
544
- * Configure microservice governance features.
500
+ * Configures microservice governance.
545
501
  *
546
- * - Enable microservice governance (enable):
502
+ * - Specifies whether to enable microservice governance (enable):
547
503
  *
548
- * - true: Enable
504
+ * - true: enabled.
549
505
  *
550
- * - false: Disable
506
+ * - false: disabled.
551
507
  *
552
- * - Configure graceful start and shutdown (mseLosslessRule):
508
+ * - Configures lossless online/offline (mseLosslessRule):
553
509
  *
554
- * - delayTime: Delay time
510
+ * - delayTime: the delay time.
555
511
  *
556
- * - enable: Whether to enable graceful start. true enables it. false disables it.
512
+ * - enable: specifies whether to enable the lossless online feature. true indicates enabled, and false indicates disabled.
557
513
  *
558
- * - notice: Whether to enable notifications. true enables them. false disables them.
514
+ * - notice: specifies whether to enable the notification feature. true indicates enabled, and false indicates disabled.
559
515
  *
560
- * - warmupTime: Warm-up duration for small traffic, in seconds.
516
+ * - warmupTime: the warm-up duration for low-traffic scenarios. Unit: seconds.
561
517
  *
562
518
  * @example
563
519
  * {"enable": true,"mseLosslessRule": {"delayTime": 0,"enable": false,"notice": false,"warmupTime": 120}}
@@ -565,13 +521,12 @@ export class DeployApplicationRequest extends $dara.Model {
565
521
  microserviceEngineConfig?: string;
566
522
  /**
567
523
  * @remarks
568
- * The minimum number of available instances as a percentage of total instances. Values:
524
+ * The minimum percentage of available instances. Valid values:
569
525
  *
570
- * - **-1**: Use the default value. No percentage is applied.
526
+ * - **-1**: the initialization value, which indicates that the percentage is not used.
527
+ * - **0~100**: the unit is percentage, rounded up. For example, if this parameter is set to **50**% and the current number of instances is 5, the minimum number of available instances is 3.
571
528
  *
572
- * - **0–100**: Percentage value. Rounded up. For example, if set to **50**% and you have 5 instances, the minimum is 3.
573
- *
574
- * > If both **MinReadyInstances** and **MinReadyInstanceRatio** are provided, and **MinReadyInstanceRatio** is not **-1**, then **MinReadyInstanceRatio** takes precedence. For example, if **MinReadyInstances** is **5** and **MinReadyInstanceRatio** is **50**, the system calculates the minimum based on 50%.
529
+ * > When both **MinReadyInstance** and **MinReadyInstanceRatio** are specified and the value of **MinReadyInstanceRatio** is not **-1**, the **MinReadyInstanceRatio** parameter takes precedence. For example, if **MinReadyInstances** is set to **5** and **MinReadyInstanceRatio** is set to **50**, the value **50** is used to calculate the minimum number of available instances.
575
530
  *
576
531
  * @example
577
532
  * -1
@@ -579,13 +534,12 @@ export class DeployApplicationRequest extends $dara.Model {
579
534
  minReadyInstanceRatio?: number;
580
535
  /**
581
536
  * @remarks
582
- * The minimum number of instances that remain available during a rolling update. Values:
583
- *
584
- * - If set to **0**, your application experiences downtime during updates.
537
+ * The minimum number of available instances. Valid values:
585
538
  *
586
- * - If set to -1, the system uses its recommended value: 25% of your current instance count. For example, with 5 instances, 5 × 25% = 1.25, rounded up to 2.
539
+ * - If this parameter is set to **0**, service is interrupted during the upgrade.
540
+ * - If this parameter is set to **-1**, the system-recommended value is used, which is 25% of the current number of instances. If the current number of instances is 5, 5 × 25% = 1.25, which is rounded up to 2.
587
541
  *
588
- * > We recommend setting this value to at least 1 to avoid service interruptions.
542
+ * > The minimum number of available instances for each rolling deployment should be ≥ 1 to prevent service interruption.
589
543
  *
590
544
  * @example
591
545
  * 1
@@ -593,7 +547,7 @@ export class DeployApplicationRequest extends $dara.Model {
593
547
  minReadyInstances?: number;
594
548
  /**
595
549
  * @remarks
596
- * We recommend using **NasConfigs** instead of this field. The NAS mount description. If your NAS configuration remains unchanged, omit this parameter. To clear your NAS configuration, set this field to an empty string.
550
+ * We do not recommend that you configure this field. Configure **NasConfigs** instead. The NAS mount description. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the **MountDesc** field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the **MountDesc** field to "" in the request).
597
551
  *
598
552
  * @example
599
553
  * [{mountPath: "/tmp", nasPath: "/"}]
@@ -601,7 +555,7 @@ export class DeployApplicationRequest extends $dara.Model {
601
555
  mountDesc?: string;
602
556
  /**
603
557
  * @remarks
604
- * We recommend using **NasConfigs** instead of this field. The mount target of the NAS in your application\\"s VPC. If your NAS configuration remains unchanged, omit this parameter. To clear your NAS configuration, set this field to an empty string.
558
+ * We do not recommend that you configure this field. Configure **NasConfigs** instead. The mount point of the NAS file system in the VPC of the application. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the **MountHost** field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the **MountHost** field to "" in the request).
605
559
  *
606
560
  * @example
607
561
  * 10d3b4bc9****.com
@@ -609,17 +563,12 @@ export class DeployApplicationRequest extends $dara.Model {
609
563
  mountHost?: string;
610
564
  /**
611
565
  * @remarks
612
- * The configuration for mounting NAS. Values:
613
- *
614
- * - **mountPath**: The mount path in the container.
615
- *
616
- * - **readOnly**: Set to **false** for read and write permissions.
617
- *
618
- * - **nasId**: The NAS ID.
619
- *
620
- * - **mountDomain**: The mount target address. For more information, see [DescribeMountTargets](https://help.aliyun.com/document_detail/62626.html).
621
- *
622
- * - **nasPath**: The relative directory in NAS.
566
+ * The NAS mount configuration. Valid values:
567
+ * - **mountPath**: the container mount path.
568
+ * - **readOnly**: set to **false** for read and write permission.
569
+ * - **nasId**: the NAS ID.
570
+ * - **mountDomain**: the container mount point address. For more information, see [DescribeMountTargets](https://help.aliyun.com/document_detail/62626.html).
571
+ * - **nasPath**: the NAS relative file directory.
623
572
  *
624
573
  * @example
625
574
  * [{"mountPath":"/test1","readOnly":false,"nasId":"nasId1","mountDomain":"nasId1.cn-shenzhen.nas.aliyuncs.com","nasPath":"/test1"},{"nasId":"nasId2","mountDomain":"nasId2.cn-shenzhen.nas.aliyuncs.com","readOnly":false,"nasPath":"/test2","mountPath":"/test2"}]
@@ -627,7 +576,7 @@ export class DeployApplicationRequest extends $dara.Model {
627
576
  nasConfigs?: string;
628
577
  /**
629
578
  * @remarks
630
- * We recommend using **NasConfigs** instead of this field. The ID of the NAS file system. If your NAS configuration remains unchanged, omit this parameter. To clear your NAS configuration, set this field to an empty string.
579
+ * We do not recommend that you configure this field. Configure **NasConfigs** instead. The ID of the NAS file system. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the **NasId** field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the **NasId** field to "" in the request).
631
580
  *
632
581
  * @example
633
582
  * 10d3b4****
@@ -637,11 +586,9 @@ export class DeployApplicationRequest extends $dara.Model {
637
586
  * @remarks
638
587
  * The application version:
639
588
  *
640
- * - lite: Lite Edition
641
- *
642
- * - std: Standard Edition
643
- *
644
- * - pro: Professional Edition
589
+ * - lite: lite edition.
590
+ * - std: standard edition.
591
+ * - pro: professional edition.
645
592
  *
646
593
  * @example
647
594
  * pro
@@ -651,7 +598,8 @@ export class DeployApplicationRequest extends $dara.Model {
651
598
  * @remarks
652
599
  * The RAM role for identity authentication.
653
600
  *
654
- * > Create an OIDC identity provider and an associated role in the same region before using this parameter. For more information, see [Create an OIDC identity provider](https://help.aliyun.com/document_detail/2331022.html) and [Create a role for SSO identity providers](https://help.aliyun.com/document_detail/2331016.html).
601
+ *
602
+ * > Create an OIDC identity provider and an identity provider role in the same region in advance. For more information, see [Create an OIDC identity provider](https://help.aliyun.com/document_detail/2331022.html) and [Create a role for SSO identity provider](https://help.aliyun.com/document_detail/2331016.html).
655
603
  *
656
604
  * @example
657
605
  * sae-test
@@ -667,7 +615,7 @@ export class DeployApplicationRequest extends $dara.Model {
667
615
  ossAkId?: string;
668
616
  /**
669
617
  * @remarks
670
- * The AccessKey secret for OSS read and write operations.
618
+ * The AccessKey Secret for OSS read and write operations.
671
619
  *
672
620
  * @example
673
621
  * xxxxxx
@@ -675,19 +623,14 @@ export class DeployApplicationRequest extends $dara.Model {
675
623
  ossAkSecret?: string;
676
624
  /**
677
625
  * @remarks
678
- * The OSS mount description. Parameters:
679
- *
680
- * - **bucketName**: The name of the bucket.
681
- *
682
- * - **bucketPath**: The directory or object in OSS. If the directory does not exist, an error occurs.
626
+ * The OSS mount description. Parameter settings:
683
627
  *
684
- * - **mountPath**: The path in your SAE container. If the path exists, it is overwritten. If it does not exist, it is created.
685
- *
686
- * - **readOnly**: Whether the container path has read-only access to the mounted resource. Values:
687
- *
688
- * - **true**: Read-only.
689
- *
690
- * - **false**: Read and write.
628
+ * - **bucketName**: the bucket name.
629
+ * - **bucketPath**: the folder or object that you created in OSS. If the OSS mount folder does not exist, an exception is triggered.
630
+ * - **mountPath**: the container path in Serverless App Engine. If the path already exists, it is an overwrite relationship. If the path does not exist, it is created.
631
+ * - **readOnly**: specifies whether the container path has read-only permission on the mounted folder resources. Valid values:
632
+ * - **true**: read-only permission.
633
+ * - **false**: read and write permission.
691
634
  *
692
635
  * @example
693
636
  * [{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}]
@@ -695,43 +638,26 @@ export class DeployApplicationRequest extends $dara.Model {
695
638
  ossMountDescs?: string;
696
639
  /**
697
640
  * @remarks
698
- * The type of your application package. Values:
699
- *
700
- * - For Java applications: **FatJar**, **War**, and **Image**.
701
- *
702
- * - For PHP applications:
703
- *
704
- * - **PhpZip**
705
- *
706
- * - **IMAGE_PHP_5_4**
707
- *
708
- * - **IMAGE_PHP_5_4_ALPINE**
709
- *
710
- * - **IMAGE_PHP_5_5**
711
- *
712
- * - **IMAGE_PHP_5_5_ALPINE**
713
- *
714
- * - **IMAGE_PHP_5_6**
715
- *
716
- * - **IMAGE_PHP_5_6_ALPINE**
717
- *
718
- * - **IMAGE_PHP_7_0**
719
- *
720
- * - **IMAGE_PHP_7_0_ALPINE**
721
- *
722
- * - **IMAGE_PHP_7_1**
723
- *
724
- * - **IMAGE_PHP_7_1_ALPINE**
725
- *
726
- * - **IMAGE_PHP_7_2**
727
- *
728
- * - **IMAGE_PHP_7_2_ALPINE**
729
- *
730
- * - **IMAGE_PHP_7_3**
731
- *
732
- * - **IMAGE_PHP_7_3_ALPINE**
733
- *
734
- * - For Python applications: **PythonZip** and **Image**.
641
+ * The application package type. Valid values:
642
+ *
643
+ * - When you deploy with Java, the following types are supported: **FatJar**, **War**, and **Image**.
644
+ * - When you deploy with PHP, the following types are supported:
645
+ * - **PhpZip**
646
+ * - **IMAGE_PHP_5_4**
647
+ * - **IMAGE_PHP_5_4_ALPINE**
648
+ * - **IMAGE_PHP_5_5**
649
+ * - **IMAGE_PHP_5_5_ALPINE**
650
+ * - **IMAGE_PHP_5_6**
651
+ * - **IMAGE_PHP_5_6_ALPINE**
652
+ * - **IMAGE_PHP_7_0**
653
+ * - **IMAGE_PHP_7_0_ALPINE**
654
+ * - **IMAGE_PHP_7_1**
655
+ * - **IMAGE_PHP_7_1_ALPINE**
656
+ * - **IMAGE_PHP_7_2**
657
+ * - **IMAGE_PHP_7_2_ALPINE**
658
+ * - **IMAGE_PHP_7_3**
659
+ * - **IMAGE_PHP_7_3_ALPINE**
660
+ * - When you deploy with Python, the following types are supported: **PythonZip** and **Image**.
735
661
  *
736
662
  * @example
737
663
  * FatJar
@@ -739,7 +665,7 @@ export class DeployApplicationRequest extends $dara.Model {
739
665
  packageType?: string;
740
666
  /**
741
667
  * @remarks
742
- * The URL of your deployment package. Required when **Package Type** is **FatJar**, **War**, or **PythonZip**.
668
+ * The URL of the deployment package. This parameter is required when **Package Type** is set to **FatJar**, **War**, or **PythonZip**.
743
669
  *
744
670
  * @example
745
671
  * http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar
@@ -747,7 +673,7 @@ export class DeployApplicationRequest extends $dara.Model {
747
673
  packageUrl?: string;
748
674
  /**
749
675
  * @remarks
750
- * The version number of your deployment package. Required when **Package Type** is **FatJar**, **War**, or **PythonZip**.
676
+ * The version number of the deployment package. This parameter is required when **Package Type** is set to **FatJar**, **War**, or **PythonZip**.
751
677
  *
752
678
  * @example
753
679
  * 1.0.1
@@ -755,7 +681,7 @@ export class DeployApplicationRequest extends $dara.Model {
755
681
  packageVersion?: string;
756
682
  /**
757
683
  * @remarks
758
- * The PHP version that your PHP deployment package depends on. Not supported for images.
684
+ * The PHP version on which the deployment package depends. Not supported for images.
759
685
  *
760
686
  * @example
761
687
  * PHP-FPM 7.0
@@ -763,7 +689,7 @@ export class DeployApplicationRequest extends $dara.Model {
763
689
  php?: string;
764
690
  /**
765
691
  * @remarks
766
- * The mount path for PHP application monitoring. Ensure your PHP server loads the configuration file at this path. You do not need to manage the configuration content. SAE renders the correct configuration automatically.
692
+ * The mount path for PHP application monitoring. Ensure that the PHP server loads the configuration file from this path. You do not need to manage the configuration content because Serverless App Engine automatically renders the correct configuration file.
767
693
  *
768
694
  * @example
769
695
  * /usr/local/etc/php/conf.d/arms.ini
@@ -779,7 +705,7 @@ export class DeployApplicationRequest extends $dara.Model {
779
705
  phpConfig?: string;
780
706
  /**
781
707
  * @remarks
782
- * The mount path for the PHP startup configuration. Ensure your PHP server uses this configuration file to start.
708
+ * The mount path for the PHP application startup configuration. Ensure that the PHP server uses this configuration file for startup.
783
709
  *
784
710
  * @example
785
711
  * /usr/local/etc/php/php.ini
@@ -787,7 +713,7 @@ export class DeployApplicationRequest extends $dara.Model {
787
713
  phpConfigLocation?: string;
788
714
  /**
789
715
  * @remarks
790
- * A script that runs after your container starts. It executes immediately after the container is created. Format: `{"exec":{"command":["sh","-c","echo hello"]}}`
716
+ * The script that is run after the container starts. A script is triggered immediately after the container is created. Format: `{"exec":{"command":["sh","-c","echo hello"\\]}}`.
791
717
  *
792
718
  * @example
793
719
  * {"exec":{"command":["sh","-c","echo hello"]}}
@@ -795,7 +721,7 @@ export class DeployApplicationRequest extends $dara.Model {
795
721
  postStart?: string;
796
722
  /**
797
723
  * @remarks
798
- * A script that runs before your container stops. It executes just before the container is deleted. Format: `{"exec":{"command":["sh","-c","echo hello"]}}`
724
+ * The script that is run before the container stops. A script is triggered before the container is deleted. Format: `{"exec":{"command":["sh","-c","echo hello"\\]}}`.
799
725
  *
800
726
  * @example
801
727
  * {"exec":{"command":["sh","-c","echo hello"]}}
@@ -803,13 +729,11 @@ export class DeployApplicationRequest extends $dara.Model {
803
729
  preStop?: string;
804
730
  /**
805
731
  * @remarks
806
- * Enable K8s Service registration and discovery. Values:
807
- *
808
- * - **portProtocols**: Port and protocol. Port range is [1,65535]. Protocols supported: **TCP** and **UDP**.
809
- *
810
- * - portAndProtocol: Port and protocol. Port range is [1,65535]. Protocols supported: **TCP** and **UDP**. **portProtocols** takes precedence. If both are set, only **portProtocols** applies.
732
+ * Enables K8s Service-based service registration and discovery. Valid values:
811
733
  *
812
- * - **enable**: Enable K8s Service registration and discovery.
734
+ * - **portProtocols**: the port and protocol. Valid port values: [1,65535]. Valid protocol values: **TCP** and **UDP**.
735
+ * - **portAndProtocol**: the port and protocol. Valid port values: [1,65535]. Valid protocol values: **TCP** and **UDP**. **portProtocols is recommended. If portProtocols is set, only portProtocols takes effect**.
736
+ * - **enable**: enables K8s Service-based service registration and discovery.
813
737
  *
814
738
  * @example
815
739
  * {"portProtocols":[{"port":18012,"protocol":"TCP"}],"portAndProtocol":{"18012":"TCP"},"enable":true}
@@ -817,7 +741,7 @@ export class DeployApplicationRequest extends $dara.Model {
817
741
  pvtzDiscoverySvc?: string;
818
742
  /**
819
743
  * @remarks
820
- * The Python runtime environment. Supported: **PYTHON 3.9.15**.
744
+ * The Python environment. **PYTHON 3.9.15** is supported.
821
745
  *
822
746
  * @example
823
747
  * PYTHON 3.9.15
@@ -825,17 +749,18 @@ export class DeployApplicationRequest extends $dara.Model {
825
749
  python?: string;
826
750
  /**
827
751
  * @remarks
828
- * Custom module dependencies. By default, dependencies defined in requirements.txt in the root directory are installed. If no configuration or custom packages exist, specify the dependencies to install.
752
+ * The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root folder are installed. If no dependencies are configured or custom packages are needed, you can specify the dependencies to install.
829
753
  *
830
754
  * @example
831
755
  * Flask==2.0
832
756
  */
833
757
  pythonModules?: string;
758
+ raspConfig?: DeployApplicationRequestRaspConfig;
834
759
  /**
835
760
  * @remarks
836
- * Startup status checks for your application. Containers that repeatedly fail readiness checks are terminated and restarted. Containers that fail readiness checks receive no SLB traffic. Supports **exec**, **httpGet**, and **tcpSocket**. For examples, see the **Liveness** parameter.
761
+ * The application startup status check. Containers that fail multiple health checks are shut down and restarted. Containers that do not pass the health check do not receive SLB traffic. The **exec**, **httpGet**, and **tcpSocket** methods are supported. For specific examples, see the **Liveness** parameter.
837
762
  *
838
- * > You can select only one health check method.
763
+ * > Only one method can be selected for health checks.
839
764
  *
840
765
  * @example
841
766
  * {"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}
@@ -851,15 +776,14 @@ export class DeployApplicationRequest extends $dara.Model {
851
776
  replicas?: number;
852
777
  /**
853
778
  * @remarks
854
- * The mount description for a **Secret**. Use secrets created on the namespace secrets page to inject sensitive information into your container. Parameters:
779
+ * The **Secret** mount description. Use a secret created on the namespace secrets page to inject sensitive information into the container. Settings:
855
780
  *
856
- * - **secretId**: The ID of the secret instance. Get it by calling the ListSecrets API.
781
+ * - **secretId**: the secret instance ID. You can obtain it by calling the ListSecrets operation.
782
+ * - **key**: the key.
857
783
  *
858
- * - **key**: The key.
784
+ * > You can mount all keys by passing the `sae-sys-secret-all` parameter.
859
785
  *
860
- * > You can mount all keys by passing `sae-sys-secret-all`.
861
- *
862
- * - **mountPath**: The mount path.
786
+ * - **mountPath**: the mount path.
863
787
  *
864
788
  * @example
865
789
  * [{“secretId":10,”key":"test","mountPath":"/tmp"}]
@@ -875,7 +799,7 @@ export class DeployApplicationRequest extends $dara.Model {
875
799
  securityGroupId?: string;
876
800
  /**
877
801
  * @remarks
878
- * The canary tags configured for your application.
802
+ * The canary release tags configured for the application.
879
803
  *
880
804
  * @example
881
805
  * {\\"alicloud.service.tag\\":\\"g1\\"}
@@ -883,32 +807,27 @@ export class DeployApplicationRequest extends $dara.Model {
883
807
  serviceTags?: string;
884
808
  /**
885
809
  * @remarks
886
- * Container configuration information.
810
+ * The sidecar container configuration.
887
811
  */
888
812
  sidecarContainersConfig?: SidecarContainerConfig[];
889
813
  /**
890
814
  * @remarks
891
- * The configuration for collecting logs to Simple Log Service (SLS).
892
- *
893
- * - Using SAE-managed SLS resources: `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`.
815
+ * The configuration for log collection to Simple Log Service.
894
816
  *
895
- * - Using custom SLS resources: `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`.
817
+ * - Use SLS resources automatically created by Serverless App Engine: `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`.
818
+ * - Use custom SLS resources: `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`.
896
819
  *
897
- * Parameters:
820
+ * Settings:
898
821
  *
899
- * - **projectName**: The name of the SLS project.
822
+ * - **projectName**: the name of the project in Simple Log Service.
823
+ * - **logDir**: the log path.
824
+ * - **logType**: the log type. **stdout** indicates container standard output logs, and only one entry can be set. If this parameter is not set, file logs are collected.
825
+ * - **logstoreName**: the name of the Logstore in Simple Log Service.
826
+ * - **logtailName**: the name of the Logtail in Simple Log Service. If this parameter is not specified, a new Logtail is created by automatic creation.
900
827
  *
901
- * - **logDir**: The log file path.
828
+ * If the SLS collection configuration has not changed during multiple deployments, you do not need to set this parameter (that is, the **SlsConfigs** field does not need to be included in the request). If you no longer need the SLS collection feature, set the value of this field to an empty string (that is, set the value of the **SlsConfigs** field to "" in the request).
902
829
  *
903
- * - logType: The log type. **stdout** means standard output logs from the container. Only one **stdout** entry is allowed. If omitted, file logs are collected.
904
- *
905
- * - **logstoreName**: The name of the SLS Logstore.
906
- *
907
- * - **logtailName**: The name of the SLS Logtail. If omitted, a new Logtail is created.
908
- *
909
- * If your SLS collection configuration remains unchanged across deployments, omit this parameter. To disable SLS collection, set this field to an empty string.
910
- *
911
- * > Projects automatically created by SAE are deleted when the application is deleted. Do not select these projects when choosing an existing project.
830
+ * > A project that is automatically created with the application is deleted when the application is deleted. Therefore, do not select a project that is automatically created by Serverless App Engine when selecting an existing project.
912
831
  *
913
832
  * @example
914
833
  * [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
@@ -916,22 +835,19 @@ export class DeployApplicationRequest extends $dara.Model {
916
835
  slsConfigs?: string;
917
836
  /**
918
837
  * @remarks
919
- * The SLS log tags.
838
+ * sls log tags
920
839
  */
921
840
  slsLogEnvTags?: string;
922
841
  /**
923
842
  * @remarks
924
- * Enable application startup probing.
925
- *
926
- * - Success: The application starts successfully. If you configure Liveness and Readiness checks, they run after startup.
843
+ * Enables the application startup probe.
927
844
  *
928
- * - Failure: The application fails to start. SAE reports an error and restarts the container automatically.
845
+ * - Check succeeded: indicates that the application started successfully. If you configured Liveness and Readiness checks, they are performed after the application starts successfully.
846
+ * - Check failed: indicates that the application failed to start. An exception is reported and the application is automatically restarted.
929
847
  *
930
- * > Description
931
- * >
932
- * > - Supports exec, httpGet, and tcpSocket. For examples, see the Liveness parameter.
933
- * >
934
- * > - You can select only one health check method.
848
+ * > This is the description content.
849
+ * > - The exec, httpGet, and tcpSocket methods are supported. For specific examples, see the Liveness parameter.
850
+ * > - Only one method can be selected for health checks.
935
851
  *
936
852
  * @example
937
853
  * {"exec":{"command":["sh","-c","cat /home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}
@@ -939,31 +855,20 @@ export class DeployApplicationRequest extends $dara.Model {
939
855
  startupProbe?: string;
940
856
  /**
941
857
  * @remarks
942
- * Configures service discovery and end-to-end canary release based on a Kubernetes Service:
943
- *
944
- * - enable: Specifies whether to enable the end-to-end canary release feature.
945
- *
946
- * - true: Enables the feature.
947
- *
948
- * - false: Disables the feature.
949
- *
950
- * - namespaceId: The namespace ID.
951
- *
952
- * - portAndProtocol: The listening port and protocol. The format is {"\\<port>:\\<protocol>":"\\<target_port>"}.
858
+ * Configures K8s Service-based service registration and discovery with end-to-end canary release:
953
859
  *
954
- * - portProtocols: A list of ports and protocols for the service.
955
- *
956
- * - port: The port number.
957
- *
958
- * - protocol: The protocol.
959
- *
960
- * - targetPort: The container port.
961
- *
962
- * - pvtzDiscoveryName: The service discovery name.
963
- *
964
- * - serviceId: The service ID.
965
- *
966
- * - serviceName: The service name.
860
+ * - enable: specifies whether to enable end-to-end canary release based on K8s Service.
861
+ * - true: enabled.
862
+ * - false: disabled.
863
+ * - namespaceId: the namespace ID.
864
+ * - portAndProtocol: the listening port and protocol. Format: {"port:protocol type":"container port"}.
865
+ * - portProtocols: defines the service port and protocol.
866
+ * - port: the port.
867
+ * - protocol: the protocol.
868
+ * - targetPort: the container port.
869
+ * - pvtzDiscoveryName: the service discovery name.
870
+ * - serviceId: the service ID.
871
+ * - serviceName: the service name.
967
872
  *
968
873
  * @example
969
874
  * {\\"enable\\":\\"false\\",\\"namespaceId\\":\\"cn-beijing:test\\",\\"portAndProtocol\\":{\\"2000:TCP\\":\\"18081\\"},\\"portProtocols\\":[{\\"port\\":2000,\\"protocol\\":\\"TCP\\",\\"targetPort\\":18081}],\\"pvtzDiscoveryName\\":\\"cn-beijing-1421801774382676\\",\\"serviceId\\":\\"3513\\",\\"serviceName\\":\\"demo-gray.test\\"}
@@ -971,7 +876,7 @@ export class DeployApplicationRequest extends $dara.Model {
971
876
  swimlanePvtzDiscoverySvc?: string;
972
877
  /**
973
878
  * @remarks
974
- * The graceful shutdown timeout, in seconds. Default is 30. Valid values: 1300.
879
+ * The graceful shutdown timeout period. Default value: 30. Unit: seconds. Valid values: 1 to 300.
975
880
  *
976
881
  * @example
977
882
  * 10
@@ -979,7 +884,7 @@ export class DeployApplicationRequest extends $dara.Model {
979
884
  terminationGracePeriodSeconds?: number;
980
885
  /**
981
886
  * @remarks
982
- * The time zone. Default is **Asia/Shanghai**.
887
+ * The time zone. Default value: **Asia/Shanghai**.
983
888
  *
984
889
  * @example
985
890
  * Asia/Shanghai
@@ -987,17 +892,13 @@ export class DeployApplicationRequest extends $dara.Model {
987
892
  timezone?: string;
988
893
  /**
989
894
  * @remarks
990
- * The Tomcat configuration. Set to an empty string or {} to delete the configuration. Values:
991
- *
992
- * - **port**: Port range is 1024–65535. Ports below 1024 require root privileges. Because containers run with admin privileges, use ports above 1024. Default is 8080.
993
- *
994
- * - **contextPath**: The access path. Default is the root directory /.
995
- *
996
- * - **maxThreads**: The size of the connection pool. Default is 400.
997
- *
998
- * - uriEncoding: The encoding format for Tomcat. Options include **UTF-8**, **ISO-8859-1**, **GBK**, and **GB2312**. Default is **ISO-8859-1**.
895
+ * The Tomcat configuration. Set this parameter to "" or "{}" to delete the configuration. Valid values:
999
896
  *
1000
- * - **useBodyEncodingForUri**: Whether to use body encoding for URLs. Default is **true**.
897
+ * - **port**: the port number. Valid values: 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with admin permissions, specify a port greater than 1024. Default value: 8080.
898
+ * - **contextPath**: the access path. Default value: root directory "/".
899
+ * - **maxThreads**: the connection pool size. Default value: 400.
900
+ * - **uriEncoding**: the encoding format of Tomcat. Valid values: **UTF-8**, **ISO-8859-1**, **GBK**, and **GB2312**. Default value: **ISO-8859-1**.
901
+ * - **useBodyEncodingForUri**: specifies whether to use **BodyEncoding for URL**. Default value: **true**.
1001
902
  *
1002
903
  * @example
1003
904
  * {"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
@@ -1005,27 +906,20 @@ export class DeployApplicationRequest extends $dara.Model {
1005
906
  tomcatConfig?: string;
1006
907
  /**
1007
908
  * @remarks
1008
- * The release strategy. When MinReadyInstances equals 1, set UpdateStrategy to an empty string. When **MinReadyInstances** is greater than 1, examples include the following:
909
+ * The deployment policy. When the minimum number of available instances is 1, the value of the **UpdateStrategy** field is "". When the minimum number of available instances is greater than 1, examples are as follows:
910
+ *
911
+ * - Grayscale 1 instance + 2 subsequent batches + automatic batching + 1-minute batch interval: `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}`
912
+ * - Grayscale 1 instance + 2 subsequent batches + manual batching: `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}`
913
+ * - 2 batches + automatic batching + 0-minute batch interval: `{"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}`
1009
914
  *
1010
- * - Canary release with 1 instance, followed by 2 automatic batches with a 1-minute interval: `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}`
915
+ * Settings:
916
+ * - **type**: the publish policy type. Valid values: **GrayBatchUpdate** (grayscale publish) and **BatchUpdate** (batch publish).
917
+ * - **batchUpdate**: the batch publish policy.
918
+ * - **batch**: the number of publish batches.
919
+ * - **releaseType**: the processing method between batches. Valid values: **auto** (automatic) and **manual** (manual).
920
+ * - **batchWaitTime**: the interval between batches. Unit: minutes.
1011
921
  *
1012
- * - Canary release with 1 instance, followed by 2 manual batches: `{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}`
1013
- *
1014
- * - Two automatic batches with a 0-minute interval: `{"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}`
1015
- *
1016
- * Parameters:
1017
- *
1018
- * - **type**: The release strategy type. Options are **GrayBatchUpdate** (canary release) or **BatchUpdate** (phased release).
1019
- *
1020
- * - **batchUpdate**: The phased release strategy.
1021
- *
1022
- * - **batch**: The number of batches.
1023
- *
1024
- * - **releaseType**: How batches are processed. Options are **auto** (automatic) or **manual** (manual).
1025
- *
1026
- * - **batchWaitTime**: The wait time between batches, in minutes.
1027
- *
1028
- * - **grayUpdate**: The number of canary instances. Required when **type** is **GrayBatchUpdate**.
922
+ * - **grayUpdate**: the number of grayscale instances. This parameter is required when **type** is set to **GrayBatchUpdate**.
1029
923
  *
1030
924
  * @example
1031
925
  * {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}
@@ -1033,7 +927,7 @@ export class DeployApplicationRequest extends $dara.Model {
1033
927
  updateStrategy?: string;
1034
928
  /**
1035
929
  * @remarks
1036
- * The virtual switch where your application instance elastic network interfaces reside. This switch must be in the specified VPC.
930
+ * The vSwitch where the network interface controllers (NICs) of the application instance reside. The vSwitch must be in the specified VPC.
1037
931
  *
1038
932
  * @example
1039
933
  * vsw-bp12mw1f8k3jgygk9****
@@ -1041,7 +935,7 @@ export class DeployApplicationRequest extends $dara.Model {
1041
935
  vSwitchId?: string;
1042
936
  /**
1043
937
  * @remarks
1044
- * The startup command for your WAR package. Configure it the same way as the startup command for images. For more information, see [Set the startup command](https://help.aliyun.com/document_detail/96677.html).
938
+ * The startup command for deploying a WAR package-based application. The configuration procedure is the same as that for the startup command of an image-based deployment. For more information, see [Configure a startup command](https://help.aliyun.com/document_detail/96677.html).
1045
939
  *
1046
940
  * @example
1047
941
  * CATALINA_OPTS=\\"$CATALINA_OPTS $Options\\" catalina.sh run
@@ -1049,13 +943,12 @@ export class DeployApplicationRequest extends $dara.Model {
1049
943
  warStartOptions?: string;
1050
944
  /**
1051
945
  * @remarks
1052
- * The Tomcat version that your deployment package depends on. Supported versions include the following:
946
+ * The Tomcat version on which the deployment package depends. Valid values:
1053
947
  *
1054
948
  * - **apache-tomcat-7.0.91**
1055
- *
1056
949
  * - **apache-tomcat-8.5.42**
1057
950
  *
1058
- * This parameter is not supported when **Package Type** is **Image**.
951
+ * This parameter is not supported when **Package Type** is set to **Image**.
1059
952
  *
1060
953
  * @example
1061
954
  * apache-tomcat-7.0.91
@@ -1131,6 +1024,7 @@ export class DeployApplicationRequest extends $dara.Model {
1131
1024
  pvtzDiscoverySvc: 'PvtzDiscoverySvc',
1132
1025
  python: 'Python',
1133
1026
  pythonModules: 'PythonModules',
1027
+ raspConfig: 'RaspConfig',
1134
1028
  readiness: 'Readiness',
1135
1029
  replicas: 'Replicas',
1136
1030
  secretMountDesc: 'SecretMountDesc',
@@ -1221,6 +1115,7 @@ export class DeployApplicationRequest extends $dara.Model {
1221
1115
  pvtzDiscoverySvc: 'string',
1222
1116
  python: 'string',
1223
1117
  pythonModules: 'string',
1118
+ raspConfig: DeployApplicationRequestRaspConfig,
1224
1119
  readiness: 'string',
1225
1120
  replicas: 'number',
1226
1121
  secretMountDesc: 'string',
@@ -1248,6 +1143,9 @@ export class DeployApplicationRequest extends $dara.Model {
1248
1143
  if(this.labels) {
1249
1144
  $dara.Model.validateMap(this.labels);
1250
1145
  }
1146
+ if(this.raspConfig && typeof (this.raspConfig as any).validate === 'function') {
1147
+ (this.raspConfig as any).validate();
1148
+ }
1251
1149
  if(Array.isArray(this.sidecarContainersConfig)) {
1252
1150
  $dara.Model.validateArray(this.sidecarContainersConfig);
1253
1151
  }