@alicloud/sae20190506 2.8.4 → 2.9.0

package/src/models/ListAllSwimmingLaneGroupsResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAllSwimmingLaneGroupsResponseBodyDataApps extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * f5aad0d0-3e56-44cd-8199-9887a0******
    */
   appId?: string;
   /**
+   * @remarks
+   * The name of the application.
+   * 
    * @example
    * test
    */
   appName?: string;
   /**
+   * @remarks
+   * The ID of the MSE instance.
+   * 
    * @example
    * mse-cn-53y49******
    */
   mseAppId?: string;
   /**
+   * @remarks
+   * The name of the MSE instance.
+   * 
    * @example
    * demo
    */
   mseAppName?: string;
   /**
+   * @remarks
+   * The ID of the namespace to which the MSE instance belongs.
+   * 
    * @example
    * 6733e538-d52f-48e6-91a4-192f91******
    */
@@ -59,31 +74,49 @@ export class ListAllSwimmingLaneGroupsResponseBodyDataApps extends $dara.Model {
 
 export class ListAllSwimmingLaneGroupsResponseBodyDataEntryApp extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * 09805e5d-9b8d-42cd-9442-03c498******
    */
   appId?: string;
   /**
+   * @remarks
+   * The name of the application.
+   * 
    * @example
    * test
    */
   appName?: string;
   /**
+   * @remarks
+   * The type of the application.
+   * 
    * @example
    * mse
    */
   appType?: string;
   /**
+   * @remarks
+   * The ID of the MSE instance.
+   * 
    * @example
    * mse-cn-53y49******
    */
   mseAppId?: string;
   /**
+   * @remarks
+   * MSE Instance Name
+   * 
    * @example
    * test
    */
   mseAppName?: string;
   /**
+   * @remarks
+   * The ID of the namespace to which the MSE instance belongs.
+   * 
    * @example
    * demo
    */
@@ -120,45 +153,88 @@ export class ListAllSwimmingLaneGroupsResponseBodyDataEntryApp extends $dara.Mod
 }
 
 export class ListAllSwimmingLaneGroupsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The IDs of the applications associated with the lane group.
+   */
   appIds?: string[];
+  /**
+   * @remarks
+   * The application information.
+   */
   apps?: ListAllSwimmingLaneGroupsResponseBodyDataApps[];
   /**
+   * @remarks
+   * Full-link Grayscale Mode:
+   * 
+   * *   0: The request is routed based on the content of the request.
+   * *   1: Proportional routing
+   * 
    * @example
    * 0
    */
   canaryModel?: number;
+  /**
+   * @remarks
+   * The entry application.
+   */
   entryApp?: ListAllSwimmingLaneGroupsResponseBodyDataEntryApp;
   /**
+   * @remarks
+   * The ID of the gateway.
+   * 
    * @example
    * mse_ingresspost-cn-axc49******
    */
   entryAppId?: string;
   /**
+   * @remarks
+   * The application entry type (gateway type).
+   * 
+   * *   **apig:** cloud-native API Gateway
+   * *   **mse-gw:** an MSE cloud original gateway
+   * *   **mse:** Java Services Gateway
+   * 
    * @example
    * mse-gw
    */
   entryAppType?: string;
   /**
+   * @remarks
+   * The ID of the lane group.
+   * 
    * @example
    * 2074
    */
   groupId?: number;
   /**
+   * @remarks
+   * The name of a lane group.
+   * 
    * @example
    * mse-test
    */
   groupName?: string;
   /**
+   * @remarks
+   * The ID of the namespace to which the MSE instance belongs.
+   * 
    * @example
    * sae-test
    */
   mseNamespaceId?: string;
   /**
+   * @remarks
+   * The ID of the namespace.
+   * 
    * @example
    * cn-beijing:test
    */
   namespaceId?: string;
   /**
+   * @remarks
+   * The end-to-end grayscale version. Valid values: 0 and 2 (recommended).
+   * 
    * @example
    * 2
    */
@@ -215,28 +291,65 @@ export class ListAllSwimmingLaneGroupsResponseBodyData extends $dara.Model {
 
 export class ListAllSwimmingLaneGroupsResponseBody 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?: ListAllSwimmingLaneGroupsResponseBodyData[];
+  /**
+   * @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 ID of the request.
+   * 
    * @example
    * 30375C38-F4ED-4135-A0AE-5C75DC7F****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values: Valid values:
+   * 
+   * *   **true**: The information was queried.
+   * *   **false**: The information failed to be queried.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The ID of the trace. This parameter is used to query the exact call information.
+   * 
    * @example
    * ac1a0b2215622246421415014e****
    */

package/src/models/ListAllSwimmingLanesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAllSwimmingLanesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the lane group.
+   * 
    * @example
    * 2074
    */
   groupId?: number;
   /**
+   * @remarks
+   * The ID of a namespace.
+   * 
    * @example
    * cn-beijing:test
    */

package/src/models/ListAllSwimmingLanesResponseBody.ts

@@ -4,25 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAllSwimmingLanesResponseBodyDataAppEntryRuleConditions extends $dara.Model {
   /**
+   * @remarks
+   * The matching rule.
+   * 
    * @example
    * ==
    */
   condition?: string;
   /**
+   * @remarks
+   * The parameter name.
+   * 
    * @example
    * t
    */
   name?: string;
   /**
+   * @remarks
+   * The type of the parameter.
+   * 
    * @example
    * Header
    */
   type?: string;
   /**
+   * @remarks
+   * The match value.
+   * 
    * @example
    * g1
    */
   value?: string;
+  /**
+   * @remarks
+   * The match value of the condition.
+   */
   values?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -58,22 +74,46 @@ export class ListAllSwimmingLanesResponseBodyDataAppEntryRuleConditions extends
 
 export class ListAllSwimmingLanesResponseBodyDataAppEntryRule 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 matching condition.
+   */
   conditions?: ListAllSwimmingLanesResponseBodyDataAppEntryRuleConditions[];
   /**
+   * @remarks
+   * Whether to enable proportional grayscale.
+   * 
    * @example
    * true
    */
   independentPercentageEnable?: boolean;
+  /**
+   * @remarks
+   * The request path.
+   */
   paths?: string[];
   /**
+   * @remarks
+   * The traffic ratio. Valid values: 0 to 100.
+   * 
    * @example
    * 50
    */
   percentage?: number;
+  /**
+   * @remarks
+   * Traffic matching.
+   */
   percentageByPath?: { [key: string]: number };
   static names(): { [key: string]: string } {
     return {
@@ -117,26 +157,41 @@ export class ListAllSwimmingLanesResponseBodyDataAppEntryRule extends $dara.Mode
 
 export class ListAllSwimmingLanesResponseBodyDataApps extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * 8ea0c468-8165-416d-beae-531abb******
    */
   appId?: string;
   /**
+   * @remarks
+   * The name of the application.
+   * 
    * @example
    * test
    */
   appName?: string;
   /**
+   * @remarks
+   * The ID of the MSE instance.
+   * 
    * @example
    * mse-cn-53y49******
    */
   mseAppId?: string;
   /**
+   * @remarks
+   * The name of the MSE instance.
+   * 
    * @example
    * sae-test
    */
   mseAppName?: string;
   /**
+   * @remarks
+   * The ID of the namespace to which the MSE instance belongs.
+   * 
    * @example
    * space
    */
@@ -172,21 +227,33 @@ export class ListAllSwimmingLanesResponseBodyDataApps extends $dara.Model {
 
 export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleConditions extends $dara.Model {
   /**
+   * @remarks
+   * The matching rule.
+   * 
    * @example
    * ==
    */
   condition?: string;
   /**
+   * @remarks
+   * The parameter name.
+   * 
    * @example
    * t
    */
   name?: string;
   /**
+   * @remarks
+   * The type of the parameter.
+   * 
    * @example
    * Header
    */
   type?: string;
   /**
+   * @remarks
+   * The match value of the condition.
+   * 
    * @example
    * g1
    */
@@ -220,11 +287,17 @@ export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleConditions e
 
 export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRoutePredicatePathPredicate extends $dara.Model {
   /**
+   * @remarks
+   * The path.
+   * 
    * @example
    * /Path
    */
   path?: string;
   /**
+   * @remarks
+   * The matching rule.
+   * 
    * @example
    * Header
    */
@@ -253,6 +326,10 @@ export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRouteP
 }
 
 export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRoutePredicate extends $dara.Model {
+  /**
+   * @remarks
+   * The path matching rule.
+   */
   pathPredicate?: ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRoutePredicatePathPredicate;
   static names(): { [key: string]: string } {
     return {
@@ -280,15 +357,25 @@ export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRouteP
 
 export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutes extends $dara.Model {
   /**
+   * @remarks
+   * The route ID.
+   * 
    * @example
    * 9504
    */
   routeId?: number;
   /**
+   * @remarks
+   * The name of the route.
+   * 
    * @example
    * demo
    */
   routeName?: string;
+  /**
+   * @remarks
+   * The routing rule.
+   */
   routePredicate?: ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutesRoutePredicate;
   static names(): { [key: string]: string } {
     return {
@@ -320,23 +407,48 @@ export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutes exten
 
 export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRule extends $dara.Model {
   /**
+   * @remarks
+   * The logical connector between conditions.
+   * 
    * @example
    * AND
    */
   conditionJoiner?: string;
+  /**
+   * @remarks
+   * The matching condition.
+   */
   conditions?: ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleConditions[];
   /**
+   * @remarks
+   * Whether to enable proportional grayscale.
+   * 
    * @example
    * true
    */
   independentPercentageEnable?: boolean;
   /**
+   * @remarks
+   * The proportion of path traffic.
+   * 
    * @example
    * 100
    */
   percentage?: number;
+  /**
+   * @remarks
+   * The traffic configuration.
+   */
   percentageByRoute?: { [key: string]: number };
+  /**
+   * @remarks
+   * The IDs of the route tables.
+   */
   routeIds?: number[];
+  /**
+   * @remarks
+   * The detailed configuration of the routing rule.
+   */
   routes?: ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRuleRoutes[];
   static names(): { [key: string]: string } {
     return {
@@ -384,38 +496,74 @@ export class ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRule extends $da
 }
 
 export class ListAllSwimmingLanesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Apply ingress rules.
+   */
   appEntryRule?: ListAllSwimmingLanesResponseBodyDataAppEntryRule;
+  /**
+   * @remarks
+   * The associated application.
+   */
   apps?: ListAllSwimmingLanesResponseBodyDataApps[];
   /**
+   * @remarks
+   * Full-link Grayscale Mode:
+   * 
+   * *   0: The request is routed based on the content of the request.
+   * *   1: Proportional routing
+   * 
    * @example
    * 0
    */
   canaryModel?: number;
   /**
+   * @remarks
+   * Lane status:
+   * 
+   * *   true: enabled
+   * *   false: disabled
+   * 
    * @example
    * true
    */
   enable?: boolean;
   /**
+   * @remarks
+   * Whether the traffic rule is enabled.
+   * 
    * @example
    * true
    */
   enableRules?: boolean;
   /**
+   * @remarks
+   * The ID of the lane.
+   * 
    * @example
    * 16401
    */
   laneId?: number;
   /**
+   * @remarks
+   * The name of the lane group.
+   * 
    * @example
    * test
    */
   laneName?: string;
   /**
+   * @remarks
+   * The tag of the lane.
+   * 
    * @example
    * {"alicloud.service.tag":"g1"}
    */
   laneTag?: string;
+  /**
+   * @remarks
+   * MSE gateway routing
+   */
   mseGatewayEntryRule?: ListAllSwimmingLanesResponseBodyDataMseGatewayEntryRule;
   static names(): { [key: string]: string } {
     return {
@@ -465,28 +613,65 @@ export class ListAllSwimmingLanesResponseBodyData extends $dara.Model {
 
 export class ListAllSwimmingLanesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The interface status or POP error code. Valid values:
+   * 
+   * *   **2xx**: The request was successful.
+   * *   **3xx**: Redirection.
+   * *   **4xx**: Request error.
+   * *   **5xx**: Server error.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The output parameters of the node.
+   */
   data?: ListAllSwimmingLanesResponseBodyData[];
+  /**
+   * @remarks
+   * Error code. Valid values:
+   * 
+   * *   If the request is successful, no **ErrorCode** fields are returned.
+   * *   Request failed: **ErrorCode** fields are returned. For more information, see **Error codes**.
+   */
   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
    * B4D805CA-926D-41B1-8E63-7AD0C1ED****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the data is successful. Valid values:
+   * 
+   * *   **true**: The application instances were restarted.
+   * *   **false**: Restart failed.
+   * 
    * @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/ListApplicationsForSwimmingLaneRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListApplicationsForSwimmingLaneRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the application group. You can call the [DescribeApplicationGroups](https://help.aliyun.com/document_detail/126249.html) operation to obtain the ID.
+   * 
    * @example
    * b2a8a925-477a-eswa-b823-d5e22500****
    */
   groupId?: number;
   /**
    * @remarks
+   * The ID of a namespace.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,6 +22,9 @@ export class ListApplicationsForSwimmingLaneRequest extends $dara.Model {
    */
   namespaceId?: string;
   /**
+   * @remarks
+   * The canary tag
+   * 
    * @example
    * {"alicloud.service.tag":"gray"}
    */