@alicloud/sae20190506 2.12.1 → 2.12.3

package/src/models/DescribeApplicationSlbsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApplicationSlbsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The ID of the application.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeApplicationSlbsResponseBody.ts

@@ -5,18 +5,30 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApplicationSlbsResponseBodyDataInternet extends $dara.Model {
   connectionDrainTimeout?: number;
   /**
+   * @remarks
+   * The cookie that is configured on the server.
+   * 
+   * The cookie must be 1 to 200 characters in length and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($).
+   * 
+   * > This parameter is required when `StickySession` is set to `true` and `StickySessionType` is set to `server`.
+   * 
    * @example
    * wwe
    */
   cookie?: string;
   /**
+   * @remarks
+   * The cookie timeout period. Unit: seconds. Valid values: `1` to `86400`.
+   * 
+   * > This parameter is required when `StickySession` is set to `true` and `StickySessionType` is set to `insert`.
+   * 
    * @example
    * 56
    */
   cookieTimeout?: number;
   /**
    * @remarks
-   * The timestamp when the canary release rule was created.
+   * The time when the rule was created. This value is a UNIX timestamp.
    * 
    * @example
    * 1741247308294
@@ -24,13 +36,16 @@ export class DescribeApplicationSlbsResponseBodyDataInternet extends $dara.Model
   createTime?: number;
   enableConnectionDrain?: boolean;
   /**
+   * @remarks
+   * The ID of the CA certificate for the HTTPS protocol.
+   * 
    * @example
    * 1513561019707729_16f37aae5f3_-375882821_-169099****
    */
   httpsCaCertId?: string;
   /**
    * @remarks
-   * The supported protocol.
+   * The ID of the certificate for the HTTPS protocol.
    * 
    * @example
    * 1513561019707729_16f37aae5f3_-375882821_-169099****
@@ -38,7 +53,7 @@ export class DescribeApplicationSlbsResponseBodyDataInternet extends $dara.Model
   httpsCertId?: string;
   /**
    * @remarks
-   * The ID of the internal-facing SLB instance.
+   * The listening port of the SLB instance.
    * 
    * @example
    * 80
@@ -46,25 +61,37 @@ export class DescribeApplicationSlbsResponseBodyDataInternet extends $dara.Model
   port?: number;
   /**
    * @remarks
-   * The container port.
+   * The supported protocol.
    * 
    * @example
    * TCP
    */
   protocol?: string;
   /**
+   * @remarks
+   * Indicates whether session persistence is enabled.
+   * 
    * @example
    * false
    */
   stickySession?: boolean;
   /**
+   * @remarks
+   * The cookie handling method. Valid values:
+   * 
+   * - `insert`: inserts a cookie. When a client makes the first request, the SLB instance inserts a cookie into the response. The next request from the client contains the cookie, and the SLB instance forwards the request to the same backend server.
+   * 
+   * - `server`: rewrites a cookie. When the SLB instance detects a user-defined cookie, it rewrites the cookie. The next request from the client contains the new cookie, and the SLB instance forwards the request to the same backend server.
+   * 
+   * > This parameter is required when `StickySession` is set to `true`.
+   * 
    * @example
    * insert
    */
   stickySessionType?: string;
   /**
    * @remarks
-   * The port specified for the SLB listener.
+   * The container port.
    * 
    * @example
    * 8080
@@ -119,18 +146,30 @@ export class DescribeApplicationSlbsResponseBodyDataInternet extends $dara.Model
 export class DescribeApplicationSlbsResponseBodyDataIntranet extends $dara.Model {
   connectionDrainTimeout?: number;
   /**
+   * @remarks
+   * The cookie that is configured on the server.
+   * 
+   * The cookie must be 1 to 200 characters in length and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($).
+   * 
+   * > This parameter is required when `StickySession` is set to `true` and `StickySessionType` is set to `server`.
+   * 
    * @example
    * wwe
    */
   cookie?: string;
   /**
+   * @remarks
+   * The cookie timeout period. Unit: seconds. Valid values: `1` to `86400`.
+   * 
+   * > This parameter is required when `StickySession` is set to `true` and `StickySessionType` is set to `insert`.
+   * 
    * @example
    * 56
    */
   cookieTimeout?: number;
   /**
    * @remarks
-   * The timestamp when the canary release rule was created.
+   * The time when the rule was created. This value is a UNIX timestamp.
    * 
    * @example
    * 1741247308294
@@ -138,13 +177,16 @@ export class DescribeApplicationSlbsResponseBodyDataIntranet extends $dara.Model
   createTime?: number;
   enableConnectionDrain?: boolean;
   /**
+   * @remarks
+   * The ID of the CA certificate for the HTTPS protocol.
+   * 
    * @example
    * 1513561019707729_16f37aae5f3_-375882821_-169099****
    */
   httpsCaCertId?: string;
   /**
    * @remarks
-   * The supported protocol.
+   * The ID of the certificate for the HTTPS protocol.
    * 
    * @example
    * 1513561019707729_16f37aae5f3_-375882821_-169099****
@@ -152,7 +194,7 @@ export class DescribeApplicationSlbsResponseBodyDataIntranet extends $dara.Model
   httpsCertId?: string;
   /**
    * @remarks
-   * The IP address of the Internet-facing SLB instance.
+   * The listening port of the SLB instance.
    * 
    * @example
    * 80
@@ -160,25 +202,37 @@ export class DescribeApplicationSlbsResponseBodyDataIntranet extends $dara.Model
   port?: number;
   /**
    * @remarks
-   * The container port.
+   * The supported protocol.
    * 
    * @example
    * TCP
    */
   protocol?: string;
   /**
+   * @remarks
+   * Indicates whether session persistence is enabled.
+   * 
    * @example
    * false
    */
   stickySession?: boolean;
   /**
+   * @remarks
+   * The cookie handling method. Valid values:
+   * 
+   * - `insert`: inserts a cookie. When a client makes the first request, the SLB instance inserts a cookie into the response. The next request from the client contains the cookie, and the SLB instance forwards the request to the same backend server.
+   * 
+   * - `server`: rewrites a cookie. When the SLB instance detects a user-defined cookie, it rewrites the cookie. The next request from the client contains the new cookie, and the SLB instance forwards the request to the same backend server.
+   * 
+   * > This parameter is required when `StickySession` is set to `true`.
+   * 
    * @example
    * insert
    */
   stickySessionType?: string;
   /**
    * @remarks
-   * The port specified for the SLB listener.
+   * The container port.
    * 
    * @example
    * 8080
@@ -231,8 +285,20 @@ export class DescribeApplicationSlbsResponseBodyDataIntranet extends $dara.Model
 }
 
 export class DescribeApplicationSlbsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The application ID.
+   */
   appId?: string;
+  /**
+   * @remarks
+   * The application name.
+   */
   appName?: string;
+  /**
+   * @remarks
+   * The cluster ID.
+   */
   clusterId?: string;
   /**
    * @remarks
@@ -241,25 +307,31 @@ export class DescribeApplicationSlbsResponseBodyData extends $dara.Model {
   internet?: DescribeApplicationSlbsResponseBodyDataInternet[];
   /**
    * @remarks
-   * The ID of the Internet-facing SLB instance.
+   * The public IP address.
    * 
    * @example
    * ``59.74.**.**``
    */
   internetIp?: string;
   /**
+   * @remarks
+   * The billing method of the Internet-facing SLB instance.
+   * 
    * @example
    * PayBySpec
    */
   internetSlbChargeType?: string;
   /**
+   * @remarks
+   * Indicates whether the Internet-facing SLB instance has expired.
+   * 
    * @example
    * false
    */
   internetSlbExpired?: boolean;
   /**
    * @remarks
-   * Configurations of Internet-facing SLB instances.
+   * The ID of the Internet-facing SLB instance.
    * 
    * @example
    * lb-uf6xc7wybefehnv45****
@@ -272,28 +344,31 @@ export class DescribeApplicationSlbsResponseBodyData extends $dara.Model {
   intranet?: DescribeApplicationSlbsResponseBodyDataIntranet[];
   /**
    * @remarks
-   * The error code.
-   * 
-   * *   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.
+   * The private IP address.
    * 
    * @example
-   * 192.168.0.0
+   * 192.168.XX.XX
    */
   intranetIp?: string;
   /**
+   * @remarks
+   * The billing method of the internal-facing SLB instance.
+   * 
    * @example
    * PayBySpec
    */
   intranetSlbChargeType?: string;
   /**
+   * @remarks
+   * Indicates whether the internal-facing SLB instance has expired.
+   * 
    * @example
    * false
    */
   intranetSlbExpired?: boolean;
   /**
    * @remarks
-   * The IP address of the internal-facing SLB instance.
+   * The ID of the internal-facing SLB instance.
    * 
    * @example
    * lb-uf6xc7wybefehnv45****
@@ -353,10 +428,15 @@ export class DescribeApplicationSlbsResponseBodyData extends $dara.Model {
 export class DescribeApplicationSlbsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the information about the SLB instances that are associated with an application was obtained successfully. Valid values:
+   * The HTTP status code. Valid values:
+   * 
+   * - `2xx`: The request is successful.
    * 
-   * *   **true**: indicates that the information was obtained successfully.
-   * *   **false**: indicates that the information failed to be obtained.
+   * - `3xx`: The request is redirected.
+   * 
+   * - `4xx`: A client error occurs.
+   * 
+   * - `5xx`: A server error occurs.
    * 
    * @example
    * 200
@@ -364,22 +444,25 @@ export class DescribeApplicationSlbsResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The returned result.
    */
   data?: DescribeApplicationSlbsResponseBodyData;
   /**
    * @remarks
-   * The HTTP status code. Valid values:
+   * The error code.
+   * 
+   * - This parameter is not returned if the request is successful.
    * 
-   * *   **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.
+   * - This parameter is returned if the request fails. For more information, see the **Error codes** section in this topic.
    */
   errorCode?: string;
   /**
    * @remarks
-   * The ID of the trace. It can be used to query the details of a request.
+   * The returned message.
+   * 
+   * - If the request is successful, `success` is returned.
+   * 
+   * - If the request fails, a specific error code is returned.
    * 
    * @example
    * success
@@ -387,23 +470,27 @@ export class DescribeApplicationSlbsResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The returned message.
-   * 
-   * *   **success** is returned when the request succeeds.
-   * *   An error code is returned when the request fails.
+   * The request ID.
    * 
    * @example
    * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the configuration of the SLB instance was obtained. Valid values:
+   * 
+   * - `true`: The configuration was obtained.
+   * 
+   * - `false`: The configuration failed to be obtained.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
    * @remarks
-   * The returned data.
+   * The trace ID that is used to query the details of a request.
    * 
    * @example
    * 0a98a02315955564772843261e****

package/src/models/DescribeApplicationStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application.
+   * The application ID.
    * 
    * @example
    * 0099b7be-5f5b-4512-a7fc-56049ef1****
@@ -13,10 +13,11 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * Indicates whether Application Real-Time Monitoring Service (ARMS) advanced monitoring is enabled. Valid values:
+   * Indicates whether ARMS Advanced Edition is enabled. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
    * 
    * @example
    * false
@@ -32,7 +33,7 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   armsApmInfo?: string;
   /**
    * @remarks
-   * The time when the application was created.
+   * The time when the application was created. This value is a UNIX timestamp.
    * 
    * @example
    * 1563373372746
@@ -42,9 +43,11 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
    * @remarks
    * The current status of the application. Valid values:
    * 
-   * *   **RUNNING**
-   * *   **STOPPED**
-   * *   **UNKNOWN**
+   * - **RUNNING**: The application is running.
+   * 
+   * - **STOPPED**: The application is stopped.
+   * 
+   * - **UNKNOWN**: The application status is unknown.
    * 
    * @example
    * RUNNING
@@ -52,10 +55,11 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   currentStatus?: string;
   /**
    * @remarks
-   * Indicates whether SAE agent is enabled.
+   * Indicates whether the SAE agent is enabled. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * false
@@ -71,7 +75,7 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   fileSizeLimit?: number;
   /**
    * @remarks
-   * The ID of the latest change order that is executed. If no change orders are executed or if change orders expire, this parameter is left empty.
+   * The ID of the most recently executed change order. This parameter is empty if no change order was executed or if the information about the change order has expired.
    * 
    * @example
    * 1ccc2339-fc19-49aa-bda0-1e7b8497****
@@ -79,10 +83,11 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   lastChangeOrderId?: string;
   /**
    * @remarks
-   * Indicates whether the latest change order is being executed. Valid values:
+   * Indicates whether the most recent change order is being executed. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**
    * 
    * @example
    * false
@@ -90,18 +95,27 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   lastChangeOrderRunning?: boolean;
   /**
    * @remarks
-   * The status of the latest change order. Valid values:
-   * 
-   * *   **READY**: The change order is ready.
-   * *   **RUNNING**: The change order is being executed.
-   * *   **SUCCESS**: The change order was executed.
-   * *   **FAIL**: The change order failed to be executed.
-   * *   **ABORT**: The change order is stopped.
-   * *   **WAIT_BATCH_CONFIRM**: The change order is pending execution. You must manually confirm the release batch.
-   * *   **AUTO_BATCH_WAIT**: The change order is pending execution. SAE will automatically confirm the release batch.
-   * *   **SYSTEM_FAIL**: A system exception occurred.
-   * *   **WAIT_APPROVAL**: The change order is pending approval.
-   * *   **APPROVED**: The change order is approved and is pending execution.
+   * The status of the most recent change order. Valid values:
+   * 
+   * - **READY**: The change order is ready.
+   * 
+   * - **RUNNING**: The change order is being executed.
+   * 
+   * - **SUCCESS**: The change order was successful.
+   * 
+   * - **FAIL**: The change order failed.
+   * 
+   * - **ABORT**: The change order was aborted.
+   * 
+   * - **WAIT_BATCH_CONFIRM**: The change order is waiting for manual confirmation for the next batch.
+   * 
+   * - **AUTO_BATCH_WAIT**: The change order is in a waiting state for an automatic batch.
+   * 
+   * - **SYSTEM_FAIL**: A system error occurred.
+   * 
+   * - **WAIT_APPROVAL**: The change order is pending approval.
+   * 
+   * - **APPROVED**: The change order is approved and is pending execution.
    * 
    * @example
    * SUCCESS
@@ -117,10 +131,11 @@ export class DescribeApplicationStatusResponseBodyData extends $dara.Model {
   runningInstances?: number;
   /**
    * @remarks
-   * The substatus of the change order. This parameter indicates whether an exception occurred while the change order was being executed. Valid values:
+   * The substatus of the change order. This parameter is used to determine whether an exception occurs during the release process. Valid values:
+   * 
+   * - **NORMAL**: The release is normal.
    * 
-   * *   **NORMAL**
-   * *   **RUNNING_BUT_HAS_ERROR**: For example, if an error occurs during a phased release, you must manually roll back the application. In this case, the change order cannot be completed because the change order is still being executed.
+   * - **RUNNING_BUT_HAS_ERROR**: The release is abnormal. For example, if an error occurs during a phased release, you must manually roll back the release. In this case, the change order cannot be completed and the status of the change order remains **RUNNING**.
    * 
    * @example
    * NORMAL
@@ -174,10 +189,13 @@ export class DescribeApplicationStatusResponseBody extends $dara.Model {
    * @remarks
    * The HTTP status code. Valid values:
    * 
-   * *   **2xx**: The call was successful.
-   * *   **3xx**: The call was redirected.
-   * *   **4xx**: The call failed.
-   * *   **5xx**: A server error occurred.
+   * - **2xx**: The request was successful.
+   * 
+   * - **3xx**: The request was redirected.
+   * 
+   * - **4xx**: The request was invalid.
+   * 
+   * - **5xx**: A server error occurred.
    * 
    * @example
    * 200
@@ -185,23 +203,25 @@ export class DescribeApplicationStatusResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned result.
+   * The response data.
    */
   data?: DescribeApplicationStatusResponseBodyData;
   /**
    * @remarks
-   * The error code. Valid values:
+   * The error code.
+   * 
+   * - If the request is successful, this parameter is not returned.
    * 
-   * *   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.
+   * - If the request fails, this parameter is returned. For more information, see the **Error codes** section in this topic.
    */
   errorCode?: string;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * The response message.
    * 
-   * *   success: If the call is successful, **success** is returned.
-   * *   An error code: If the call fails, an error code is returned.
+   * - If the call is successful, **success** is returned.
+   * 
+   * - If the call fails, an error message is returned.
    * 
    * @example
    * success
@@ -217,10 +237,11 @@ export class DescribeApplicationStatusResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the status of the application was queried. Valid values:
+   * Indicates whether the application status was obtained. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**: The status was queried.
-   * *   **false**: The status failed to be queried.
+   * - **false**
    * 
    * @example
    * true
@@ -228,7 +249,7 @@ export class DescribeApplicationStatusResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The trace ID that is used to query the details of the request.
+   * The trace ID that is used to query the details of a request.
    * 
    * @example
    * 0a98a02315955564772843261e****

package/src/models/DescribeChangeOrderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeChangeOrderRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the change order. You can call the [ListChangeOrders](https://help.aliyun.com/document_detail/126615.html) operation to obtain the ID.
+   * The change order ID. You can obtain it by calling the [ListChangeOrders](https://help.aliyun.com/document_detail/126615.html) interface.
    * 
    * This parameter is required.
    *