@alicloud/sae20190506 2.11.0 → 2.11.2

package/src/models/UpdateWebApplicationScalingConfigInput.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWebApplicationScalingConfigInput extends $dara.Model {
   /**
    * @remarks
+   * The maximum number of instances.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,7 +15,12 @@ export class UpdateWebApplicationScalingConfigInput extends $dara.Model {
   maximumInstanceCount?: number;
   /**
    * @remarks
+   * The minimum number of instances.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 1
    */
   minimumInstanceCount?: number;
   static names(): { [key: string]: string } {

package/src/models/UpdateWebApplicationTrafficConfigInput.ts

@@ -5,12 +5,30 @@ import { WebAclConfig } from "./WebAclConfig";
 
 export class UpdateWebApplicationTrafficConfigInput extends $dara.Model {
   /**
+   * @remarks
+   * The authentication type. Valid values: Anonymous (default): does not require authentication. Application: requires authentication.
+   * 
    * @example
    * Anonymous
    */
   authType?: string;
+  /**
+   * @remarks
+   * Specifies whether to disable access to the default Internet domain. If you set this parameter to true, a 403 error is returned if you access the default public URL provided by the application. A value of false does not have affect the running of the function.
+   * 
+   * @example
+   * true
+   */
   disableURLInternet?: boolean;
+  /**
+   * @remarks
+   * The traffic distribution for the application versions. The sum of traffic percentages for all versions must be equal to 1.
+   */
   revisionsTrafficWeight?: { [key: string]: number };
+  /**
+   * @remarks
+   * The configurations of the access control list (ACL) that consists of IP addresses.
+   */
   webAclConfig?: WebAclConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateWebCustomDomainInput.ts

@@ -7,15 +7,45 @@ import { WebWAFConfig } from "./WebWafconfig";
 
 
 export class UpdateWebCustomDomainInput extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the application to which data is forwarded by the domain name by default.
+   * 
+   * @example
+   * demo-app
+   */
   defaultForwardingAppName?: string;
   /**
+   * @remarks
+   * The protocol type that is supported by the custom domain name. Valid values:
+   * 
+   * *   **HTTP**: Only HTTP is supported.
+   * *   **HTTPS**: Only HTTPS is supported.
+   * *   **HTTP,HTTPS**: Both HTTP and HTTPS are supported.
+   * 
    * @example
    * HTTP
    */
   protocol?: string;
+  /**
+   * @remarks
+   * The route configuration.
+   */
   routeConfig?: RouteConfig;
+  /**
+   * @remarks
+   * The information about the HTTPS certificate.
+   */
   webCertConfig?: WebCertConfig;
+  /**
+   * @remarks
+   * The Transport Layer Security (TLS) configurations.
+   */
   webTLSConfig?: WebTLSConfig;
+  /**
+   * @remarks
+   * The Web Application Firewall (WAF) configurations.
+   */
   webWAFConfig?: WebWAFConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebAclConfig.ts

@@ -6,6 +6,8 @@ import { WebAclEntryConfig } from "./WebAclEntryConfig";
 export class WebAclConfig extends $dara.Model {
   /**
    * @remarks
+   * The IP addresses.
+   * 
    * This parameter is required.
    * 
    * **if can be null:**

package/src/models/WebAclEntryConfig.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class WebAclEntryConfig extends $dara.Model {
   /**
    * @remarks
+   * The IP address.
+   * 
+   * >  CIDR notation is not supported.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/WebApplication.ts

@@ -8,23 +8,94 @@ import { WebTrafficConfig } from "./WebTrafficConfig";
 export class WebApplication extends $dara.Model {
   /**
    * @remarks
+   * The application ID.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 0099b7be-5f5b-4512-a7fc-56049ef1****
    */
   applicationId?: string;
   /**
    * @remarks
+   * The application name.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * sae-app
    */
   applicationName?: string;
+  /**
+   * @remarks
+   * The time when the application was created.
+   * 
+   * @example
+   * 2019-07-11 15:54:49
+   */
   createdTime?: string;
+  /**
+   * @remarks
+   * The application description.
+   * 
+   * @example
+   * my sae app
+   */
   description?: string;
+  /**
+   * @remarks
+   * The public URL for accessing the application.
+   * 
+   * @example
+   * https://****.cn-hangzhou.sae.run
+   */
   internetURL?: string;
+  /**
+   * @remarks
+   * The internal URL for accessing the application.
+   * 
+   * @example
+   * https://****.cn-hangzhou-vpc.sae.run
+   */
   intranetURL?: string;
+  /**
+   * @remarks
+   * The time when the application was last modified.
+   * 
+   * @example
+   * 2019-07-11 20:12:58
+   */
   lastModifiedTime?: string;
+  /**
+   * @remarks
+   * The ID of the namespace to which the application belongs.
+   * 
+   * @example
+   * cn-beijing:test
+   */
   namespaceId?: string;
+  /**
+   * @remarks
+   * The configurations of the revision version.
+   */
   revisionConfig?: RevisionConfig;
+  /**
+   * @remarks
+   * The Virtual Private Cloud (VPC) ID of the application namespace.
+   * 
+   * @example
+   * vpc-2ze0i263cnn311nvj****
+   */
   vpcId?: string;
+  /**
+   * @remarks
+   * The scaling configurations of the application.
+   */
   webScalingConfig?: WebScalingConfig;
+  /**
+   * @remarks
+   * The traffic configurations of the application.
+   */
   webTrafficConfig?: WebTrafficConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebApplicationBody.ts

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

package/src/models/WebApplicationInstanceLogsBody.ts

@@ -4,10 +4,53 @@ import { DescribeInstanceLogsOutput } from "./DescribeInstanceLogsOutput";
 
 
 export class WebApplicationInstanceLogsBody 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?: DescribeInstanceLogsOutput;
+  /**
+   * @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/WebApplicationResourceStaticsBody.ts

@@ -4,10 +4,53 @@ import { DescribeWebAppStaticsOutput } from "./DescribeWebAppStaticsOutput";
 
 
 export class WebApplicationResourceStaticsBody 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 data returned for the operation.
+   */
   data?: DescribeWebAppStaticsOutput;
+  /**
+   * @remarks
+   * The message returned for the operation. Valid values:
+   * 
+   * *   success is returned when the request succeeds.
+   * *   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
+   * Indicates whether the call 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/WebApplicationRevisionBody.ts

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

package/src/models/WebApplicationScalingConfigBody.ts

@@ -4,10 +4,53 @@ import { WebScalingConfig } from "./WebScalingConfig";
 
 
 export class WebApplicationScalingConfigBody 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?: WebScalingConfig;
+  /**
+   * @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/WebApplicationStatus.ts

@@ -4,7 +4,18 @@ import { WebScalingConfig } from "./WebScalingConfig";
 
 
 export class WebApplicationStatus extends $dara.Model {
+  /**
+   * @remarks
+   * The number of application instances.
+   * 
+   * @example
+   * 3
+   */
   instanceCount?: number;
+  /**
+   * @remarks
+   * The scaling configurations of the application.
+   */
   webScalingConfig?: WebScalingConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebApplicationTrafficConfigBody.ts

@@ -4,10 +4,53 @@ import { WebTrafficConfig } from "./WebTrafficConfig";
 
 
 export class WebApplicationTrafficConfigBody 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?: WebTrafficConfig;
+  /**
+   * @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/WebApplicationWithInstanceCount.ts

@@ -4,7 +4,18 @@ import { WebApplication } from "./WebApplication";
 
 
 export class WebApplicationWithInstanceCount extends $dara.Model {
+  /**
+   * @remarks
+   * The number of application instances.
+   * 
+   * @example
+   * 1
+   */
   instanceCount?: number;
+  /**
+   * @remarks
+   * The application information.
+   */
   webApplication?: WebApplication;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebApplicationWithStatus.ts

@@ -5,7 +5,15 @@ import { WebApplication } from "./WebApplication";
 
 
 export class WebApplicationWithStatus extends $dara.Model {
+  /**
+   * @remarks
+   * The status of the application.
+   */
   status?: WebApplicationStatus;
+  /**
+   * @remarks
+   * The details of the application.
+   */
   webApplication?: WebApplication;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebCertConfig.ts

@@ -3,8 +3,32 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class WebCertConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The certificate name.
+   * 
+   * @example
+   * sae-certname
+   */
   certName?: string;
+  /**
+   * @remarks
+   * The public key of the certificate.
+   * 
+   * @example
+   * -----BEGIN CERTIFICATE-----
+   *  …… 
+   * -----END CERTIFICATE-----
+   */
   certificate?: string;
+  /**
+   * @remarks
+   * The private key of the certificate.
+   * 
+   * @example
+   * -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEA5SIfpNCBoiDrZhX1H39CHwQMVD0kBNeBTWfP9xkeesvfzbOz ******* POVNFfDf9h7pJtQ5fRZNTYTDs/d+cH62Z3+nS74mNnEfff0nkvne 
+   * -----END RSA PRIVATE KEY-----
+   */
   privateKey?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/WebCustomDomain.ts

@@ -8,36 +8,77 @@ import { WebWAFConfig } from "./WebWafconfig";
 
 export class WebCustomDomain extends $dara.Model {
   /**
+   * @remarks
+   * The time when the custom domain name was created.
+   * 
    * @example
    * 2023-03-30T08:02:19Z
    */
   createdTime?: string;
   /**
+   * @remarks
+   * The name of the application that is forwarded by the domain name by default.
+   * 
    * @example
    * appxxxxx
    */
   defaultForwardingAppName?: string;
   /**
+   * @remarks
+   * The domain name.
+   * 
    * @example
    * example.com
    */
   domainName?: string;
   /**
+   * @remarks
+   * The time when the custom domain name was last updated.
+   * 
    * @example
    * 2023-03-30T08:02:19Z
    */
   lastModifiedTime?: string;
+  /**
+   * @remarks
+   * The ID of the namespace to which the domain name belongs.
+   * 
+   * @example
+   * cn-chengdu
+   */
   namespaceId?: string;
   /**
+   * @remarks
+   * The protocol type that is supported by the custom domain name. HTTP: Only HTTP is supported. HTTPS: Only HTTPS is supported. HTTP, HTTPS: Both HTTP and HTTPS are supported.
+   * 
    * @example
    * HTTP
    */
   protocol?: string;
+  /**
+   * @remarks
+   * The route configurations.
+   */
   routeConfig?: RouteConfig;
+  /**
+   * @remarks
+   * The information about the HTTPS certificate.
+   */
   webCertConfig?: WebCertConfig;
+  /**
+   * @remarks
+   * The Transport Layer Security (TLS) configurations.
+   */
   webTLSConfig?: WebTLSConfig;
+  /**
+   * @remarks
+   * The WAF configurations.
+   */
   webWAFConfig?: WebWAFConfig;
   /**
+   * @remarks
+   * The ID of your Alibaba Cloud account
+   * 
    * @example
    * 123xxxxxx
    */