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