@alicloud/sae20190506 2.8.4 → 2.9.0

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
    */

package/src/models/CreateOrUpdateSwimmingLaneResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateOrUpdateSwimmingLaneResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the lane.
+   * 
    * @example
    * 22318
    */
@@ -31,28 +34,65 @@ export class CreateOrUpdateSwimmingLaneResponseBodyData extends $dara.Model {
 
 export class CreateOrUpdateSwimmingLaneResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The HTTP status code or the error code. Valid values:
+   * 
+   * *   **2xx**: Success.
+   * *   **3xx**: Redirection.
+   * *   **4xx**: Request error.
+   * *   **5xx**: Server error.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned information.
+   */
   data?: CreateOrUpdateSwimmingLaneResponseBodyData;
+  /**
+   * @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
+   * The message returned. Value description:
+   * 
+   * *   If the request was successful, a success message is returned.
+   * *   An error code is returned if the request failed.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the creation or update was successful. Valid values:
+   * 
+   * *   true: created.
+   * *   false: failed to create.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The ID of the trace. The ID is used to query the details of a request.
+   * 
    * @example
    * 0a98a02315955564772843261e****
    */

package/src/models/CreateOrUpdateSwimmingLaneShrinkRequest.ts

@@ -3,39 +3,78 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateOrUpdateSwimmingLaneShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The route configuration of the gateway.
+   * 
+   * >  This parameter is required if the gateway entry of the lane group is Java.
+   */
   appEntryRuleShrink?: string;
   /**
+   * @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.
+   */
   mseGatewayEntryRuleShrink?: string;
   /**
+   * @remarks
+   * The namespace ID.
+   * 
    * @example
    * cn-beijing:test
    */

package/src/models/DeleteInstancesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteInstancesRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the application.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteInstancesRequest extends $dara.Model {
   appId?: string;
   /**
    * @remarks
+   * The ID of the instance to be deleted.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteInstancesResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteInstancesResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the release order.
+   * 
    * @example
    * 01db03d3-3ee9-48b3-b3d0-dfce2d88****
    */
@@ -31,28 +34,65 @@ export class DeleteInstancesResponseBodyData extends $dara.Model {
 
 export class DeleteInstancesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The HTTP status code or the error code. Valid values:
+   * 
+   * *   **2xx**: The request was successful.
+   * *   **3xx**: The request was redirected.
+   * *   **4xx**: The request failed.
+   * *   **5xx**: A server error occurred.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * Responses.
+   */
   data?: DeleteInstancesResponseBodyData;
+  /**
+   * @remarks
+   * Error code. Valid 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 about the call result. Valid values:
+   * 
+   * *   If the request is normal, 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 instance is deleted successfully. Valid values:
+   * 
+   * *   **true**: The namespace was deleted.
+   * *   **false**: The namespace failed to be deleted.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The ID of the trace. This parameter is used to query the exact call information.
+   * 
    * @example
    * 0a981dd515966966104121683d****
    */