@alicloud/sae20190506 2.8.4 → 2.9.1

package/src/models/CreateIngressRequest.ts

@@ -6,11 +6,11 @@ export class CreateIngressRequest extends $dara.Model {
   addressType?: string;
   /**
    * @remarks
-   * The ID of the certificate that is associated with the **CLB** instance.
+   * The ID of the **CLB** certificate. Valid values:
    * 
    * *   If you set **LoadBalanceType** to **clb**, you can use CertId to configure a certificate for the HTTPS listener.
    * 
-   * For more information about how to manage the SSL certificate IDs that are used by CLB instances, see [Overview](https://help.aliyun.com/document_detail/90792.html).
+   * For more information about how to use SSL certificate IDs for CLB, see [Manage certificates (CLB)](https://help.aliyun.com/document_detail/90792.html).
    * 
    * @example
    * 188077086902****_176993d****_181437****_108724****
@@ -18,10 +18,10 @@ export class CreateIngressRequest extends $dara.Model {
   certId?: string;
   /**
    * @remarks
-   * The IDs of the certificates that are associated with the **ALB** instance.
+   * The ID of the multi-certificate **ALB**. Valid values:
    * 
-   * *   If you set **LoadBalanceType** to **alb**, you can use CertIds to configure multiple certificates for the HTTPS listener. Separate multiple certificate IDs with commas (,).
-   * *   The ID of the SSL certificate that is used by an ALB instance can be obtained from Certificate Management Service. For example, if you specify `756***-cn-hangzhou`, `756***` is the certificate ID that is obtained from the service page, and `-cn-hangzhou` is the fixed suffix. For more information, see [Manage certificates](https://help.aliyun.com/document_detail/209076.html).
+   * *   If the **LoadBalanceType** is **alb**, use this field to configure multiple certificates for HTTPS listeners. Separate multiple certificate IDs with commas (,).
+   * *   The ID of the SSL certificate used by ALB must be obtained from the digital certificate product. For example, in the configuration `756***-cn-hangzhou`, the `756***` is the certificate ID obtained from the product page, and the `-cn-hangzhou` is a fixed suffix. For more information, see [Manage certificates](https://help.aliyun.com/document_detail/209076.html).
    * 
    * @example
    * 87***35-cn-hangzhou,812***3-cn-hangzhou
@@ -30,9 +30,12 @@ export class CreateIngressRequest extends $dara.Model {
   corsConfig?: string;
   /**
    * @remarks
-   * Default forwarding rule. Traffic is forwarded to the specified application through a designated port based on the IP address. Parameter descriptions are as follows:
-   * - **appId**: Application ID. - **containerPort**: Application instance port.
-   * > All requests that do not match or do not meet the **Rules** for forwarding will be directed to this specified application.
+   * The default forwarding rule. Forwards traffic to a specified application through a specified port based on the IP address. The following table describes the parameters.
+   * 
+   * *   **appId**: the ID of the application.
+   * *   **containerPort**: The port of the application instance.
+   * 
+   * >  All requests that do not match or satisfy **Rules** forwarding rules are forwarded to the specified application.
    * 
    * This parameter is required.
    * 
@@ -42,7 +45,7 @@ export class CreateIngressRequest extends $dara.Model {
   defaultRule?: string;
   /**
    * @remarks
-   * Route rule name.
+   * The name of the routing rule.
    * 
    * @example
    * ingress-for-sae-test
@@ -56,7 +59,7 @@ export class CreateIngressRequest extends $dara.Model {
   enableXForwardedForSlbPort?: boolean;
   /**
    * @remarks
-   * The timeout period of an idle connection. Unit: seconds Valid values: 1 to 60. If no requests are received within the specified timeout period, ALB closes the current connection. When a new request is received, ALB establishes a new connection.
+   * Specifies the connection idle timeout period. Unit: seconds. Valid values: 1 to 60. If there is no access request within the timeout period, the SLB will temporarily interrupt the current connection until the next request comes to re-establish a new connection.
    * 
    * @example
    * 15
@@ -64,8 +67,7 @@ export class CreateIngressRequest extends $dara.Model {
   idleTimeout?: number;
   /**
    * @remarks
-   * SThe frontend port that is used by the ALB instance.
-   * Valid values: 1 to 65535.
+   * The SLB listening port. This port cannot be occupied.
    * 
    * This parameter is required.
    * 
@@ -75,8 +77,10 @@ export class CreateIngressRequest extends $dara.Model {
   listenerPort?: number;
   /**
    * @remarks
-   * Request forwarding protocol. The value description is as follows:
-   * - **HTTP**: Suitable for applications that need to identify data content. - **HTTPS**: Suitable for applications that require encrypted transmission.
+   * The request forwarding protocol. Valid values:
+   * 
+   * *   **HTTP**: suitable for applications that need to identify data content.
+   * *   **HTTPS**: suitable for applications that require encrypted transmission.
    * 
    * @example
    * HTTP
@@ -84,10 +88,10 @@ export class CreateIngressRequest extends $dara.Model {
   listenerProtocol?: string;
   /**
    * @remarks
-   * The type of the SLB instance. The instance type can be specified only when you create a routing rule. You cannot change the instance type when you update the routing rule. Valid values:
+   * SLB the type of the SLB instance. It depends on the type that you entered when you created the routing rule and cannot be changed when you update it. Valid values:
    * 
-   * *   **clb**
-   * *   **alb**
+   * *   **clb**: traditional SLB CLB (formerly SLB).
+   * *   **alb**: Applied SLB ALB.
    * 
    * @example
    * clb
@@ -96,7 +100,7 @@ export class CreateIngressRequest extends $dara.Model {
   loadBalancerEdition?: string;
   /**
    * @remarks
-   * The ID of the namespace where the application is located. Currently, cross-namespace applications are not supported.
+   * The ID of the namespace where the application resides. Currently, cross-namespace applications are not supported.
    * 
    * This parameter is required.
    * 
@@ -106,7 +110,7 @@ export class CreateIngressRequest extends $dara.Model {
   namespaceId?: string;
   /**
    * @remarks
-   * The timeout period of a request. Unit: seconds. Valid values: 1 to 180. If no response is received from the backend server within the specified timeout period, ALB stops waiting for the response and returns an HTTP 504 error code to the client.
+   * Specifies the request timeout period. Unit: seconds. Valid values: 1 to 180. If the backend server does not respond within the timeout period, the SLB abandons the wait and returns an HTTP 504 error code to the client.
    * 
    * @example
    * 3
@@ -114,16 +118,16 @@ export class CreateIngressRequest extends $dara.Model {
   requestTimeout?: number;
   /**
    * @remarks
-   * The forwarding rules. You can specify a port and an application in a forwarding rule to forward traffic based on the specified domain name and request path. The following list describes the involved parameters:
+   * The forwarding rule. Forwards traffic to a specified application through a specified port based on the domain name and request path. The following table describes the parameters.
    * 
    * *   **appId**: the ID of the application.
-   * *   **containerPort**: the container port of the application.
+   * *   **containerPort**: The port of the application instance.
    * *   **domain**: the domain name.
    * *   **path**: the request path.
-   * *   **backendProtocol**: the backend service protocol. Valid values: http, https, and grpc. Default value: http.
-   * *   **rewritePath**: the rewrite path.
+   * *   **backendProtocol**: The backend service protocol. Valid values: http, https, and grpc. Default value: http.
+   * *   **rewritePath**: Rewrite the path.
    * 
-   * >  The path rewrite feature is supported only by ALB instances.
+   * >  Only ALB allows you to set the RewritePath feature. CLB does not support this feature.
    * 
    * This parameter is required.
    * 
@@ -133,7 +137,7 @@ export class CreateIngressRequest extends $dara.Model {
   rules?: string;
   /**
    * @remarks
-   * The ID of a security policy.
+   * The ID of the security policy instance.
    * 
    * @example
    * sp-bp1bpn0kn9****
@@ -143,7 +147,7 @@ export class CreateIngressRequest extends $dara.Model {
    * @remarks
    * The Server Load Balancer (SLB) instance that is used by the routing rule.
    * 
-   * >  The SLB instance can be a Classic Load Balancer (CLB) instance or an Application Load Balancer (ALB) instance.
+   * >  SLB SLB instances include CLB instances and ALB instances.
    * 
    * @example
    * lb-uf6hucc7inlqrtcq5****

package/src/models/CreateIngressResponseBody.ts

@@ -35,11 +35,11 @@ export class CreateIngressResponseBodyData extends $dara.Model {
 export class CreateIngressResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code. Valid values:
+   * The HTTP status code or the error code. Valid values:
    * 
-   * *   **2xx**: The call was successful.
-   * *   **3xx**: The call was redirected.
-   * *   **4xx**: The call failed.
+   * *   **2xx**: The request was successful.
+   * *   **3xx**: The request was redirected.
+   * *   **4xx**: The request failed.
    * *   **5xx**: A server error occurred.
    * 
    * @example
@@ -48,15 +48,15 @@ export class CreateIngressResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response.
+   * Responses.
    */
   data?: CreateIngressResponseBodyData;
   /**
    * @remarks
-   * The error code returned. Take note of the following rules:
+   * Error code. Valid values:
    * 
-   * *   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.
+   * *   If the request is successful, no **ErrorCode** fields are returned.
+   * *   Request failed: **ErrorCode** fields are returned. For more information, see **Error codes**.
    * 
    * @example
    * success
@@ -64,10 +64,10 @@ export class CreateIngressResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The additional information that is returned. Valid values:
+   * Additional information. Valid values:
    * 
-   * *   success: If the call is successful, **success** is returned.
-   * *   An error code: If the call fails, an error code is returned.
+   * *   The error message returned because the request is normal and **success** is returned.
+   * *   If the request is abnormal, the specific exception error code is returned.
    * 
    * @example
    * success
@@ -83,10 +83,10 @@ export class CreateIngressResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the Secret is successfully deleted. Valid values:
+   * Indicates whether the routing rule was created. Valid values:
    * 
-   * *   **true**: The instance was deleted.
-   * *   **false**: The instance failed to be deleted.
+   * *   **true**: The ConfigMap was created.
+   * *   **false**: The ConfigMap failed to be created.
    * 
    * @example
    * true
@@ -94,7 +94,7 @@ export class CreateIngressResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The ID of the trace. It is used to query the details of a request.
+   * The ID of the trace. This parameter is used to query the exact call information.
    * 
    * @example
    * 0a98a02315955564772843261e****

package/src/models/CreateOrUpdateSwimmingLaneGroupRequest.ts

@@ -3,33 +3,59 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateOrUpdateSwimmingLaneGroupRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the baseline application.
+   */
   appIds?: string[];
   /**
+   * @remarks
+   * The unique ID of the corresponding gateway.
+   * 
    * @example
    * mse_ingresspost-cn-axc49******
    */
   entryAppId?: string;
   /**
+   * @remarks
+   * The application entry type (gateway type).
+   * 
+   * *   **apig:** cloud-native API Gateway
+   * *   **mse:** Java Services Gateway
+   * *   **mse-gw:** MSE cloud-native Gateway
+   * 
    * @example
    * mse-gw
    */
   entryAppType?: string;
   /**
+   * @remarks
+   * The ID of the lane group. This is required when you update a lane group.
+   * 
    * @example
    * 2047
    */
   groupId?: number;
   /**
+   * @remarks
+   * The name of the lane group.
+   * 
    * @example
    * mse-test
    */
   groupName?: string;
   /**
+   * @remarks
+   * The ID of a namespace.
+   * 
    * @example
    * cn-beijing:test
    */
   namespaceId?: string;
   /**
+   * @remarks
+   * The end-to-end grayscale version. Valid values: 0 and 2 (recommended).
+   * 
    * @example
    * 2
    */

package/src/models/CreateOrUpdateSwimmingLaneGroupResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateOrUpdateSwimmingLaneGroupResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the lane group.
+   * 
    * @example
    * 2074
    */
@@ -31,28 +34,65 @@ export class CreateOrUpdateSwimmingLaneGroupResponseBodyData extends $dara.Model
 
 export class CreateOrUpdateSwimmingLaneGroupResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The HTTP status code or the error code. Valid values:
+   * 
+   * *   **2xx**: The request was successful.
+   * *   **3xx**: Redirection.
+   * *   **4xx**: The request failed.
+   * *   **5xx**: Server error.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The application information.
+   */
   data?: CreateOrUpdateSwimmingLaneGroupResponseBodyData;
+  /**
+   * @remarks
+   * The status code. Value values:
+   * 
+   * *   If the request was successful, **ErrorCode** is not returned.
+   * *   If the request failed, **ErrorCode** is returned. For more information, see **Error codes** in this topic.
+   */
   errorCode?: string;
   /**
+   * @remarks
+   * Additional information. Valid values:
+   * 
+   * *   The error message returned because the request is normal and **success** is returned.
+   * *   If the request is abnormal, the specific exception error code is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the lane group is created. Valid values:
+   * 
+   * *   **true**: Created successfully.
+   * *   **false**: The ConfigMap failed to be created.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The ID of the trace. This parameter is used to query the exact call information.
+   * 
    * @example
    * 0a98a02315955564772843261e****
    */

package/src/models/CreateOrUpdateSwimmingLaneGroupShrinkRequest.ts

@@ -3,33 +3,59 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateOrUpdateSwimmingLaneGroupShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the baseline application.
+   */
   appIdsShrink?: string;
   /**
+   * @remarks
+   * The unique ID of the corresponding gateway.
+   * 
    * @example
    * mse_ingresspost-cn-axc49******
    */
   entryAppId?: string;
   /**
+   * @remarks
+   * The application entry type (gateway type).
+   * 
+   * *   **apig:** cloud-native API Gateway
+   * *   **mse:** Java Services Gateway
+   * *   **mse-gw:** MSE cloud-native Gateway
+   * 
    * @example
    * mse-gw
    */
   entryAppType?: string;
   /**
+   * @remarks
+   * The ID of the lane group. This is required when you update a lane group.
+   * 
    * @example
    * 2047
    */
   groupId?: number;
   /**
+   * @remarks
+   * The name of the lane group.
+   * 
    * @example
    * mse-test
    */
   groupName?: string;
   /**
+   * @remarks
+   * The ID of a namespace.
+   * 
    * @example
    * cn-beijing:test
    */
   namespaceId?: string;
   /**
+   * @remarks
+   * The end-to-end grayscale version. Valid values: 0 and 2 (recommended).
+   * 
    * @example
    * 2
    */

package/src/models/CreateOrUpdateSwimmingLaneRequest.ts

@@ -4,21 +4,43 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateOrUpdateSwimmingLaneRequestAppEntryRuleConditions extends $dara.Model {
   /**
+   * @remarks
+   * Matching Rule:
+   * 
+   * *   The exact match. The condition is met if the traffic value and the condition value are exactly the same.
+   * *   The exact match. The condition is met if the traffic value and the condition value are exactly the same.
+   * *   The inclusive match. The condition is met if the traffic value is included in the specified list.
+   * *   The percentage match. Principle: The condition is met if \\"hash(get(`key`)) % 100 < value\\".
+   * *   Regular match: a regular expression match. The condition is met when the match is based on regular expression rules.
+   * 
    * @example
    * ==
    */
   condition?: string;
   /**
+   * @remarks
+   * The parameter name.
+   * 
    * @example
    * t
    */
   name?: string;
   /**
+   * @remarks
+   * The parameter type. Valid values:
+   * 
+   * *   header
+   * *   param
+   * *   Cookie: forwards requests based on cookies.
+   * 
    * @example
    * Header
    */
   type?: string;
   /**
+   * @remarks
+   * The match value of the condition.
+   * 
    * @example
    * g1
    */
@@ -52,22 +74,49 @@ export class CreateOrUpdateSwimmingLaneRequestAppEntryRuleConditions extends $da
 
 export class CreateOrUpdateSwimmingLaneRequestAppEntryRule extends $dara.Model {
   /**
+   * @remarks
+   * Logical connectors between conditions:
+   * 
+   * *   AND: All conditions are met at the same time.
+   * *   OR: Any condition is met.
+   * 
    * @example
    * AND
    */
   conditionJoiner?: string;
+  /**
+   * @remarks
+   * The conditions that trigger circuit breaking.
+   */
   conditions?: CreateOrUpdateSwimmingLaneRequestAppEntryRuleConditions[];
   /**
+   * @remarks
+   * Whether to enable proportional grayscale.
+   * 
+   * *   true: enabled. After you enable this parameter, you must configure the PercentageByPath.
+   * *   false: disables the service.
+   * 
    * @example
    * true
    */
   independentPercentageEnable?: boolean;
+  /**
+   * @remarks
+   * The matched request path.
+   */
   paths?: string[];
   /**
+   * @remarks
+   * The traffic ratio. Valid values: 0 to 100.
+   * 
    * @example
    * 50
    */
   percentage?: number;
+  /**
+   * @remarks
+   * The traffic configuration.
+   */
   percentageByPath?: { [key: string]: number };
   static names(): { [key: string]: string } {
     return {
@@ -111,21 +160,43 @@ export class CreateOrUpdateSwimmingLaneRequestAppEntryRule extends $dara.Model {
 
 export class CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRuleConditions extends $dara.Model {
   /**
+   * @remarks
+   * The matching rule.
+   * 
+   * *   \\==: exact match.
+   * *   ! =: exact match.
+   * *   in: contains matches.
+   * *   Percentage: Percentage matching.
+   * *   Regular matching: specifies whether a regular expression is used to search for the original string.
+   * 
    * @example
    * ==
    */
   condition?: string;
   /**
+   * @remarks
+   * The parameter name.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The parameter type. Valid values:
+   * 
+   * *   header
+   * *   param
+   * *   Cookie: forwards requests based on cookies.
+   * 
    * @example
    * header
    */
   type?: string;
   /**
+   * @remarks
+   * The match value of the condition.
+   * 
    * @example
    * g1
    */
@@ -159,22 +230,49 @@ export class CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRuleConditions exte
 
 export class CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRule extends $dara.Model {
   /**
+   * @remarks
+   * Logical connectors between conditions:
+   * 
+   * *   AND: All conditions are met at the same time.
+   * *   OR: Any condition is met.
+   * 
    * @example
    * AND
    */
   conditionJoiner?: string;
+  /**
+   * @remarks
+   * Routing Condition
+   */
   conditions?: CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRuleConditions[];
   /**
+   * @remarks
+   * Whether to enable proportional grayscale.
+   * 
+   * *   true: Enabled. After you enable this parameter, you must configure the PercentageByPath.
+   * *   false: Disabled.
+   * 
    * @example
    * true
    */
   independentPercentageEnable?: boolean;
   /**
+   * @remarks
+   * The percentage of traffic replication. Valid values: 0 to 100.
+   * 
    * @example
    * 100
    */
   percentage?: number;
+  /**
+   * @remarks
+   * The traffic configuration.
+   */
   percentageByRoute?: { [key: string]: number };
+  /**
+   * @remarks
+   * The ID of the route.
+   */
   routeIds?: number[];
   static names(): { [key: string]: string } {
     return {
@@ -217,39 +315,78 @@ export class CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRule extends $dara.
 }
 
 export class CreateOrUpdateSwimmingLaneRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The route configuration of the gateway.
+   * 
+   * >  This parameter is required if the gateway entry of the lane group is Java.
+   */
   appEntryRule?: CreateOrUpdateSwimmingLaneRequestAppEntryRule;
   /**
+   * @remarks
+   * Full-link Grayscale Mode:
+   * 
+   * *   0: The request is routed based on the content of the request.
+   * *   1: routing based on percentages
+   * 
    * @example
    * 0
    */
   canaryModel?: number;
   /**
+   * @remarks
+   * Lane Status
+   * 
+   * *   true: enabled
+   * *   false: disabled
+   * 
    * @example
    * true
    */
   enable?: boolean;
   /**
+   * @remarks
+   * The ID of the lane group to which the lane belongs.
+   * 
    * @example
    * b2a8a925-477a-eswa-b823-d5e22500****
    */
   groupId?: number;
   /**
+   * @remarks
+   * The ID of the lane.
+   * 
    * @example
    * 13857
    */
   laneId?: number;
   /**
+   * @remarks
+   * The name of the lane.
+   * 
    * @example
    * test
    */
   laneName?: string;
   /**
+   * @remarks
+   * The tag of the lane.
+   * 
    * @example
    * {"alicloud.service.tag":"g1"}
    */
   laneTag?: string;
+  /**
+   * @remarks
+   * The route configuration of the MSE gateway.
+   * 
+   * >  If the **EntryAppType** is set to **apig** or **mse-gw**, it is required.
+   */
   mseGatewayEntryRule?: CreateOrUpdateSwimmingLaneRequestMseGatewayEntryRule;
   /**
+   * @remarks
+   * The namespace ID.
+   * 
    * @example
    * cn-beijing:test
    */