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