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