@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeHybridCloudResourceDetailResponseBody.ts

@@ -4,58 +4,147 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeHybridCloudResourceDetailResponseBodyDomainListen extends $dara.Model {
   /**
+   * @remarks
+   * The certificate ID.
+   * 
    * @example
    * 19312542-cn-hangzhou
    */
   certId?: string;
   /**
+   * @remarks
+   * The type of cipher suite. Valid values:
+   * 
+   * - **1**: all cipher suites.
+   * 
+   * - **2**: strong cipher suites.
+   * 
+   * - **99**: custom cipher suites.
+   * 
    * @example
    * 0
    */
   cipherSuite?: number;
+  /**
+   * @remarks
+   * The custom cipher suites.
+   */
   customCiphers?: string[];
   /**
+   * @remarks
+   * Indicates whether TLS 1.3 is supported. Valid values:
+   * 
+   * - **true**: TLS 1.3 is supported.
+   * 
+   * - **false**: TLS 1.3 is not supported.
+   * 
    * @example
    * true
    */
   enableTLSv3?: boolean;
   /**
+   * @remarks
+   * Indicates whether an exclusive IP address is supported. Valid values:
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
+   * 
    * @example
    * true
    */
   exclusiveIp?: boolean;
   /**
+   * @remarks
+   * Indicates whether HTTPS forced redirect is enabled. Valid values:
+   * 
+   * - **true**: HTTPS forced redirect is enabled.
+   * 
+   * - **false**: HTTPS forced redirect is disabled.
+   * 
    * @example
    * true
    */
   focusHttps?: boolean;
   /**
+   * @remarks
+   * Indicates whether HTTP/2 is enabled. Valid values:
+   * 
+   * - **true**: HTTP/2 is enabled.
+   * 
+   * - **false**: HTTP/2 is disabled.
+   * 
    * @example
    * true
    */
   http2Enabled?: boolean;
+  /**
+   * @remarks
+   * The list of available ports for the HTTP protocol. The value is a string. When multiple ports are available, they are returned in the format of **port1,port2,port3**.
+   */
   httpPorts?: number[];
+  /**
+   * @remarks
+   * The ports for the HTTPS protocol.
+   */
   httpsPorts?: number[];
   /**
+   * @remarks
+   * Indicates whether IPv6 is enabled. Valid values:
+   * 
+   * - **true**: IPv6 is enabled.
+   * 
+   * - **false**: IPv6 is disabled.
+   * 
    * @example
    * true
    */
   IPv6Enabled?: boolean;
   /**
+   * @remarks
+   * The type of protection resource to use. Valid values:
+   * 
+   * - **share**: shared cluster.
+   * 
+   * - **gslb**: shared cluster with intelligent load balancing.
+   * 
    * @example
    * share
    */
   protectionResource?: string;
   /**
+   * @remarks
+   * The TLS version. Valid values:
+   * 
+   * - **tlsv1**
+   * 
+   * - **tlsv1.1**
+   * 
+   * - **tlsv1.2**
+   * 
    * @example
    * tlsv1
    */
   TLSVersion?: string;
   /**
+   * @remarks
+   * The method that WAF uses to obtain the actual client IP address. Valid values:
+   * 
+   * - **0**: No Layer 7 proxy is deployed in front of WAF.
+   * 
+   * - **1**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the client IP address.
+   * 
+   * - **2**: WAF reads the value of a custom header field that you specify as the client IP address.
+   * 
    * @example
    * 1
    */
   xffHeaderMode?: number;
+  /**
+   * @remarks
+   * The custom header fields used to obtain the client IP address, in the format of [**"header1","header2",……**].
+   * 
+   * > This parameter is required only when **XffHeaderMode** is set to 2, which indicates that WAF reads the value of a custom header field that you specify in the request header as the client IP address.
+   */
   xffHeaders?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -117,8 +206,32 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomainListen extends $
 }
 
 export class DescribeHybridCloudResourceDetailResponseBodyDomainRedirectBackendPorts extends $dara.Model {
+  /**
+   * @remarks
+   * The back-to-origin port.
+   * 
+   * @example
+   * 80
+   */
   backendPort?: number;
+  /**
+   * @remarks
+   * The listening port.
+   * 
+   * @example
+   * 80
+   */
   listenPort?: number;
+  /**
+   * @remarks
+   * The protocol type of the listening port. Valid values:
+   * 
+   * - http: HTTP protocol.
+   * - https: HTTPS protocol.
+   * 
+   * @example
+   * http
+   */
   protocol?: string;
   static names(): { [key: string]: string } {
     return {
@@ -147,11 +260,17 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomainRedirectBackendP
 
 export class DescribeHybridCloudResourceDetailResponseBodyDomainRedirectRequestHeaders extends $dara.Model {
   /**
+   * @remarks
+   * The key of the tag.
+   * 
    * @example
    * L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z
    */
   key?: string;
   /**
+   * @remarks
+   * The value.
+   * 
    * @example
    * 9506360478730
    */
@@ -180,71 +299,163 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomainRedirectRequestH
 }
 
 export class DescribeHybridCloudResourceDetailResponseBodyDomainRedirect extends $dara.Model {
+  /**
+   * @remarks
+   * The custom port configuration. By default, this is the same as the listening port.
+   */
   backendPorts?: DescribeHybridCloudResourceDetailResponseBodyDomainRedirectBackendPorts[];
+  /**
+   * @remarks
+   * The IP address of the origin server or the domain name used for back-to-origin.
+   */
   backends?: string[];
   /**
+   * @remarks
+   * Specifies whether to enable public cloud disaster recovery. Valid values:
+   * 
+   * - **true**: Public cloud disaster recovery is enabled.
+   * 
+   * - **false**: Public cloud disaster recovery is disabled.
+   * 
    * @example
    * true
    */
   cnameEnabled?: boolean;
   /**
+   * @remarks
+   * The connection timeout period. Unit: milliseconds.
+   * 
    * @example
    * 1
    */
   connectTimeout?: number;
   /**
+   * @remarks
+   * Indicates whether forced HTTP back-to-origin is enabled. Valid values:
+   * 
+   * - **true**: Forced HTTP back-to-origin is enabled.
+   * 
+   * - **false**: Forced HTTP back-to-origin is disabled.
+   * 
    * @example
    * true
    */
   focusHttpBackend?: boolean;
   /**
+   * @remarks
+   * Indicates whether persistent connections are enabled. Valid values:
+   * 
+   * - **true** (default): Persistent connections are enabled.
+   * 
+   * - **false**: Persistent connections are disabled.
+   * 
    * @example
    * true
    */
   keepalive?: boolean;
   /**
+   * @remarks
+   * The number of requests that reuse persistent connections. Valid values: 60 to 1000.
+   * 
+   * > This specifies how many persistent connections are reused after persistent connections are enabled.
+   * 
    * @example
    * 1000
    */
   keepaliveRequests?: number;
   /**
+   * @remarks
+   * The idle timeout period of persistent connections.
+   * 
    * @example
    * 1
    */
   keepaliveTimeout?: number;
   /**
+   * @remarks
+   * The load balancing algorithm used for back-to-origin. Valid values:
+   * 
+   * - **iphash**: IP hash algorithm.
+   * 
+   * - **roundRobin**: round-robin algorithm.
+   * 
+   * - **leastTime**: least-time back-to-origin algorithm.
+   * 
    * @example
    * iphash
    */
   loadbalance?: string;
+  /**
+   * @remarks
+   * Indicates whether the client source IP preservation feature is enabled.
+   * 
+   * - true: The client source IP preservation feature is enabled. After this feature is enabled, the backend service can view the originating IP address of the client.
+   * - false: The client source IP preservation feature is disabled.
+   * 
+   * @example
+   * false
+   */
   proxyProtocol?: boolean;
   /**
+   * @remarks
+   * The read timeout period of the request.
+   * 
    * @example
    * 1
    */
   readTimeout?: number;
+  /**
+   * @remarks
+   * The HTTP request headers.
+   */
   requestHeaders?: DescribeHybridCloudResourceDetailResponseBodyDomainRedirectRequestHeaders[];
   /**
+   * @remarks
+   * Indicates whether WAF retries when back-to-origin fails. Valid values:
+   * 
+   * - **true**: WAF retries.
+   * 
+   * - **false**: WAF does not retry.
+   * 
    * @example
    * true
    */
   retry?: boolean;
   /**
+   * @remarks
+   * The hybrid cloud forwarding rules, expressed as a string converted from a JSON array. Each element in the JSON array is a structure that contains the following field:
+   * - **rs**: Array type.
+   * 
    * @example
    * [{\\"backupRs\\":[],\\"location\\":\\"v3-test\\",\\"locationId\\":1148,\\"rs\\":[\\"39.98.217.197\\",\\"2.2.2.2\\"]}]
    */
   routingRules?: string;
   /**
+   * @remarks
+   * Indicates whether back-to-origin Server Name Indication (SNI) is enabled. Valid values:
+   * 
+   * - **true**: Back-to-origin SNI is enabled.
+   * 
+   * - **false**: Back-to-origin SNI is disabled.
+   * 
    * @example
    * true
    */
   sniEnabled?: boolean;
   /**
+   * @remarks
+   * The custom value of the SNI extension field. If the value is empty, the SNI value is not customized, and the value of the **Host** field in the request header is used as the value of the SNI extension field by default.
+   * 
+   * > This parameter is returned only when **SniStatus** is set to **1**, which indicates that back-to-origin SNI is enabled.
+   * 
    * @example
    * eew111
    */
   sniHost?: string;
   /**
+   * @remarks
+   * The write timeout period. Unit: milliseconds.
+   * 
    * @example
    * 1
    */
@@ -321,6 +532,9 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomain extends $dara.M
    */
   cname?: string;
   /**
+   * @remarks
+   * The domain name.
+   * 
    * @example
    * www.*****.com
    */
@@ -333,19 +547,36 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomain extends $dara.M
    * 31323
    */
   id?: number;
+  /**
+   * @remarks
+   * The listening information.
+   */
   listen?: DescribeHybridCloudResourceDetailResponseBodyDomainListen;
+  /**
+   * @remarks
+   * The rules for returning response header values.
+   */
   redirect?: DescribeHybridCloudResourceDetailResponseBodyDomainRedirect;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-***aby
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The resource status.
+   * 
    * @example
    * 1
    */
   status?: number;
   /**
+   * @remarks
+   * The user ID.
+   * 
    * @example
    * 1046011128270720
    */
@@ -392,8 +623,15 @@ export class DescribeHybridCloudResourceDetailResponseBodyDomain extends $dara.M
 }
 
 export class DescribeHybridCloudResourceDetailResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The domain name information.
+   */
   domain?: DescribeHybridCloudResourceDetailResponseBodyDomain;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-3014697B11AE
    */

package/src/models/DescribeHybridCloudResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The back-to-origin IP address or domain name.
+   * The IP address or domain name of the origin server that corresponds to the domain name.
    * 
    * @example
    * 1.1.XX.XX
@@ -13,10 +13,11 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   backend?: string;
   /**
    * @remarks
-   * Specifies whether the public cloud disaster recovery feature is enabled for the domain name. Valid values:
+   * Specifies whether to enable public cloud disaster recovery. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: Enabled.
+   * 
+   * - **false**: Disabled.
    * 
    * @example
    * true
@@ -24,7 +25,7 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   cnameEnabled?: boolean;
   /**
    * @remarks
-   * The domain name that you want to query.
+   * The domain name to query.
    * 
    * @example
    * www.aliyundoc.com
@@ -33,8 +34,7 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   /**
    * @remarks
    * The ID of the WAF instance.
-   * 
-   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -44,7 +44,7 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return when paging is used. Default value: **1**, which indicates the first page.
    * 
    * @example
    * 1
@@ -52,7 +52,7 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries per page when paging is used. Default value: **10**, which indicates 10 entries per page.
    * 
    * @example
    * 10
@@ -60,10 +60,11 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * The region where the WAF instance resides. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -71,7 +72,7 @@ export class DescribeHybridCloudResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfmvtc5z52****