@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/CreateDomainResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDomainResponseBodyDomainInfo extends $dara.Model {
   /**
    * @remarks
-   * The CNAME that is assigned by WAF to the domain name.
+   * The CNAME assigned by WAF to the domain name.
    * 
    * @example
    * xxxxxwww.****.com
@@ -13,7 +13,7 @@ export class CreateDomainResponseBodyDomainInfo extends $dara.Model {
   cname?: string;
   /**
    * @remarks
-   * The domain name that you added to WAF.
+   * The domain name that is onboarded to WAF.
    * 
    * @example
    * www.aliyundoc.com
@@ -21,7 +21,7 @@ export class CreateDomainResponseBodyDomainInfo extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The name of the protected object that is generated.
+   * The ID of the domain name.
    * 
    * @example
    * www.aliyundoc.com-waf
@@ -55,15 +55,15 @@ export class CreateDomainResponseBodyDomainInfo extends $dara.Model {
 export class CreateDomainResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the domain name that is added.
+   * The details of the added domain name.
    */
   domainInfo?: CreateDomainResponseBodyDomainInfo;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
-   * D7861F61-5B61-46CE-A47C-6B19160D****
+   * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateDomainShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDomainShrinkRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of the tag.
+   * The tag key.
    * 
    * @example
    * Tagkey1
@@ -13,7 +13,7 @@ export class CreateDomainShrinkRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of the tag.
+   * The tag value.
    * 
    * @example
    * TagValue1
@@ -45,10 +45,11 @@ export class CreateDomainShrinkRequestTag extends $dara.Model {
 export class CreateDomainShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The mode in which you want to add the domain name to WAF. Valid values:
+   * The access type of the WAF instance. Valid values:
    * 
-   * *   **share:** adds the domain name to WAF in CNAME record mode. This is the default value.
-   * *   **hybrid_cloud_cname:** adds the domain name to WAF in hybrid cloud reverse proxy mode.
+   * - **share** (default): onboarding by using a CNAME record.
+   * 
+   * - **hybrid_cloud_cname**: onboarding by using a hybrid cloud CNAME record.
    * 
    * @example
    * share
@@ -56,7 +57,7 @@ export class CreateDomainShrinkRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The domain name that you want to add to WAF.
+   * The domain name that you want to add.
    * 
    * This parameter is required.
    * 
@@ -66,9 +67,9 @@ export class CreateDomainShrinkRequest extends $dara.Model {
   domain?: string;
   /**
    * @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 obtain the ID of the WAF instance.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -78,7 +79,7 @@ export class CreateDomainShrinkRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The listener configurations.
+   * The listening configurations.
    * 
    * This parameter is required.
    */
@@ -94,8 +95,9 @@ export class CreateDomainShrinkRequest extends $dara.Model {
    * @remarks
    * The region where the WAF instance resides. 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.
    * 
    * This parameter is required.
    * 
@@ -105,7 +107,7 @@ export class CreateDomainShrinkRequest 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/CreateHybridCloudClusterRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHybridCloudClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * The network access mode. Valid values:
+   * The network access mode of the cluster. Valid values:
    * 
-   * *   **internet**: Internet access.
-   * *   **vpc**: internal network access by using Express Connect circuits.
+   * - **internet**: access over the Internet.
+   * 
+   * - **vpc**: access over an Express Connect circuit.
    * 
    * This parameter is required.
    * 
@@ -18,11 +19,13 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   accessMode?: string;
   /**
    * @remarks
-   * The region where the virtual private cloud (VPC) resides. Valid values:
+   * The region for Express Connect circuit access. Valid values:
+   * 
+   * - **cn-hangzhou**: Hangzhou.
+   * 
+   * - **cn-beijing**: Beijing.
    * 
-   * *   **cn-hangzhou**: China (Hangzhou).
-   * *   **cn-beiijng**: China (Beijing).
-   * *   **cn-shanghai**: China (Shanghai).
+   * - **cn-shanghai**: Shanghai.
    * 
    * @example
    * cn-hangzhou
@@ -30,14 +33,17 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   accessRegion?: string;
   /**
    * @remarks
-   * The name of the cluster.
+   * The name of the hybrid cloud cluster.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * test
    */
   clusterName?: string;
   /**
    * @remarks
-   * The HTTP ports that are supported. Set this parameter to a string. Specify multiple ports in the **port1,port2,port3** format.
+   * The listening ports for the HTTP protocol. Separate multiple ports with commas (,), such as **port1,port2,port3**.
    * 
    * This parameter is required.
    * 
@@ -47,7 +53,7 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   httpPorts?: string;
   /**
    * @remarks
-   * The HTTPS ports that are supported. Set this parameter to a string. Specify multiple ports in the **port1,port2,port3** format.
+   * The listening ports for the HTTPS protocol. Separate multiple ports with commas (,), such as **port1,port2,port3**.
    * 
    * This parameter is required.
    * 
@@ -57,9 +63,9 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   httpsPorts?: string;
   /**
    * @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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -68,12 +74,18 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * > This parameter is deprecated. It no longer returns meaningful data.
+   * 
+   * @example
+   * deprecated
+   * 
    * @deprecated
    */
   logFieldsNotReturned?: string;
   /**
    * @remarks
-   * The number of protection nodes that can be added to the cluster.
+   * The maximum number of protection nodes that can be added to the hybrid cloud cluster.
    * 
    * This parameter is required.
    * 
@@ -83,10 +95,11 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   protectionServerCount?: number;
   /**
    * @remarks
-   * The status of the proxy gateway. Valid value:
+   * Indicates whether the proxy gateway is enabled for the cluster. Valid values:
    * 
-   * *   **on**: enabled.
-   * *   **off**: disabled.
+   * - **on**: The proxy gateway is enabled.
+   * 
+   * - **off**: The proxy gateway is disabled.
    * 
    * @example
    * off
@@ -94,10 +107,11 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   proxyStatus?: string;
   /**
    * @remarks
-   * The type of the cluster. Valid value:
+   * The type of the hybrid cloud cluster. Valid values:
+   * 
+   * - **cname**: reverse proxy cluster. Traffic is forwarded through CNAME resolution.
    * 
-   * *   **cname**: reverse proxy cluster.
-   * *   **service**: SDK-based traffic mirroring cluster.
+   * - **service**: transparent proxy cluster. Traffic is forwarded at the service level.
    * 
    * @example
    * cname
@@ -105,10 +119,11 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   proxyType?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid value:
+   * The region where the WAF instance resides. Valid values:
    * 
-   * *   **cn-hangzhou**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -116,17 +131,23 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The remarks about the cluster.
+   * The description of the hybrid cloud cluster.
+   * 
+   * @example
+   * test
    */
   remark?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The configurations of the rule.
+   * The configuration of the bypass rule, in JSON format. This includes settings such as circuit breaker thresholds, request body size limits, and timeout values.
    * 
    * @example
    * {
@@ -146,10 +167,11 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   ruleConfig?: string;
   /**
    * @remarks
-   * The status of manual bypass. Valid values:
+   * Indicates whether manual bypass is enabled for the cluster. Valid values:
+   * 
+   * - **on**: Manual bypass is enabled.
    * 
-   * *   **on**: enabled.
-   * *   **off**: disabled.
+   * - **off**: Manual bypass is disabled.
    * 
    * @example
    * on
@@ -157,9 +179,9 @@ export class CreateHybridCloudClusterRequest extends $dara.Model {
   ruleStatus?: string;
   /**
    * @remarks
-   * The type of the rule. Valid value:
+   * The type of the bypass rule. Valid values:
    * 
-   * *   **bypass**: allows requests without security checks.
+   * - **bypass**: skips WAF security checks and allows traffic to pass through directly.
    * 
    * @example
    * bypass

package/src/models/CreateHybridCloudClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHybridCloudClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cluster.
+   * The ID of the hybrid cloud cluster.
    * 
    * @example
    * 1

package/src/models/CreateHybridCloudClusterRuleRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHybridCloudClusterRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Hybrid Cloud WAF cluster.
+   * 
+   * > This parameter applies only to hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to obtain information about Hybrid Cloud WAF clusters.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,10 @@ export class CreateHybridCloudClusterRuleRequest extends $dara.Model {
   clusterId?: number;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,22 +28,58 @@ export class CreateHybridCloudClusterRuleRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The region where the WAF instance resides. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The configuration of the traffic redirection rule, in JSON format.
+   * 
+   * > The modes are mutually exclusive. You can select only one mode. If you change the mode, all traffic redirection rules in the previous mode are cleared.
+   * 
+   * - **check_mode**: the traffic redirection mode. Valid values:
+   * 
+   *   - **all**: redirects all traffic.
+   * 
+   *   - **part**: redirects a specific portion of traffic.
+   * 
+   * - **type**: the match type for the rule. Valid values:
+   * 
+   *   - **exact**: exact match.
+   * 
+   *   - **regex**: regular expression match.
+   * 
+   * - **substance**: the match value of the rule.
+   * 
    * @example
-   * {\\"check_mode\\": \\"all\\", \\"type\\": \\"exact\\", \\"substance\\": \\"122\\"}
+   * full volume drainage:{\\"check_mode\\": \\"all\\", \\"type\\": \\"exact\\", \\"substance\\": \\"122\\"}
+   * Specified partial drainage：{\\"check_mode\\": \\"part\\", \\"type\\": \\"exact\\", \\"substance\\": \\"12222\\"}
    */
   ruleConfig?: string;
   /**
    * @remarks
+   * The status of the traffic redirection rule. Valid values:
+   * 
+   * - **on**: enabled.
+   * 
+   * - **off**: disabled.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -44,6 +88,10 @@ export class CreateHybridCloudClusterRuleRequest extends $dara.Model {
   ruleStatus?: string;
   /**
    * @remarks
+   * The type of the traffic redirection rule. Valid values:
+   * 
+   * - **pullin**: traffic redirection
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateHybridCloudClusterRuleResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateHybridCloudClusterRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the cluster rule resource.
+   * 
    * @example
    * hdbc-clusterrule-*******m0w
    */
   clusterRuleResourceId?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 66A98669-CC6E-4F3E-*****-3014697B11AE
    */

package/src/models/CreateHybridCloudGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHybridCloudGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * The region in which the node resides. Specify the parameter in the Carrier code-Continent code-City code format.
+   * The back-to-origin mark of the node group. The value is in the format of Carrier-Continent-City, which is used to identify the origin of back-to-origin requests.
    * 
    * @example
    * aliyun-asiapacific-beijing
@@ -13,7 +13,7 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
   backSourceMark?: string;
   /**
    * @remarks
-   * The ID of the hybrid cloud cluster.
+   * The ID of the Hybrid Cloud WAF cluster.
    * 
    * This parameter is required.
    * 
@@ -28,17 +28,20 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * demoGroupName
+   * test
    */
   groupName?: string;
   /**
    * @remarks
    * The type of the node group. Valid values:
    * 
-   * *   **protect**
-   * *   **control**
-   * *   **storage**
-   * *   **controlStorage**
+   * - **protect**: a protection node group that processes traffic filtering.
+   * 
+   * - **control**: a control node group that manages cluster configurations.
+   * 
+   * - **storage**: a storage node group that stores logs and data.
+   * 
+   * - **controlStorage**: a node group that serves as both control and storage.
    * 
    * This parameter is required.
    * 
@@ -50,7 +53,7 @@ export class CreateHybridCloudGroupRequest 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 query the ID of the WAF instance.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -60,7 +63,7 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The IP address of the server used for load balancing.
+   * The IP address of the load balancer that is associated with the node group.
    * 
    * This parameter is required.
    * 
@@ -70,7 +73,7 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
   loadBalanceIp?: string;
   /**
    * @remarks
-   * The region in which the node resides. Specify the parameter in the Carrier code-Continent code-City code format.
+   * The location code of the region where the node group resides. The value is in the format of Carrier-Continent-City.
    * 
    * @example
    * 0-410-0
@@ -78,10 +81,11 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
   locationCode?: string;
   /**
    * @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**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -89,15 +93,15 @@ export class CreateHybridCloudGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The remarks.
+   * The remarks on the node group. You can use this parameter to add a brief description for the node group.
    * 
    * @example
-   * demoRamark
+   * test
    */
   remark?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/CreateHybridCloudGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHybridCloudGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the node group.
+   * The ID of the created node group.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class CreateHybridCloudGroupResponseBody extends $dara.Model {
   data?: number;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 48F7C7BA-0932-50EA-89AD-5B0E1***274

package/src/models/CreateLogDeliveryConfigRequest.ts

@@ -5,11 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class CreateLogDeliveryConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * The content of the log delivery configuration. Set the value to a JSON string that contains multiple parameters.
+   * The details of the log delivery configuration. The value is a JSON string that is generated from a series of parameters.
    * 
-   * >  The parameters vary based on the type of the **log delivery configuration** specified by **DeliveryType**. For more information, see **Parameter description for log delivery configuration**.
+   * > The parameters vary based on the value of **DeliveryType**. For more information, see **Parameters for log delivery configuration details**.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * {
+   *   "rfcVersion": "rfc3164",
+   *   "protocol": "tcp",
+   *   "servers": [
+   *     {
+   *       "address": "1.1.1.1",
+   *       "port": 20
+   *     }
+   *   ]
+   * }
    */
   deliveryDetail?: string;
   /**
@@ -26,20 +38,21 @@ export class CreateLogDeliveryConfigRequest extends $dara.Model {
    * @remarks
    * The type of the log delivery configuration. Valid values:
    * 
-   * *   **syslog**: Logs are delivered to a syslog service.
-   * *   **kafka**: Logs are delivered to a Kafka service.
+   * - **syslog**: Delivers logs to a syslog service.
+   * 
+   * - **kafka**: Delivers logs to a Kafka service.
    * 
    * This parameter is required.
    * 
    * @example
-   * kafka
+   * syslog
    */
   deliveryType?: string;
   /**
    * @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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -49,10 +62,11 @@ export class CreateLogDeliveryConfigRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @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

package/src/models/CreateLogDeliveryConfigResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateLogDeliveryConfigResponseBody extends $dara.Model {
   deliveryName?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 26E46541-7AAB-5565-801D-F14DBDC5****