@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/ModifyCloudResourceRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCloudResourceRequestListenCertificates extends $dara.Model {
   /**
    * @remarks
-   * The type of the certificate. Valid values:
+   * The type of certificate for HTTPS. Valid values:
    * 
-   * *   **default**: default certificate.
-   * *   **extension**: additional certificate.
+   * - **default**: default certificate.
+   * 
+   * - **extension**: extended certificate.
    * 
    * @example
    * default
@@ -16,7 +17,7 @@ export class ModifyCloudResourceRequestListenCertificates extends $dara.Model {
   appliedType?: string;
   /**
    * @remarks
-   * The ID of the certificate.
+   * The certificate ID.
    * 
    * @example
    * 123-cn-hangzhou
@@ -48,16 +49,18 @@ export class ModifyCloudResourceRequestListenCertificates extends $dara.Model {
 export class ModifyCloudResourceRequestListen extends $dara.Model {
   /**
    * @remarks
-   * The certificates.
+   * The certificate information.
    */
   certificates?: ModifyCloudResourceRequestListenCertificates[];
   /**
    * @remarks
-   * The type of the cipher suites that you want to add. This parameter is available only if you specify **HttpsPorts**. Valid values:
+   * The type of cipher suite to add. This parameter is used only when **HttpsPorts** is not empty, which indicates that the domain name uses HTTPS. Valid values:
+   * 
+   * - **1**: all cipher suites.
+   * 
+   * - **2**: strong cipher suites. This value is available only when **TLSVersion** is set to **tlsv1.2**.
    * 
-   * *   **1**: all cipher suites.
-   * *   **2**: strong cipher suites. This value is available only if you set **TLSVersion** to **tlsv1.2**.
-   * *   **99**: custom cipher suites.
+   * - **99**: custom cipher suites.
    * 
    * @example
    * 1
@@ -65,15 +68,16 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   cipherSuite?: number;
   /**
    * @remarks
-   * The custom cipher suites that you want to add.
+   * The custom cipher suites.
    */
   customCiphers?: string[];
   /**
    * @remarks
-   * Specifies whether to support TLS 1.3. This parameter is available only if you specify **HttpsPorts**. Valid values:
+   * Specifies whether TLS 1.3 is supported. This parameter is used only when **HttpsPorts** is not empty, which indicates that the domain name uses HTTPS. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: TLS 1.3 is supported.
+   * 
+   * - **false**: TLS 1.3 is not supported.
    * 
    * @example
    * true
@@ -84,10 +88,11 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   enableTLSv3?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable HTTP/2. This parameter is available only if you specify **HttpsPorts**. Valid values:
+   * Specifies whether to enable HTTP/2. This parameter is used only when **HttpsPorts** is not empty, which indicates that the domain name uses HTTPS. Valid values:
+   * 
+   * - **true**: HTTP/2 is enabled.
    * 
-   * *   **true**
-   * *   **false** (default)
+   * - **false** (default): HTTP/2 is not enabled.
    * 
    * @example
    * true
@@ -95,7 +100,7 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   http2Enabled?: boolean;
   /**
    * @remarks
-   * The port of the cloud service instance that is added to WAF.
+   * The port of the cloud service connected to WAF.
    * 
    * @example
    * 80
@@ -106,9 +111,8 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   /**
    * @remarks
    * The protocol type. Valid values:
-   * 
-   * *   **http**
-   * *   **https**
+   * - **http**: HTTP.
+   * - **https**: HTTPS.
    * 
    * This parameter is required.
    * 
@@ -118,7 +122,7 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The ID of the cloud service instance that is added to WAF.
+   * The instance ID of the resource.
    * 
    * @example
    * lb-***
@@ -128,12 +132,14 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   resourceInstanceId?: string;
   /**
    * @remarks
-   * The type of the cloud service. Valid values:
+   * The type of cloud service. Valid values:
    * 
-   * *   **clb4**: Layer 4 Classic Load Balancer (CLB).
-   * *   **clb7**: Layer 7 CLB.
-   * *   **ecs**: Elastic Compute Service (ECS).
-   * *   **nlb**: Network Load Balancer (NLB).
+   * - **clb4**: Layer 4 Classic Load Balancer (CLB).
+   * 
+   * - **clb7**: Layer 7 CLB.
+   * 
+   * - **ecs**: Elastic Compute Service (ECS).
+   * - **nlb**: Network Load Balancer (NLB).
    * 
    * @example
    * clb7
@@ -143,11 +149,13 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
   resourceProduct?: string;
   /**
    * @remarks
-   * The Transport Layer Security (TLS) version that you want to add. This parameter is available only if you specify **HttpsPorts**. Valid values:
+   * The TLS version to add. This parameter is used only when **HttpsPorts** is not empty, which indicates that the domain name uses HTTPS. Valid values:
+   * 
+   * - **tlsv1**
    * 
-   * *   **tlsv1**
-   * *   **tlsv1.1**
-   * *   **tlsv1.2**
+   * - **tlsv1.1**
+   * 
+   * - **tlsv1.2**
    * 
    * @example
    * tlsv1.2
@@ -201,7 +209,7 @@ export class ModifyCloudResourceRequestListen extends $dara.Model {
 export class ModifyCloudResourceRequestRedirectRequestHeaders extends $dara.Model {
   /**
    * @remarks
-   * The key of the custom header field.
+   * The custom request header field.
    * 
    * @example
    * key1
@@ -209,7 +217,7 @@ export class ModifyCloudResourceRequestRedirectRequestHeaders extends $dara.Mode
   key?: string;
   /**
    * @remarks
-   * The value of the custom header field.
+   * The value of the custom request header field.
    * 
    * @example
    * value1
@@ -241,10 +249,11 @@ export class ModifyCloudResourceRequestRedirectRequestHeaders extends $dara.Mode
 export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable the persistent connection feature. Valid values:
+   * Specifies whether to enable persistent connections. Valid values:
+   * 
+   * - **true** (default): Persistent connections are enabled.
    * 
-   * *   **true** (default)
-   * *   **false**
+   * - **false**: Persistent connections are not enabled.
    * 
    * @example
    * true
@@ -252,9 +261,9 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   keepalive?: boolean;
   /**
    * @remarks
-   * The number of reused persistent connections. Valid values: 60 to 1000.
+   * The number of requests that can reuse a persistent connection. Valid values: 60 to 1000.
    * 
-   * >  This parameter specifies the number of persistent connections that can be reused after you enable the persistent connection feature.
+   * > After persistent connections are enabled, this parameter specifies how many requests can reuse a persistent connection.
    * 
    * @example
    * 1000
@@ -262,22 +271,26 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   keepaliveRequests?: number;
   /**
    * @remarks
-   * The timeout period of idle persistent connections. Valid values: 10 to 3600. Default value: 3600. Unit: seconds.
+   * The idle timeout period of a persistent connection. Valid values: 10 to 3600. Default value: 3600. Unit: seconds.
    * 
-   * >  This parameter specifies the period of time after which an idle persistent connection is closed.
+   * > Specifies how long an idle persistent connection can remain open before it is released.
    * 
    * @example
    * 15
    */
   keepaliveTimeout?: number;
   /**
+   * @remarks
+   * The maximum request body size. Valid values: 2 to 10. Default value: 2. Unit: GB.
+   * 
    * @example
-   * 5
+   * 2
    */
   maxBodySize?: number;
   /**
    * @remarks
-   * The timeout period of read connections. Unit: seconds. Valid values: 1 to 3600.
+   * The read timeout period. Unit: seconds.
+   * Valid values: 1 to 3600.
    * 
    * @example
    * 1
@@ -285,12 +298,13 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   readTimeout?: number;
   /**
    * @remarks
-   * The custom header fields, which are key-value pairs. The fields are used to mark requests that pass through WAF.
+   * The traffic mark fields and values of the domain name, which are used to mark traffic processed by WAF.
    */
   requestHeaders?: ModifyCloudResourceRequestRedirectRequestHeaders[];
   /**
    * @remarks
-   * The timeout period of write connections. Unit: seconds. Valid values: 1 to 3600.
+   * The write timeout period. Unit: seconds.
+   * Valid values: 1 to 3600.
    * 
    * @example
    * 1
@@ -298,11 +312,13 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   writeTimeout?: number;
   /**
    * @remarks
-   * The method that is used to obtain the originating IP address of a client. Valid values:
+   * The method that WAF uses to obtain the originating IP address of the client. 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.
    * 
-   * *   **0**: No Layer 7 proxies are deployed in front of WAF.
-   * *   **1**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the originating IP address of the client.
-   * *   **2**: WAF reads the value of a custom header field as the originating IP address of the client.
+   * - **2**: WAF reads the value of a custom header field that you specify as the client IP address.
    * 
    * @example
    * 0
@@ -310,17 +326,18 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
   xffHeaderMode?: number;
   /**
    * @remarks
-   * The custom header fields that are used to obtain the originating IP address of a client. Specify the value in the ["header1","header2",...] format.
+   * The list of custom header fields used to obtain the client IP address, in the format of **["header1","header2",...]**.
    * 
-   * >  This parameter is required only if you set **XffHeaderMode** to 2.
+   * > This parameter is required only when **XffHeaderMode** is set to 2, which indicates that WAF reads the value of a custom header field as the client IP address.
    */
   xffHeaders?: string[];
   /**
    * @remarks
-   * Specifies whether to use the X-Forward-For-Proto header field to pass the protocol used by WAF to forward requests to the origin server. Valid values:
+   * Specifies whether to use X-Forward-For-Proto to pass the protocol used by WAF. Valid values:
    * 
-   * *   **true** (default)
-   * *   **false**
+   * - **true** (default): The protocol used by WAF is passed.
+   * 
+   * - **false**: The protocol used by WAF is not passed.
    * 
    * @example
    * true
@@ -372,12 +389,21 @@ export class ModifyCloudResourceRequestRedirect extends $dara.Model {
 }
 
 export class ModifyCloudResourceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the connected resource, which is automatically generated by WAF when the resource is connected in cloud native mode.
+   * 
+   * > You can call [CreateCloudResource](https://help.aliyun.com/document_detail/2839876.html) to connect a resource and view the resource ID in the response.
+   * 
+   * @example
+   * lb-***-80-clb7
+   */
   cloudResourceId?: string;
   /**
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -387,22 +413,23 @@ export class ModifyCloudResourceRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The listener configurations.
+   * The listening configuration.
    * 
    * This parameter is required.
    */
   listen?: ModifyCloudResourceRequestListen;
   /**
    * @remarks
-   * The forwarding configurations.
+   * The forwarding configuration.
    */
   redirect?: ModifyCloudResourceRequestRedirect;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. 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.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyCloudResourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCloudResourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the resource that is added to WAF.
+   * The ID of the connected resource.
    * 
    * @example
    * lb-xxx-80-clb7
@@ -13,7 +13,7 @@ export class ModifyCloudResourceResponseBody extends $dara.Model {
   cloudResource?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-***

package/src/models/ModifyCloudResourceShrinkRequest.ts

@@ -3,12 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyCloudResourceShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the connected resource, which is automatically generated by WAF when the resource is connected in cloud native mode.
+   * 
+   * > You can call [CreateCloudResource](https://help.aliyun.com/document_detail/2839876.html) to connect a resource and view the resource ID in the response.
+   * 
+   * @example
+   * lb-***-80-clb7
+   */
   cloudResourceId?: string;
   /**
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -18,22 +27,23 @@ export class ModifyCloudResourceShrinkRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The listener configurations.
+   * The listening configuration.
    * 
    * This parameter is required.
    */
   listenShrink?: string;
   /**
    * @remarks
-   * The forwarding configurations.
+   * The forwarding configuration.
    */
   redirectShrink?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. 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.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDefaultHttpsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefaultHttpsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the certificate.
+   * The certificate ID.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,13 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
   certId?: string;
   /**
    * @remarks
-   * The type of the cipher suites. Valid values:
+   * The type of the cipher suite. Valid values:
    * 
-   * *   **1**: all cipher suites.
-   * *   **2**: strong cipher suites.
-   * *   **99**: custom cipher suites.
+   * - **1**: adds all cipher suites.
+   * 
+   * - **2**: adds strong cipher suites.
+   * 
+   * - **99**: adds custom cipher suites.
    * 
    * @example
    * 0
@@ -27,15 +29,16 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
   cipherSuite?: number;
   /**
    * @remarks
-   * The custom cipher suites that you want to add. This parameter is available only if you set **CipherSuite** to **99**.
+   * The custom cipher suites that you want to add. This parameter is used only when **CipherSuite** is set to **99**.
    */
   customCiphers?: string[];
   /**
    * @remarks
    * Specifies whether to support TLS 1.3. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: supports TLS 1.3.
+   * 
+   * - **false**: does not support TLS 1.3.
    * 
    * @example
    * true
@@ -43,9 +46,9 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
   enableTLSv3?: boolean;
   /**
    * @remarks
-   * The ID of the Web Application Firewall (WAF) instance.
+   * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to view the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -57,8 +60,9 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
    * @remarks
    * The region in which the WAF instance is deployed. Valid values:
    * 
-   * *   **cn-hangzhou**: the Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -66,7 +70,7 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * 阿里云资源组ID。
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -76,9 +80,11 @@ export class ModifyDefaultHttpsRequest extends $dara.Model {
    * @remarks
    * The version of the TLS protocol. Valid values:
    * 
-   * *   **tlsv1**
-   * *   **tlsv1.1**
-   * *   **tlsv1.2**
+   * - **tlsv1**
+   * 
+   * - **tlsv1.1**
+   * 
+   * - **tlsv1.2**
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDefaultHttpsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefaultHttpsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The request ID, which is used to locate and troubleshoot issues.
    * 
    * @example
    * 276D7566-31C9-4192-9DD1-***

package/src/models/ModifyDefenseResourceGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * The protected objects that you want to add to the protected object group. Separate the protected objects with commas (,). If you leave this parameter empty, no protected objects are added to the protected object group.
+   * The protected objects to add to the protected object group. Separate multiple protected objects with commas (,). If this parameter is empty, no protected objects are added to the protected object group.
    * 
    * @example
    * test1.aliyundoc.com,test2.aliyundoc.com
@@ -13,7 +13,7 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   addList?: string;
   /**
    * @remarks
-   * The protected objects that you want to remove from the protected object group. Separate the protected objects with commas (,). If you leave this parameter empty, no protected objects are removed from the protected object group.
+   * The protected objects to remove from the protected object group. Separate multiple protected objects with commas (,). If this parameter is empty, no protected objects are removed from the protected object group.
    * 
    * @example
    * test14.waf.com,test24.waf.com
@@ -21,7 +21,7 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   deleteList?: string;
   /**
    * @remarks
-   * The description of the protected object group.
+   * The description of the protected object group. The description can be up to 512 characters long.
    * 
    * @example
    * test
@@ -29,7 +29,7 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The name of the protected object group whose configurations you want to modify.
+   * The name of the protected object group to modify.
    * 
    * This parameter is required.
    * 
@@ -41,7 +41,7 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -51,10 +51,11 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region where the WAF instance is located. Valid values:
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -62,7 +63,7 @@ export class ModifyDefenseResourceGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/ModifyDefenseResourceGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseResourceGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 2CC1AFDE-BB31-5A2F-906E-92FCBDDE6B75