@alicloud/sae20190506 2.12.2 → 2.12.3

package/src/models/CreateApplicationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApplicationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application that is created.
+   * The ID of the successfully created application.
    * 
    * @example
    * 017f39b8-dfa4-4e16-a84b-1dcee4b1****
@@ -13,7 +13,7 @@ export class CreateApplicationResponseBodyData extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * The ID of the change order. It can be used to query the task status.
+   * The returned release order ID, used to query the task execution status.
    * 
    * @example
    * 01db03d3-3ee9-48b3-b3d0-dfce2d88****
@@ -45,12 +45,15 @@ export class CreateApplicationResponseBodyData extends $dara.Model {
 export class CreateApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code. Valid values:
+   * The API status or POP error code. Valid values:
    * 
-   * *   **2xx**: indicates that the request was successful.
-   * *   **3xx**: indicates that the request was redirected.
-   * *   **4xx**: indicates that the request was invalid.
-   * *   **5xx**: indicates that a server error occurred.
+   * - **2xx**: Success.
+   * 
+   * - **3xx**: Redirection.
+   * 
+   * - **4xx**: Request error.
+   * 
+   * - **5xx**: Server error.
    * 
    * @example
    * 200
@@ -58,23 +61,28 @@ export class CreateApplicationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The returned result.
    */
   data?: CreateApplicationResponseBodyData;
   /**
    * @remarks
    * The error code. Valid values:
    * 
-   * *   The **ErrorCode** parameter is not returned when the request succeeds.
-   * *   The **ErrorCode** parameter is returned when the request fails. For more information, see **Error codes** in this topic.
+   * - If the request is successful, the **ErrorCode** field is not returned.
+   * 
+   * - If the request fails, the **ErrorCode** field is returned. For more information, see the error code list in this topic.
+   * 
+   * @example
+   * 空
    */
   errorCode?: string;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * Additional information. Valid values:
    * 
-   * *   If the request was successful, a success message is returned.
-   * *   If the request failed, an error code is returned.
+   * - If the request is normal, **success** is returned.
+   * 
+   * - If the request is abnormal, a specific error code is returned.
    * 
    * @example
    * success
@@ -82,7 +90,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
@@ -90,10 +98,11 @@ export class CreateApplicationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the application is created. Valid values:
+   * Whether the application is created successfully. Valid values:
+   * 
+   * - **true**: Created successfully.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: Failed to create.
    * 
    * @example
    * true
@@ -101,7 +110,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The ID of the trace. It is used to query the details of a request.
+   * The trace ID, used for term query of call information.
    * 
    * @example
    * 0a98a02315955564772843261e****

package/src/models/CreateApplicationScalingRuleRequest.ts

@@ -13,15 +13,20 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
    * 7171a6ca-d1cd-4928-8642-7d5cfe69****
    */
   appId?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable idle mode for the application.
+   */
   enableIdle?: boolean;
   /**
    * @remarks
-   * The percentage of the minimum number of available instances. Valid values:
+   * The minimum number of ready instances, specified as a percentage of the total number of instances. Valid values:
+   * 
+   * - **-1**: Indicates that a percentage is not used. In this case, the value of `MinReadyInstances` is used.
    * 
-   * *   **-1** (default value): The minimum number of available instances is not determined based on this parameter.
-   * *   **0 to 100**: The minimum number of available instances is calculated by using the following formula: Number of existing instances × Value of MinReadyInstanceRatio × 100%. The calculation result is rounded up to the nearest integer. For example, if the number of existing instances is 5 and MinReadyInstanceRatio is set to 50, the minimum number of available instances is 3.
+   * - **0\\~100**: A percentage. The result is rounded up. For example, if you set this parameter to 50 (%) and the application has 5 instances, the minimum number of ready instances is 3.
    * 
-   * >  When **MinReadyInstance** and **MinReadyInstanceRatio** are passed at the same time and the **MinReadyInstanceRatio** value is not \\*\\*-1\\*\\*, the **MinReadyInstanceRatio** parameter takes precedence. **Note**When both **MinReadyInstance** and **MinReadyInstanceRatio** are specified and **MinReadyInstanceRatio** is set to a number from 0 to 100, the value of **MinReadyInstanceRatio** takes precedence.
+   * > If you specify both `MinReadyInstances` and a `MinReadyInstanceRatio` other than `-1`, `MinReadyInstanceRatio` takes precedence. For example, if `MinReadyInstances` is set to `5` and `MinReadyInstanceRatio` is set to `50`, the system uses `50` (%) to calculate the minimum number of ready instances.
    * 
    * @example
    * -1
@@ -29,12 +34,13 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
   minReadyInstanceRatio?: number;
   /**
    * @remarks
-   * The minimum number of available instances. Special values:
+   * The minimum number of ready instances. Valid values:
    * 
-   * *   If you set the value to **0**, business is interrupted when the application is updated.
-   * *   If you set this property to -1, the system calculates a recommended value as the minimum number of available instances by using the following formula: Recommended value = Number of existing instances × 25%. The calculation result is rounded up to the nearest integer. For example, if the number of existing instances is 5, the recommended value is calculated by using the following formula: 5 × 25% = 1.25. In this case, the minimum number of available instances is 2.
+   * - If you set this parameter to `0`, the application is interrupted during an update.
    * 
-   * >  To ensure business continuity, make sure that at least one instance is available during application deployment and rollback.
+   * - If you set this parameter to `-1`, the system sets the value to 25% of the current number of instances, rounded up. For example, if the application has 5 instances, the minimum number of ready instances is 2 (5 × 25% = 1.25, rounded up to 2).
+   * 
+   * > To ensure service continuity during a rolling deployment, we recommend setting the minimum number of ready instances to 1 or more.
    * 
    * @example
    * 3
@@ -44,8 +50,9 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable the auto scaling policy. Valid values:
    * 
-   * *   **true**: The auto scaling policy is enabled.
-   * *   **false**: The auto scaling policy is disabled.
+   * - **true**: Enabled.
+   * 
+   * - **false**: Disabled.
    * 
    * @example
    * true
@@ -53,70 +60,87 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
   scalingRuleEnable?: boolean;
   /**
    * @remarks
-   * The configurations of the metric-based auto scaling policy. This parameter is required if you set the ScalingRuleType parameter to metric.
+   * Configurations for the metric-based auto scaling policy. This parameter is required if `ScalingRuleType` is set to `metric` or `mix`.
+   * 
+   * The parameter is a JSON string that contains the following fields:
+   * 
+   * - **maxReplicas**: The maximum number of application instances.
+   * 
+   * - **minReplicas**: The minimum number of application instances.
+   * 
+   * - **metricType**: The metric that triggers the auto scaling policy. Valid values:
+   * 
+   *   - **CPU**: CPU utilization.
+   * 
+   *   - **MEMORY**: Memory utilization.
+   * 
+   *   - **QPS**: The average queries per second (QPS) per instance for a Java application over a 1-minute period.
+   * 
+   *   - **RT**: The average response time (RT) of all service interfaces for a Java application over a 1-minute period.
+   * 
+   *   - **tcpActiveConn**: The average number of active TCP connections per instance over a 30-second period.
    * 
-   * The following list describes the involved parameters:
+   *   - **SLB_QPS**: The average QPS per instance for a public-facing SLB instance over a 15-second period.
    * 
-   * *   **maxReplicas**: the maximum number of instances in the application.
+   *   - **SLB_RT**: The average RT of a public-facing SLB instance over a 15-second period.
    * 
-   * *   **minReplicas**: the minimum number of instances in the application.
+   *   - **INTRANET_SLB_QPS**: The average QPS per instance for an internal-facing SLB instance over a 15-second period.
    * 
-   * *   **metricType**: the metric that is used to trigger the auto scaling policy.
+   *   - **INTRANET_SLB_RT**: The average RT of an internal-facing SLB instance over a 15-second period.
    * 
-   *     *   **CPU**: the CPU utilization.
-   *     *   **MEMORY**: the memory usage.
-   *     *   **QPS**: the average QPS within 1 minute per Java application instance.
-   *     *   **RT**: the average response time of all API operations within 1 minute in the Java application.
-   *     *   **tcpActiveConn**: the average number of active TCP connections within 30 seconds per instance.
-   *     *   **SLB_QPS**: the average QPS of the Internet-facing SLB instance within 15 seconds per instance.
-   *     *   **SLB_RT**: the average response time of the Internet-facing SLB instance within 15 seconds.
-   *     *   **INTRANET_SLB_QPS**: the average QPS of the internal-facing SLB instance within 15 seconds per instance.
-   *     *   **INTRANET_SLB_RT**: the average response time of the internal-facing SLB instance within 15 seconds.
+   * - **metricTargetAverageUtilization**: The target value for the metric specified by `metricType`. The unit of this value depends on `metricType`.
    * 
-   * *   **metricTargetAverageUtilization**: the limit on the metric that is specified by **metricType**. You can specify following limits:
+   *   - Target CPU utilization, in percentage.
    * 
-   *     *   The limit on the CPU utilization. Unit: percentage.
-   *     *   The limit on the memory usage. Unit: percentage.
-   *     *   The limit on the QPS.
-   *     *   The limit on the response time. Unit: milliseconds.
-   *     *   The limit on the average number of active TCP connections per second.
-   *     *   The limit on the QPS of the Internet-facing SLB instance.
-   *     *   The limit on the response time of the Internet-facing SLB instance. Unit: milliseconds.
-   *     *   The limit on the QPS of the internal-facing SLB instance.
-   *     *   The limit on the response time of the internal-facing SLB instance. Unit: milliseconds.
+   *   - Target memory utilization, in percentage.
    * 
-   * *   **slbId**: the ID of the SLB instance.
+   *   - Target QPS, in requests per second.
    * 
-   * *   **slbProject**: the Simple Log Service (SLS) project.
+   *   - Target response time, in milliseconds.
    * 
-   * *   **slbLogstore**: the SLS Logstore.
+   *   - Average number of active TCP connections.
    * 
-   * *   **vport**: the listener port of the SLB instance. HTTP and HTTPS are supported.
+   *   - Target public-facing SLB QPS, in requests per second.
    * 
-   * *   **scaleUpRules**: the scale-out rules.
+   *   - Target public-facing SLB response time, in milliseconds.
    * 
-   * *   **scaleDownRules**: the scale-in rule.
+   *   - Target internal-facing SLB QPS, in requests per second.
    * 
-   * *   **step**: the scale-out or scale-in step size. This parameter specifies the maximum number of instances that can be added or removed per unit time.
+   *   - Target internal-facing SLB response time, in milliseconds.
    * 
-   * *   **disabled**: specifies whether to disable the application scale-in. If you set this parameter to true, the application instances are never reduced. This prevents business risks during peak hours.
+   * - **slbId**: The SLB instance ID.
    * 
-   *     *   **true**: disables the application scale-in.
-   *     *   **false**: enables the application scale-in. Default value: false.
+   * - **slbProject**: The Log Service project.
    * 
-   * *   **stabilizationWindowSeconds**: the cooldown period during which the system is stable and does not perform scale-out or scale-in operations. Valid values: 0 to 3600. Unit: seconds. Default value: 0.
+   * - **slbLogstore**: The Log Service Logstore.
    * 
-   * >  NoteYou can specify one or more metrics as the trigger conditions of the auto scaling policy. If one of the values of the specified metrics is greater than or equal to the specified limit, the application is scaled out. The number of instances after the scale-out operation is less than or equal to the value of the specified maximum application instances. If the values of all specified metrics are less than the limits, the application is scaled in. The number of instances after the scale-in operation is greater than or equal to the value of the specified minimum application instances.
+   * - **vport**: The SLB listener port. The HTTP and HTTPS protocols are supported.
+   * 
+   * - **scaleUpRules**: The rules to scale out the application.
+   * 
+   * - **scaleDownRules**: The rules to scale in the application.
+   * 
+   * - **step**: The step size for scaling out or scaling in. This is the maximum number of instances that can be added or removed in a single scaling activity.
+   * 
+   * - **disabled**: Specifies whether to prevent the application from scaling in. If set to `true`, the number of application instances is never reduced. This can prevent business risks caused by scaling in during peak hours.
+   * 
+   *   - **true**: Scale-in is disabled.
+   * 
+   *   - **false**: Scale-in is enabled. This is the default value.
+   * 
+   * - **stabilizationWindowSeconds**: The cooldown period for scaling out or scaling in, in seconds. Valid values: 0 to 3600. The default value is 0.
+   * 
+   * > You can configure one or more metrics. If you configure multiple metrics, the application scales out when any of the metrics meets or exceeds its target value, up to the specified maximum number of instances. The application scales in only when all metrics are below their target values, down to the specified minimum number of instances.
    * 
    * @example
-   * {"maxReplicas":3,"minReplicas":1,"metrics":[{"metricType":"CPU","metricTargetAverageUtilization":20},{"metricType":"MEMORY","metricTargetAverageUtilization":30},{"metricType":"tcpActiveConn","metricTargetAverageUtilization":20},{"metricType":"SLB_QPS","MetricTargetAverageUtilization":25,"SlbProject":"aliyun-fc-cn-hangzhou-d95881d9-5d3c-5f26-a6b8-************","SlbLogstore":"function-log","Vport":"80"},{"metricType":"SLB_RT","MetricTargetAverageUtilization":35,"SlbProject":"aliyun-fc-cn-hangzhou-d95881d9-5d3c-5f26-a6b8-************","SlbLogstore":"function-log","Vport":"80"}],"scaleUpRules":{"step":"100","disabled":false,"stabilizationWindowSeconds":0},"scaleDownRules":{"step":"100","disabled":false,"stabilizationWindowSeconds":300}}
+   * {"maxReplicas":3,"minReplicas":1,"metrics":[{"metricType":"CPU","metricTargetAverageUtilization":20},{"metricType":"MEMORY","metricTargetAverageUtilization":30},{"metricType":"tcpActiveConn","metricTargetAverageUtilization":20},{"metricType":"SLB_QPS","MetricTargetAverageUtilization":25,"slbId":"lb-xxx","slbProject":"aliyun-fc-cn-hangzhou-d95881d9-5d3c-5f26-a6b8-************","slbLogstore":"function-log","vport":"80"},{"metricType":"SLB_RT","MetricTargetAverageUtilization":35,"slbId":"lb-xxx","slbProject":"aliyun-fc-cn-hangzhou-d95881d9-5d3c-5f26-a6b8-************","slbLogstore":"function-log","vport":"80"}],"scaleUpRules":{"step":"100","disabled":false,"stabilizationWindowSeconds":0},"scaleDownRules":{"step":"100","disabled":false,"stabilizationWindowSeconds":300}}
    */
   scalingRuleMetric?: string;
   /**
    * @remarks
-   * The name of the auto scaling policy. The name must be unique in an application, and can be up to 32 characters in length. It must start with a lowercase letter and can contain only lowercase letters, digits, and hyphens (-).
+   * The name of the auto scaling policy. The name must be unique within an application, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens (-). The name can be up to 32 characters long.
    * 
-   * >  You cannot change the names of created auto scaling policies.
+   * > The policy name cannot be changed after creation.
    * 
    * This parameter is required.
    * 
@@ -126,40 +150,45 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
   scalingRuleName?: string;
   /**
    * @remarks
-   * The configuration of the scheduled elasticity policy. This parameter is required if you select Scheduled Scaling Policy or Use SDK to Set.
+   * Configurations for the scheduled auto scaling policy. This parameter is required if `ScalingRuleType` is set to `timing` or if you use an SDK.
    * 
-   * The following table describes the parameters.
+   * The parameter is a JSON string that contains the following fields:
    * 
-   * *   **beginDate** and **endDate**: **beginDate** is the start date and **endDate** is the end date, which is used to configure the timing Auto Scaling policy. Valid values:
+   * - **beginDate** and **endDate**: The start and end dates of the policy\\"s effective period.
    * 
-   *     *   If both values are **null**, long-term execution is performed. This is the default value.
-   *     *   If the value is a specific date, for example, the **beginDate** is **2021-03-25** and the **endDate** is **2021-04-25**, the validity period is one month.
+   *   - If both fields are set to `null` (default), the policy is effective indefinitely.
    * 
-   * *   **period**: The period during which the timed Auto Scaling policy is executed. Valid values:
+   *   - If you specify a date range, for example, `beginDate` is `2021-03-25` and `endDate` is `2021-04-25`, the policy is effective for one month.
    * 
-   *     *   **\\* \\* \\***: The scheduled policy is executed at a specified time every day.
+   * - **period**: The recurrence rule for the scheduled auto scaling policy.
    * 
-   *     *   **\\* \\* Fri,Mon**: The scheduled policy is executed at the specified time on the specified number of days per week. You can select multiple time zones. The time zone is GMT +8. Valid values:
+   *   - **\\* \\* \\***: The policy is executed at a specified time every day.
    * 
-   *         *   **Sun**: Sunday
-   *         *   **Mon**: Monday
-   *         *   **Tue**: Tuesday
-   *         *   **Wed**: Wednesday
-   *         *   **Thu**: Thursday
-   *         *   **Fri**: Friday
-   *         *   **Sat**: Saturday
+   *   - **\\* \\* Fri,Mon**: The policy is executed at a specified time on specific days of the week. You can select multiple days. The time is in the GMT+8 time zone. Valid values:
    * 
-   *     *   **1,2,3,28,31 \\* \\***: The scheduled auto scaling policy is executed at a specified point in time on one or more dates of each month. Valid values: 1 to 31. If a month does not have the 31st day, the auto scaling policy is executed on the specified days other than the 31st day.
+   *     - **Sun**: Sunday
    * 
-   * *   **schedules**: the points in time at which the scheduled auto scaling policy is triggered and the number of application instances that are retained during the time periods. You can specify up to 20 points in time. The following list describes the involved parameters:
+   *     - **Mon**: Monday
    * 
-   *     *   **atTime**: the point in time at which the policy is triggered. **targetReplicas**: the number of application instances that you want to retain during the corresponding time period or the minimum number of available instances required for each deployment.****
+   *     - **Tue**: Tuesday
    * 
-   *     *   **Valid values: 1 to 50.** Valid values: 1 to 50.
+   *     - **Wed**: Wednesday
    * 
-   *         **
+   *     - **Thu**: Thursday
    * 
-   *         **Note**Make sure that at least one instance is available during the application deployment and rollback to prevent your business from being interrupted. If you set the value to **0**, business interruptions occur when the application is updated. If you set the value to **0**, business interruptions occur when the application is updated.
+   *     - **Fri**: Friday
+   * 
+   *     - **Sat**: Saturday
+   * 
+   *   - **1,2,3,28,31 \\* \\***: The policy is executed at a specified time on specific days of a month. You can select multiple days. The value can be from 1 to 31. If a month does not have the specified day, for example, the 31st, the policy is not executed on that day for that month.
+   * 
+   * - **schedules**: The trigger times and the corresponding target number of instances. You can specify a maximum of 20 schedules. The parameter includes the following fields:
+   * 
+   *   - **atTime**: The trigger time in `HH:mm` format. For example, `08:00`.
+   * 
+   *   - **targetReplicas**: The target number of application instances. Valid values: 1 to 50.
+   * 
+   *     > During a rolling deployment, we recommend that you set the minimum number of ready instances to 1 or more to prevent service interruptions. If you set the minimum number of ready instances to `0`, your application will be interrupted during an update.
    * 
    * @example
    * {"beginDate":null,"endDate":null,"period":"* * *","schedules":[{"atTime":"08:00","targetReplicas":10},{"atTime":"20:00","targetReplicas":3}]}
@@ -167,19 +196,19 @@ export class CreateApplicationScalingRuleRequest extends $dara.Model {
   scalingRuleTimer?: string;
   /**
    * @remarks
-   * The type of the auto scaling policy. Take note of the following rules:
-   * 
-   * *   **timing**: a scheduled auto scaling policy.
-   * *   **metric**: a metric-based auto scaling policy.
-   * *   **mix**: a hybrid auto scaling policy.
+   * The type of the auto scaling policy. Valid values:
    * 
-   * > 
+   * - **timing**: scheduled auto scaling.
    * 
-   * *   If you set this parameter to timing, the ScalingRuleTimer parameter must be specified.
+   * - **metric**: metric-based auto scaling.
    * 
-   * *   If you set this parameter to metric, the ScalingRuleMetric parameter must be specified.
+   * - **mix**: mixed auto scaling.
    * 
-   * *   If you set this parameter to mix, the ScalingRuleMetric parameter must be specified. You can specify the ScalingRuleTimer parameter based on your business requirements.
+   * > * If you set this parameter to `timing`, the `ScalingRuleTimer` parameter is required.
+   * >
+   * > * If you set this parameter to `metric`, the `ScalingRuleMetric` parameter is required.
+   * >
+   * > * If you set this parameter to `mix`, the `ScalingRuleMetric` parameter is required. You can also configure the `ScalingRuleTimer` parameter as needed.
    * 
    * This parameter is required.
    *