@alicloud/sae20190506 2.12.1 → 2.12.3

package/src/models/EnableApplicationScalingRuleResponseBody.ts

@@ -7,10 +7,13 @@ export class EnableApplicationScalingRuleResponseBody extends $dara.Model {
    * @remarks
    * The HTTP status code. Take note of the following rules:
    * 
-   * *   **2xx**: The call was successful.
-   * *   **3xx**: The call was redirected.
-   * *   **4xx**: The call failed.
-   * *   **5xx**: A server error occurred.
+   * - **2xx**: The call was successful.
+   * 
+   * - **3xx**: The call was redirected.
+   * 
+   * - **4xx**: The call failed.
+   * 
+   * - **5xx**: A server error occurred.
    * 
    * @example
    * 200
@@ -20,19 +23,18 @@ export class EnableApplicationScalingRuleResponseBody extends $dara.Model {
    * @remarks
    * The error code returned if the request failed. Take note of the following rules:
    * 
-   * *   The **ErrorCode** parameter is not returned if the request succeeds.
-   * *   If the call fails, the **ErrorCode** parameter is returned. For more information, see the "**Error codes**" section of this topic.
+   * - The **ErrorCode** parameter is not returned if the request succeeds.
    * 
-   * @example
-   * Null
+   * - If the call fails, the **ErrorCode** parameter is returned. For more information, see the "**Error codes**" section of this topic.
    */
   errorCode?: string;
   /**
    * @remarks
    * The additional information that is returned. Take note of the following rules:
    * 
-   * *   success: If the call is successful, **success** is returned.
-   * *   An error code: If the call fails, an error code is returned.
+   * - success: If the call is successful, **success** is returned.
+   * 
+   * - An error code: If the call fails, an error code is returned.
    * 
    * @example
    * success
@@ -50,8 +52,9 @@ export class EnableApplicationScalingRuleResponseBody extends $dara.Model {
    * @remarks
    * Specifies whether the instances are successfully restarted. Take note of the following rules:
    * 
-   * *   **true**
-   * *   **false**: The restart failed.
+   * - **true**
+   * 
+   * - **false**: The restart failed.
    * 
    * @example
    * true

package/src/models/ExecJobRequest.ts

@@ -15,15 +15,17 @@ export class ExecJobRequest extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * The command that is used to start the image. The command must be an existing executable object in the container. Example:
+   * The startup command, which must be an executable that exists in the container. Example:
    * 
-   *     command:
-   *           - echo
-   *           - abc
-   *           - >
-   *           - file0
+   * ```
+   * command:
+   *       - echo
+   *       - abc
+   *       - >
+   *       - file0
+   * ```
    * 
-   * In this example, the Command parameter is set to `Command="echo", CommandArgs=["abc", ">", "file0"]`.
+   * Based on this example, `Command` is `echo` and `CommandArgs` is `["abc", ">", "file0"]`.
    * 
    * @example
    * echo
@@ -31,11 +33,11 @@ export class ExecJobRequest extends $dara.Model {
   command?: string;
   /**
    * @remarks
-   * The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the **Command** parameter. The name must meet the following format requirements:
+   * The arguments for the **Command** parameter. The value must be a string that represents a JSON array. Format:
    * 
    * `["a","b"]`
    * 
-   * In the preceding example, the CommandArgs parameter is set to `CommandArgs=["abc", ">", "file0"]`. The data type of `["abc", ">", "file0"]` must be an array of strings in the JSON format. This parameter is optional.
+   * In the preceding example for the `Command` parameter, `CommandArgs` is `["abc", ">", "file0"]`. The JSON array `["abc", ">", "file0"]` must be converted to a string. This parameter is optional.
    * 
    * @example
    * ["a","b"]
@@ -43,19 +45,23 @@ export class ExecJobRequest extends $dara.Model {
   commandArgs?: string;
   /**
    * @remarks
-   * The environment variables. You can configure custom environment variables or reference a ConfigMap. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see [CreateConfigMap](https://help.aliyun.com/document_detail/176914.html). Valid values:
+   * The container environment variables. You can specify custom environment variables or reference an existing ConfigMap. For more information about creating a ConfigMap, see [CreateConfigMap](https://help.aliyun.com/document_detail/176914.html).
    * 
-   * *   Configure custom environment variables
+   * - Custom configuration
    * 
-   *     *   **name**: the name of the environment variable.
-   *     *   **value**: the value of the environment variable.
+   *   - **name**: The name of the environment variable.
    * 
-   * *   Reference ConfigMap
+   *   - **value**: The value of the environment variable.
    * 
-   *     *   **name**: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify `sae-sys-configmap-all-<ConfigMap name>`. Example: `sae-sys-configmap-all-test1`.
-   *     *   **valueFrom**: the reference of the environment variable. Set the value to `configMapRef`.
-   *     *   **configMapId**: the ConfigMap ID.
-   *     *   **key**: the key. If you want to reference all keys, do not configure this parameter.
+   * - Reference a ConfigMap
+   * 
+   *   - **name**: The name of the environment variable. You can reference a single key or all keys. To reference all keys, use the `sae-sys-configmap-all-<ConfigMap name>` format. Example: `sae-sys-configmap-all-test1`.
+   * 
+   *   - **valueFrom**: The source of the environment variable. Set the value to `configMapRef`.
+   * 
+   *   - **configMapId**: The ID of the ConfigMap.
+   * 
+   *   - **key**: The key that you want to reference. If you want to reference all key-value pairs, do not specify this parameter.
    * 
    * @example
    * [{"name":"envtmp","value":"0"}]
@@ -63,7 +69,7 @@ export class ExecJobRequest extends $dara.Model {
   envs?: string;
   /**
    * @remarks
-   * The event ID. This is a user-defined parameter used for idempotency so that only one job is created for the same event ID.
+   * A customizable event ID that ensures idempotency. The system creates only one job for requests that have the same event ID.
    * 
    * @example
    * custom
@@ -71,7 +77,8 @@ export class ExecJobRequest extends $dara.Model {
   eventId?: string;
   /**
    * @remarks
-   * The arguments in the JAR package. The arguments are used to start the job. The default startup command is `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`.
+   * Arguments for starting a job deployed from a JAR package. The default startup command is:
+   * `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`
    * 
    * @example
    * custom-args
@@ -79,7 +86,8 @@ export class ExecJobRequest extends $dara.Model {
   jarStartArgs?: string;
   /**
    * @remarks
-   * The option settings in the JAR package. The settings are used to start the job. The default startup command is `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`.
+   * Options for starting a job deployed from a JAR package. The default startup command is:
+   * `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`
    * 
    * @example
    * -Xms4G -Xmx4G
@@ -95,7 +103,7 @@ export class ExecJobRequest extends $dara.Model {
   replicas?: string;
   /**
    * @remarks
-   * The time at which the job is triggered. Format: `yyyy-MM-dd\\"T\\"HH:mm:ss\\"Z\\"`.
+   * The time to trigger the job, specified in the `yyyy-MM-dd\\"T\\"HH:mm:ss\\"Z\\"` format.
    * 
    * @example
    * 2023-09-14T14:25:02Z
@@ -103,7 +111,7 @@ export class ExecJobRequest extends $dara.Model {
   time?: string;
   /**
    * @remarks
-   * The startup command of the WAR package. For information about how to configure the startup command, see [Configure a startup command](https://help.aliyun.com/document_detail/96677.html).
+   * The startup command for a job deployed from a WAR package. Configuration is the same as for an image-based deployment. For more information, see [Configure a startup command](https://help.aliyun.com/document_detail/96677.html).
    * 
    * @example
    * CATALINA_OPTS=\\"$CATALINA_OPTS $Options\\" catalina.sh run

package/src/models/ExecJobResponseBody.ts

@@ -5,12 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ExecJobResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code. Valid values: 
+   * The HTTP status code or a POP error code.
    * 
-   * *   **2xx**: The call was successful.
-   * *   **3xx**: The call was redirected.
-   * *   **4xx**: The call failed.
-   * *   **5xx**: A server error occurred.
+   * - **2xx**: Success.
+   * 
+   * - **3xx**: Redirection.
+   * 
+   * - **4xx**: Request error.
+   * 
+   * - **5xx**: Server error.
    * 
    * @example
    * 200
@@ -26,10 +29,11 @@ export class ExecJobResponseBodyData extends $dara.Model {
   data?: string;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * The returned message.
    * 
-   * - success: If the call is successful, **success** is returned.
-   * - An error code: If the call fails, an error code is returned.
+   * - If the request is successful, **success** is returned.
+   * 
+   * - If the request fails, an error code is returned.
    * 
    * @example
    * success
@@ -37,10 +41,11 @@ export class ExecJobResponseBodyData extends $dara.Model {
   msg?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Whether the job was successfully executed.
+   * 
+   * - **true**: The execution was successful.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The execution failed.
    * 
    * @example
    * true
@@ -76,12 +81,15 @@ export class ExecJobResponseBodyData extends $dara.Model {
 export class ExecJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code. Valid values: 
+   * The HTTP status code or a POP error code.
+   * 
+   * - **2xx**: Success.
    * 
-   * *   **2xx**: The call was successful.
-   * *   **3xx**: The call was redirected.
-   * *   **4xx**: The call failed.
-   * *   **5xx**: A server error occurred.
+   * - **3xx**: Redirection.
+   * 
+   * - **4xx**: Request error.
+   * 
+   * - **5xx**: Server error.
    * 
    * @example
    * 200
@@ -94,18 +102,20 @@ export class ExecJobResponseBody extends $dara.Model {
   data?: ExecJobResponseBodyData;
   /**
    * @remarks
-   * The error code. Valid values:
+   * The error code.
+   * 
+   * - This parameter is omitted for successful requests.
    * 
-   * *   If the call is successful, the **ErrorCode** parameter is not returned.
-   * *   If the call fails, the **ErrorCode** parameter is returned. For more information, see the **Error codes** section in this topic.
+   * - This parameter is included for failed requests. For more information, see the **Error codes** section of this topic.
    */
   errorCode?: string;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * The returned message.
    * 
-   * *   success: If the call is successful, **success** is returned.
-   * *   An error code: If the call fails, an error code is returned.
+   * - If the request is successful, **success** is returned.
+   * 
+   * - If the request fails, an error code is returned.
    * 
    * @example
    * success
@@ -121,10 +131,11 @@ export class ExecJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request was successful.
+   * 
+   * - **true**: The request was successful.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The request failed.
    * 
    * @example
    * true
@@ -132,7 +143,7 @@ export class ExecJobResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The ID of the trace. This parameter is used to query the exact call information.
+   * The trace ID for retrieving detailed information about the call.
    * 
    * @example
    * 0b87b7e716575071334387401e****

package/src/models/GetApplicationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * The application ID.
+   * The ID of the application.
    * 
    * @example
    * 017f39b8-dfa4-4e16-a84b-1dcee4b1****
@@ -13,7 +13,7 @@ export class GetApplicationRequest extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * The application name.
+   * The name of the application.
    * 
    * @example
    * test

package/src/models/GetApplicationResponseBody.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationResponseBodyApplication extends $dara.Model {
   /**
    * @remarks
-   * The description of the application.
+   * The application description.
+   * 
+   * @example
+   * Test
    */
   appDescription?: string;
   /**
@@ -26,7 +29,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   appName?: string;
   /**
    * @remarks
-   * The ID of the basic application.
+   * The base application ID.
    * 
    * @example
    * ee99cce6-1c8e-4bfa-96c3-3e2fa9******
@@ -34,16 +37,23 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   baseAppId?: string;
   /**
    * @remarks
-   * The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values:
+   * The CPU required for each instance, in millicores. This value cannot be 0. Valid values:
+   * 
+   * - **500**
+   * 
+   * - **1000**
+   * 
+   * - **2000**
+   * 
+   * - **4000**
+   * 
+   * - **8000**
+   * 
+   * - **12000**
    * 
-   * *   **500**
-   * *   **1000**
-   * *   **2000**
-   * *   **4000**
-   * *   **8000**
-   * *   **12000**
-   * *   **16000**
-   * *   **32000**
+   * - **16000**
+   * 
+   * - **32000**
    * 
    * @example
    * 2000
@@ -51,27 +61,40 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   cpu?: number;
   /**
    * @remarks
-   * The number of application instances.
+   * The total number of application instances.
    * 
    * @example
-   * i-8ps2o182102o1jv05bys
+   * 6
    */
   instances?: number;
+  /**
+   * @remarks
+   * Indicates whether the application is stateful.
+   */
   isStateful?: boolean;
   /**
    * @remarks
-   * The memory size that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter:
-   * 
-   * *   This parameter is set to **1024** if the Cpu parameter is set to 500 or 1000.
-   * *   This parameter is set to **2048** if the Cpu parameter is set to 500, 1000, or 2000.
-   * *   This parameter is set to **4096** if the Cpu parameter is set to 1000, 2000, or 4000.
-   * *   This parameter is set to **8192** if the Cpu parameter is set to 2000, 4000, or 8000.
-   * *   This parameter is set to **12288** if the Cpu parameter is set to 12000.
-   * *   This parameter is set to **16384** if the Cpu parameter is set to 4000, 8000, or 16000.
-   * *   This parameter is set to **24576** if the Cpu parameter is set to 12000.
-   * *   This parameter is set to **32768** if the Cpu parameter is set to 16000.
-   * *   This parameter is set to **65536** if the Cpu parameter is set to 8000, 16000, or 32000.
-   * *   This parameter is set to **131072** if the Cpu parameter is set to 32000.
+   * The memory required for each instance, in MB. This value cannot be 0. The memory specification is coupled with the CPU specification. The following configurations are supported:
+   * 
+   * - **1024**: corresponds to 500 or 1,000 millicores of CPU.
+   * 
+   * - **2048**: corresponds to 500, 1,000, or 2,000 millicores of CPU.
+   * 
+   * - **4096**: corresponds to 1,000, 2,000, or 4,000 millicores of CPU.
+   * 
+   * - **8192**: corresponds to 2,000, 4,000, or 8,000 millicores of CPU.
+   * 
+   * - **12288**: corresponds to 12,000 millicores of CPU.
+   * 
+   * - **16384**: corresponds to 4,000, 8,000, or 16,000 millicores of CPU.
+   * 
+   * - **24576**: corresponds to 12,000 millicores of CPU.
+   * 
+   * - **32768**: corresponds to 16,000 millicores of CPU.
+   * 
+   * - **65536**: corresponds to 8,000, 16,000, or 32,000 millicores of CPU.
+   * 
+   * - **131072**: corresponds to 32,000 millicores of CPU.
    * 
    * @example
    * 4096
@@ -79,10 +102,11 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   mem?: number;
   /**
    * @remarks
-   * Specifies whether to enable WebAssembly Filter. Valid values:
+   * Indicates whether WebAssemblyFilter is enabled. Valid values:
    * 
-   * *   true: enables this parameter.
-   * *   false: disables this parameter.
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
    * 
    * @example
    * true
@@ -90,7 +114,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   mseEnabled?: boolean;
   /**
    * @remarks
-   * The ID of the namespace to which the MSE instance belongs.
+   * The namespace ID of the MSE instance.
    * 
    * @example
    * test
@@ -106,11 +130,13 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   namespaceId?: string;
   /**
    * @remarks
-   * The programming language that is used to create the application. Valid values:
+   * The programming language of the application. Valid values:
+   * 
+   * - **java**: Java.
    * 
-   * *   **java** :Java.
-   * *   **php**: PHP.
-   * *   **other**: other programming languages, such as Python, C++, Go, .NET, and Node.js
+   * - **php**: PHP.
+   * 
+   * - **other**: other languages, such as Python, C++, Go, .NET, and Node.js.
    * 
    * @example
    * java
@@ -118,18 +144,19 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   programmingLanguage?: string;
   /**
    * @remarks
-   * The number of application instances that are running.
+   * The number of running instances.
    * 
    * @example
-   * 1
+   * 6
    */
   runningInstances?: number;
   /**
    * @remarks
    * Indicates whether the auto scaling policy is enabled. Valid values:
    * 
-   * *   **true**: The auto scaling policy is enabled.
-   * *   **false**: The auto scaling policy is disabled.
+   * - **true**: The policy is enabled.
+   * 
+   * - **false**: The policy is disabled.
    * 
    * @example
    * true
@@ -139,9 +166,11 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
    * @remarks
    * The type of the auto scaling policy. Valid values:
    * 
-   * *   **timing**: a scheduled auto scaling policy.
-   * *   **metric**: a metric-based auto scaling policy.
-   * *   **mix**: a hybrid auto scaling policy.
+   * - **timing**: scheduled auto scaling.
+   * 
+   * - **metric**: metric-based auto scaling.
+   * 
+   * - **mix**: hybrid auto scaling.
    * 
    * @example
    * timing
@@ -204,10 +233,11 @@ export class GetApplicationResponseBody extends $dara.Model {
   application?: GetApplicationResponseBodyApplication;
   /**
    * @remarks
-   * The additional information returned. Valid values:
+   * The response message.
+   * 
+   * - If the request is successful, the value is **success**.
    * 
-   * *   When a request is successful, **success**is returned.
-   * *   An error code is returned when a request failed.
+   * - If the request fails, the value is a specific error code.
    * 
    * @example
    * success
@@ -215,7 +245,7 @@ export class GetApplicationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 01CF26C7-00A3-4AA6-BA76-7E95F2A3****
@@ -223,7 +253,7 @@ export class GetApplicationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the trace. The ID is used to query the details of a request.
+   * The trace ID used to query the details of the request.
    * 
    * @example
    * ac1a0b2215622920113732501e****

package/src/models/GetAvailabilityMetricResponseBody.ts

@@ -130,7 +130,7 @@ export class GetAvailabilityMetricResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 3A92C4EA-4C53-5A1C-8AEB-F2DB11982D5F
+   * 3A92C4EA-4C53-5A1C-8AEB-F2DB1198****
    */
   requestId?: string;
   /**

package/src/models/GetChangeOrderMetricRequest.ts

@@ -3,26 +3,37 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetChangeOrderMetricRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the application.
+   */
   appId?: string;
   /**
    * @remarks
-   * The SAE application type. Valid values:
+   * The type of the SAE application.
+   * 
+   * - **micro_service**
+   * 
+   * - **web**
    * 
-   * *   **micro_service**
-   * *   **web**
-   * *   **job**
+   * - **job**
    * 
    * @example
    * micro_service
    */
   appSource?: string;
+  /**
+   * @remarks
+   * The type of the change order.
+   */
   coType?: string;
   /**
    * @remarks
-   * The CPU allocation policy. Valid values:
+   * The CPU allocation policy.
+   * 
+   * - **request**: CPU is allocated only when a request is received.
    * 
-   * *   **request**: CPU cores are allocated only when a request is initiated.
-   * *   **always**: Fixed CPU cores are always allocated.
+   * - **always**: A fixed amount of CPU is always allocated.
    * 
    * @example
    * always
@@ -50,7 +61,7 @@ export class GetChangeOrderMetricRequest extends $dara.Model {
   limit?: number;
   /**
    * @remarks
-   * The field based on which you want to sort the returned entries.
+   * The field by which to sort the query results. The value of this parameter must be a field in the response parameters.
    * 
    * This parameter is required.
    * 
@@ -60,7 +71,7 @@ export class GetChangeOrderMetricRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The region ID.
+   * The ID of the region.
    * 
    * @example
    * cn-hangzhou