@alicloud/sae20190506 2.11.0 → 2.11.2

package/src/models/ListWebApplicationRevisionsBody.ts

@@ -4,10 +4,42 @@ import { ListWebApplicationRevisionsOutput } from "./ListWebApplicationRevisions
 
 
 export class ListWebApplicationRevisionsBody extends $dara.Model {
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * @example
+   * 200
+   */
   code?: number;
+  /**
+   * @remarks
+   * The response parameters.
+   */
   data?: ListWebApplicationRevisionsOutput;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * success
+   */
   message?: string;
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
+   * @example
+   * true
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebApplicationRevisionsOutput.ts

@@ -4,7 +4,18 @@ import { Revision } from "./Revision";
 
 
 export class ListWebApplicationRevisionsOutput extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.
+   * 
+   * @example
+   * A2RN
+   */
   nextToken?: string;
+  /**
+   * @remarks
+   * The versions.
+   */
   revisions?: Revision[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebApplicationsBody.ts

@@ -4,10 +4,53 @@ import { ListWebApplicationsOutput } from "./ListWebApplicationsOutput";
 
 
 export class ListWebApplicationsBody extends $dara.Model {
+  /**
+   * @remarks
+   * The HTTP status 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?: number;
+  /**
+   * @remarks
+   * The response parameters.
+   */
   data?: ListWebApplicationsOutput;
+  /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   If the request was successful, a success message is returned.
+   * *   If the request failed, an error code is returned.
+   * 
+   * @example
+   * success
+   */
   message?: string;
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**: The request was successful.
+   * *   **false**: The request failed.
+   * 
+   * @example
+   * true
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebApplicationsOutput.ts

@@ -4,7 +4,18 @@ import { WebApplicationWithInstanceCount } from "./WebApplicationWithInstanceCou
 
 
 export class ListWebApplicationsOutput extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results.
+   * 
+   * @example
+   * A2RN
+   */
   nextToken?: string;
+  /**
+   * @remarks
+   * The applications.
+   */
   webApplicationWithInstanceCount?: WebApplicationWithInstanceCount[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebCustomDomainBody.ts

@@ -4,10 +4,53 @@ import { ListWebCustomDomainOutput } from "./ListWebCustomDomainOutput";
 
 
 export class ListWebCustomDomainBody extends $dara.Model {
+  /**
+   * @remarks
+   * The HTTP status 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?: number;
+  /**
+   * @remarks
+   * The response parameters.
+   */
   data?: ListWebCustomDomainOutput;
+  /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   If the request was successful, a success message is returned.
+   * *   If the request failed, an error code is returned.
+   * 
+   * @example
+   * success
+   */
   message?: string;
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**: The request was successful.
+   * *   **false**: The request failed.
+   * 
+   * @example
+   * true
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebCustomDomainOutput.ts

@@ -4,7 +4,18 @@ import { WebCustomDomain } from "./WebCustomDomain";
 
 
 export class ListWebCustomDomainOutput extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.
+   * 
+   * @example
+   * A2RN
+   */
   nextToken?: string;
+  /**
+   * @remarks
+   * The custom domain names.
+   */
   webCustomDomains?: WebCustomDomain[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWebInstancesOutput.ts

@@ -5,8 +5,20 @@ import { WebVersionStatus } from "./WebVersionStatus";
 
 
 export class ListWebInstancesOutput extends $dara.Model {
+  /**
+   * @remarks
+   * The error message of instance creation. If the instance creation was successful, this parameter is not returned.
+   */
   currentError?: string;
+  /**
+   * @remarks
+   * The application instance.
+   */
   webInstances?: WebInstanceInfo[];
+  /**
+   * @remarks
+   * The instance status.
+   */
   webVersionStatus?: { [key: string]: WebVersionStatus };
   static names(): { [key: string]: string } {
     return {

package/src/models/MetricsCollectConfig.ts

@@ -3,13 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class MetricsCollectConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to push metric data to Simple Log Service. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
+   * @example
+   * true
+   */
   enablePushToUserSLS?: boolean;
   /**
+   * @remarks
+   * The name of the Logstore in Simple Log Service to which the metric data is pushed.
+   * 
    * @example
    * my-sls-logstorename
    */
   logstoreName?: string;
   /**
+   * @remarks
+   * The name of the project in Simple Log Service to which the metric data is pushed.
+   * 
    * @example
    * my-sls-project
    */

package/src/models/PathConfig.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PathConfig extends $dara.Model {
+  /**
+   * @remarks
+   * applicationName
+   * 
+   * @example
+   * applicationName
+   */
   applicationName?: string;
+  /**
+   * @remarks
+   * path
+   * 
+   * @example
+   * /packages
+   */
   path?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/PortProtocol.ts

@@ -0,0 +1,33 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class PortProtocol extends $dara.Model {
+  port?: number;
+  protocol?: string;
+  targetPort?: number;
+  static names(): { [key: string]: string } {
+    return {
+      port: 'Port',
+      protocol: 'Protocol',
+      targetPort: 'TargetPort',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      port: 'number',
+      protocol: 'string',
+      targetPort: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ProbeHandler.ts

@@ -5,7 +5,15 @@ import { TCPSocketAction } from "./TcpsocketAction";
 
 
 export class ProbeHandler extends $dara.Model {
+  /**
+   * @remarks
+   * The action that specifies the HTTP request to execute.
+   */
   httpGet?: HTTPGetAction;
+  /**
+   * @remarks
+   * The action that specifies the involved TCP port.
+   */
   tcpSocket?: TCPSocketAction;
   static names(): { [key: string]: string } {
     return {

package/src/models/PublishWebApplicationRevisionInput.ts

@@ -6,15 +6,34 @@ import { Container } from "./Container";
 export class PublishWebApplicationRevisionInput extends $dara.Model {
   /**
    * @remarks
+   * The container configurations of the revision version.
+   * 
    * This parameter is required.
    */
   containers?: Container[];
   /**
+   * @remarks
+   * The version description.
+   * 
    * @example
    * test version
    */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable Application Real-Time Monitoring Service (ARMS) monitoring.
+   * 
+   * @example
+   * true
+   */
   enableArmsMetrics?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to switch all traffic to a new version after the new version is released. Default value: false.
+   * 
+   * @example
+   * false
+   */
   takeEffect?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/Revision.ts

@@ -4,10 +4,42 @@ import { RevisionConfig } from "./RevisionConfig";
 
 
 export class Revision extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the revision version was created.
+   * 
+   * @example
+   * 2021-06-09T14:24:42
+   */
   createdTime?: string;
+  /**
+   * @remarks
+   * The description of the revision version.
+   * 
+   * @example
+   * test
+   */
   description?: string;
+  /**
+   * @remarks
+   * The configurations of the revision version.
+   */
   revisionConfig?: RevisionConfig;
+  /**
+   * @remarks
+   * The ID of the revision version.
+   * 
+   * @example
+   * 001
+   */
   revisionId?: string;
+  /**
+   * @remarks
+   * The traffic weight of the version.
+   * 
+   * @example
+   * 100
+   */
   weight?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/RevisionConfig.ts

@@ -7,10 +7,28 @@ import { WebNetworkConfig } from "./WebNetworkConfig";
 export class RevisionConfig extends $dara.Model {
   /**
    * @remarks
+   * The container configurations. You can deploy only one container for each application. The maximum length of this array is 1.
+   * 
    * This parameter is required.
    */
   containers?: Container[];
+  /**
+   * @remarks
+   * Specifies whether to enable Application Real-Time Monitoring Service (ARMS) monitoring. Valid values:
+   * 
+   * *   **`true`**: Enables the ARMS monitoring.
+   * *   **`false`**: Disables the ARMS monitoring.
+   * 
+   * @example
+   * true
+   */
   enableArmsMetrics?: boolean;
+  /**
+   * @remarks
+   * The network configurations.
+   * 
+   * >  This parameter is used to configure network settings for a version of the application.
+   */
   webNetworkConfig?: WebNetworkConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/RouteConfig.ts

@@ -4,6 +4,10 @@ import { PathConfig } from "./PathConfig";
 
 
 export class RouteConfig extends $dara.Model {
+  /**
+   * @remarks
+   * pathConfig
+   */
   routes?: PathConfig[];
   static names(): { [key: string]: string } {
     return {

package/src/models/SidecarContainerConfig.ts

@@ -3,15 +3,85 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SidecarContainerConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the Container Registry Enterprise Edition instance. This parameter is required if the ImageUrl parameter is set to the URL of an image in a Container Registry Enterprise Edition instance.
+   * 
+   * @example
+   * cri-xxxxxx
+   */
   acrInstanceId?: string;
+  /**
+   * @remarks
+   * The startup command of the image.
+   * 
+   * @example
+   * python
+   */
   command?: string;
+  /**
+   * @remarks
+   * The parameters of the image startup command.
+   * 
+   * @example
+   * ["a","b"]
+   */
   commandArgs?: string;
+  /**
+   * @remarks
+   * The description of the ConfigMap mounted to the application.
+   * 
+   * @example
+   * [{"configMapId":16,"key":"test","mountPath":"/tmp"}]
+   */
   configMapMountDesc?: string;
+  /**
+   * @remarks
+   * Cpu
+   * 
+   * @example
+   * 1000
+   */
   cpu?: number;
+  /**
+   * @remarks
+   * The EmptyDir description.
+   * 
+   * @example
+   * [{\\"name\\":\\"workdir\\",\\"mountPath\\":\\"/usr/local/tomcat/webapps\\"}]
+   */
   emptyDirDesc?: string;
+  /**
+   * @remarks
+   * The environment variables of the container.
+   * 
+   * @example
+   * [{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
+   */
   envs?: string;
+  /**
+   * @remarks
+   * The image address.
+   * 
+   * @example
+   * registry-vpc.cn-hangzhou.aliyuncs.com/demo/nginx:latest
+   */
   imageUrl?: string;
+  /**
+   * @remarks
+   * Memory
+   * 
+   * @example
+   * 1024
+   */
   memory?: number;
+  /**
+   * @remarks
+   * The container name.
+   * 
+   * @example
+   * name
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/SlscollectConfig.ts

@@ -3,11 +3,61 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SLSCollectConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The log path.
+   * 
+   * @example
+   * /test
+   */
   logPath?: string;
+  /**
+   * @remarks
+   * The log type. The following types of logs are supported:
+   * 
+   * *   File collection logs
+   * *   Standard output logs
+   * 
+   * @example
+   * file_log
+   */
   logType?: string;
+  /**
+   * @remarks
+   * The name of the Logstore. The name must meet the following requirements:
+   * 
+   * *   The name must be unique in a project.
+   * *   The name can contain only lowercase letters, digits, hyphens (-), and underscores (_).
+   * *   The name must start and end with a lowercase letter or a digit.
+   * *   The name must be 3 to 63 characters in length.
+   * 
+   * @example
+   * sag-shanghai
+   */
   logstoreName?: string;
+  /**
+   * @remarks
+   * The name for the Logtail configuration.
+   * 
+   * @example
+   * ******-access-log-collector
+   */
   logtailName?: string;
+  /**
+   * @remarks
+   * The name of the machine group of Simple Log Service.
+   * 
+   * @example
+   * Log Service Group
+   */
   machineGroup?: string;
+  /**
+   * @remarks
+   * The name of the SLS project.
+   * 
+   * @example
+   * test
+   */
   projectName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/SlscollectConfigs.ts

@@ -4,6 +4,10 @@ import { SLSCollectConfig } from "./SlscollectConfig";
 
 
 export class SLSCollectConfigs extends $dara.Model {
+  /**
+   * @remarks
+   * The configurations of log collection.
+   */
   collectConfigs?: SLSCollectConfig[];
   static names(): { [key: string]: string } {
     return {

package/src/models/StartupProbe.ts

@@ -4,10 +4,42 @@ import { ProbeHandler } from "./ProbeHandler";
 
 
 export class StartupProbe extends $dara.Model {
+  /**
+   * @remarks
+   * The minimum number of consecutive failures that is considered a failure after a successful probe. Default value: 3. Minimum value: 1.
+   * 
+   * @example
+   * 1
+   */
   failureThreshold?: number;
+  /**
+   * @remarks
+   * The duration after the container is started before health checks are initiated. For more information, see [Probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes).
+   * 
+   * @example
+   * 1
+   */
   initialDelaySeconds?: number;
+  /**
+   * @remarks
+   * The health check interval. Default value: 10. Unit: seconds. Minimum value: 1.
+   * 
+   * @example
+   * 1
+   */
   periodSeconds?: number;
+  /**
+   * @remarks
+   * The operation to determine the health of the container.
+   */
   probeHandler?: ProbeHandler;
+  /**
+   * @remarks
+   * The timeout period of a health check. Default value: 1. Minimum value: 1. For more information, see [Container probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes).
+   * 
+   * @example
+   * 1
+   */
   timeoutSeconds?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/TcpsocketAction.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class TCPSocketAction extends $dara.Model {
+  /**
+   * @remarks
+   * Optional. The hostname to which you want to connect. The default value is the IP address of the pod.
+   * 
+   * @example
+   * 172.16.XX.XX
+   */
   host?: string;
+  /**
+   * @remarks
+   * The port number that you want to access on the container. Valid values: 1 to 65535.
+   * 
+   * @example
+   * 80
+   */
   port?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateWebApplicationInput.ts

@@ -5,10 +5,17 @@ import { WebNetworkConfig } from "./WebNetworkConfig";
 
 export class UpdateWebApplicationInput extends $dara.Model {
   /**
+   * @remarks
+   * The application description.
+   * 
    * @example
    * sae-app
    */
   description?: string;
+  /**
+   * @remarks
+   * The network configurations of the application.
+   */
   webNetworkConfig?: WebNetworkConfig;
   static names(): { [key: string]: string } {
     return {