@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/ModifyDomainResponseBody.ts

@@ -13,7 +13,7 @@ export class ModifyDomainResponseBodyDomainInfo extends $dara.Model {
   cname?: string;
   /**
    * @remarks
-   * The domain name whose access configurations you modified.
+   * The domain name whose configurations are modified.
    * 
    * @example
    * www.aliyundoc.com
@@ -55,15 +55,15 @@ export class ModifyDomainResponseBodyDomainInfo extends $dara.Model {
 export class ModifyDomainResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the domain name.
+   * The information about the modified domain name.
    */
   domainInfo?: ModifyDomainResponseBodyDomainInfo;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
-   * D7861F61-5B61-46CE-A47C-6B19160D5EB0
+   * D7861F61-5B61-46CE-A47C-6B19160D****
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDomainShrinkRequest.ts

@@ -5,9 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDomainShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The mode in which you want to add the domain name to WAF. Set the value to share.
+   * The access mode of the WAF instance. Valid values:
    * 
-   * *   **share:** adds the domain name to WAF in CNAME record mode. This is the default value.
+   * - **share** (default): onboarding by using a CNAME record.
+   * 
+   * - **hybrid_cloud_cname**: onboarding by using a hybrid cloud CNAME record.
    * 
    * @example
    * share
@@ -15,18 +17,25 @@ export class ModifyDomainShrinkRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The domain name whose access configurations you want to modify.
+   * The domain name whose configurations you want to modify.
    * 
    * @example
    * www.aliyundoc.com
    */
   domain?: string;
+  /**
+   * @remarks
+   * The ID of the domain name.
+   * 
+   * @example
+   * www.aliyundoc.com-waf
+   */
   domainId?: string;
   /**
    * @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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -36,14 +45,14 @@ export class ModifyDomainShrinkRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The listener configurations.
+   * The listening settings.
    * 
    * This parameter is required.
    */
   listenShrink?: string;
   /**
    * @remarks
-   * The forwarding configurations.
+   * The forwarding settings.
    * 
    * This parameter is required.
    */
@@ -52,8 +61,9 @@ export class ModifyDomainShrinkRequest 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.
    * 

package/src/models/ModifyHybridCloudClusterBypassStatusRequest.ts

@@ -17,9 +17,7 @@ export class ModifyHybridCloudClusterBypassStatusRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * **
-   * 
-   * **You can call the **DescribeInstanceInfo[ operation to obtain the ID of the WAF instance.](https://help.aliyun.com/document_detail/140857.html)
+   * > Call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -29,10 +27,11 @@ export class ModifyHybridCloudClusterBypassStatusRequest 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**: Chinese mainland
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -48,10 +47,11 @@ export class ModifyHybridCloudClusterBypassStatusRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The status of manual bypass. Valid values:
+   * The status of the manual bypass. Valid values:
+   * 
+   * - **on**: The manual bypass is enabled.
    * 
-   * *   **on**: enabled.
-   * *   **off**: disabled. This is the default value.
+   * - **off** (default): The manual bypass is disabled.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyHybridCloudClusterBypassStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyHybridCloudClusterBypassStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0

package/src/models/ModifyHybridCloudClusterRequest.ts

@@ -5,20 +5,45 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyHybridCloudClusterRequest extends $dara.Model {
   /**
    * @remarks
+   * The network access mode of the hybrid cloud cluster. Valid values:
+   * 
+   * - **internet**: access over the Internet.
+   * 
+   * - **vpc**: access over a leased line through a virtual private cloud (VPC).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * internet
    */
   accessMode?: string;
+  /**
+   * @remarks
+   * The region in which the leased line resides. This parameter is required when AccessMode is set to vpc. Valid values:
+   * 
+   * - **cn-hangzhou**: Hangzhou.
+   * 
+   * - **cn-beijing**: Beijing.
+   * 
+   * - **cn-shanghai**: Shanghai.
+   * 
+   * @example
+   * cn-beijing
+   */
   accessRegion?: string;
   /**
    * @remarks
-   * The name of the cluster.
+   * The name of the hybrid cloud cluster.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * waf-example-***
    */
   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 list of HTTP ports supported by the hybrid cloud cluster. Separate multiple ports with commas (,). Format: **port1,port2,port3**.
    * 
    * This parameter is required.
    * 
@@ -28,7 +53,7 @@ export class ModifyHybridCloudClusterRequest 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 list of HTTPS ports supported by the hybrid cloud cluster. Separate multiple ports with commas (,). Format: **port1,port2,port3**.
    * 
    * This parameter is required.
    * 
@@ -38,7 +63,7 @@ export class ModifyHybridCloudClusterRequest extends $dara.Model {
   httpsPorts?: string;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The ID of the hybrid cloud cluster.
    * 
    * This parameter is required.
    * 
@@ -50,7 +75,7 @@ export class ModifyHybridCloudClusterRequest 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 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.
    * 
@@ -58,10 +83,17 @@ export class ModifyHybridCloudClusterRequest extends $dara.Model {
    * waf-cn-mp9153****
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The log fields that are excluded from the response.
+   * 
+   * @example
+   * log_example
+   */
   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.
    * 
@@ -69,14 +101,37 @@ export class ModifyHybridCloudClusterRequest extends $dara.Model {
    * 1
    */
   protectionServerCount?: number;
+  /**
+   * @remarks
+   * Indicates whether the proxy gateway is enabled. Valid values:
+   * 
+   * - **on**: The proxy gateway is enabled.
+   * 
+   * - **off**: The proxy gateway is disabled.
+   * 
+   * @example
+   * off
+   */
   proxyStatus?: string;
+  /**
+   * @remarks
+   * The type of the hybrid cloud cluster. Valid values:
+   * 
+   * - **cname**: a reverse proxy cluster.
+   * 
+   * - **service**: a service cluster.
+   * 
+   * @example
+   * service
+   */
   proxyType?: 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
@@ -84,16 +139,61 @@ export class ModifyHybridCloudClusterRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The remarks about the cluster.
+   * The remarks of the hybrid cloud cluster.
+   * 
+   * @example
+   * remarkExample
    */
   remark?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group to which the WAF instance belongs.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
+  /**
+   * @remarks
+   * The rule configuration in JSON format. This includes settings such as the circuit breaker, request body length limit, and timeout.
+   * 
+   * @example
+   * {
+   *       "enable": true,
+   *       "param": {
+   *             "breaker": {
+   *                   "duration": 1,
+   *                   "failed": 1,
+   *                   "recent_failed": 1
+   *             },
+   *             "disable_protect": false,
+   *             "max_request_body_len": 1,
+   *             "timeout": 1
+   *       }
+   * }
+   */
   ruleConfig?: string;
+  /**
+   * @remarks
+   * Indicates whether the rule is enabled. Valid values:
+   * 
+   * - **on**: The rule is enabled.
+   * 
+   * - **off**: The rule is disabled.
+   * 
+   * @example
+   * off
+   */
   ruleStatus?: string;
+  /**
+   * @remarks
+   * The rule type. Valid values:
+   * 
+   * - **bypass**: WAF bypasses security checks.
+   * 
+   * @example
+   * bypass
+   */
   ruleType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyHybridCloudClusterRuleRequest.ts

@@ -5,18 +5,25 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyHybridCloudClusterRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the hybrid cloud cluster.
+   * [Deprecated] The ID of the hybrid cloud cluster.
    * 
    * @example
-   * 1018
+   * 10*
    */
   clusterId?: number;
+  /**
+   * @remarks
+   * The resource ID of the cluster rule.
+   * 
+   * @example
+   * hdbc-clusterrule-*******ym0w
+   */
   clusterRuleResourceId?: string;
   /**
    * @remarks
-   * The ID of the WAF instance.
+   * Instance ID of the WAF instance.
    * 
-   * >  You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.[](~~140857~~)
+   * > You can call [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) to query instance ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -26,10 +33,11 @@ export class ModifyHybridCloudClusterRuleRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region of the WAF instance. Valid value:
+   * The region where the WAF instance is deployed. 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
@@ -45,18 +53,26 @@ export class ModifyHybridCloudClusterRuleRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The configuration of the rule.
+   * The traffic redirection rule configuration.
+   * 
+   * <notice>The mode cannot be modified.</notice>
+   * - **check_mode**: The mode. Valid values:
+   *   - **all**: full traffic redirection.
+   *   - **part**: partial traffic redirection.
+   * - **type**: The rule matching type. Valid values:
+   *   - **exact**: exact match.
+   *   - **regex**: regular expression.
+   * - **substance**: The rule value.
    * 
    * @example
-   * {\\"check_mode\\":\\"part\\",\\"include\\":{\\"exact\\":[],\\"regex\\":[]}}
+   * {\\"check_mode\\": \\"all\\", \\"type\\": \\"exact\\", \\"substance\\": \\"122\\"}
    */
   ruleConfig?: string;
   /**
    * @remarks
-   * The status of the rule. Valid values:
-   * 
-   * *   **on**: enables the rule.
-   * *   **off**: disables the rule.
+   * The rule status. Valid values:
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -64,9 +80,8 @@ export class ModifyHybridCloudClusterRuleRequest extends $dara.Model {
   ruleStatus?: string;
   /**
    * @remarks
-   * The type of the rule. Valid values:
-   * 
-   * *   **pullin**: The traffic redirection rule.
+   * [Deprecated] The rule type. Valid values:
+   * - **pullin**: traffic redirection configuration.
    * 
    * @example
    * pullin

package/src/models/ModifyHybridCloudGroupExpansionServerRequest.ts

@@ -15,7 +15,7 @@ export class ModifyHybridCloudGroupExpansionServerRequest extends $dara.Model {
   clusterId?: number;
   /**
    * @remarks
-   * The ID of the node group.
+   * The ID of the node group in the hybrid cloud cluster.
    * 
    * This parameter is required.
    * 
@@ -27,7 +27,7 @@ export class ModifyHybridCloudGroupExpansionServerRequest 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.
    * 
@@ -37,7 +37,7 @@ export class ModifyHybridCloudGroupExpansionServerRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the node.
+   * The ID of the node that you want to add to the node group.
    * 
    * This parameter is required.
    * 
@@ -47,10 +47,11 @@ export class ModifyHybridCloudGroupExpansionServerRequest extends $dara.Model {
   mids?: string;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * 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
@@ -58,7 +59,7 @@ export class ModifyHybridCloudGroupExpansionServerRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the Resource Manager resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/ModifyHybridCloudGroupExpansionServerResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyHybridCloudGroupExpansionServerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 7BD7F9A1-0E72-5BC1-8248-C629B4***B6

package/src/models/ModifyHybridCloudGroupRequest.ts

@@ -15,7 +15,7 @@ export class ModifyHybridCloudGroupRequest extends $dara.Model {
   clusterId?: number;
   /**
    * @remarks
-   * The ID of the node group.
+   * The ID of the hybrid cloud group.
    * 
    * This parameter is required.
    * 
@@ -25,19 +25,19 @@ export class ModifyHybridCloudGroupRequest extends $dara.Model {
   groupId?: number;
   /**
    * @remarks
-   * The name of the node group.
+   * The name of the hybrid cloud group.
    * 
    * This parameter is required.
    * 
    * @example
-   * demo
+   * test-group
    */
   groupName?: 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to obtain the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -47,10 +47,11 @@ export class ModifyHybridCloudGroupRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid value:
+   * The region of the WAF instance. 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
@@ -66,7 +67,7 @@ export class ModifyHybridCloudGroupRequest extends $dara.Model {
   remark?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/ModifyHybridCloudGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyHybridCloudGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D***0

package/src/models/ModifyHybridCloudGroupShrinkServerRequest.ts

@@ -26,8 +26,7 @@ export class ModifyHybridCloudGroupShrinkServerRequest 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.
+   * > 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.
    * 
@@ -37,7 +36,7 @@ export class ModifyHybridCloudGroupShrinkServerRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the node.
+   * The node ID.
    * 
    * This parameter is required.
    * 
@@ -47,10 +46,11 @@ export class ModifyHybridCloudGroupShrinkServerRequest extends $dara.Model {
   mids?: string;
   /**
    * @remarks
-   * The region of the WAF instance. Valid values:
+   * The region where the WAF instance is deployed. 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

package/src/models/ModifyHybridCloudSdkPullinStatusRequest.ts

@@ -7,7 +7,7 @@ export class ModifyHybridCloudSdkPullinStatusRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to view the current WAF instance ID.
    * 
    * This parameter is required.
    * 
@@ -27,10 +27,11 @@ export class ModifyHybridCloudSdkPullinStatusRequest extends $dara.Model {
   mid?: string;
   /**
    * @remarks
-   * The status of traffic redirection. Valid values:
+   * The status of traffic redirection. Valid values of the parameter:
    * 
-   * *   **on**
-   * *   **off**
+   * - **on**: Enable
+   * 
+   * - **off**: Disable
    * 
    * This parameter is required.
    * 

package/src/models/ModifyHybridCloudServerRequest.ts

@@ -15,19 +15,19 @@ export class ModifyHybridCloudServerRequest extends $dara.Model {
   continents?: string;
   /**
    * @remarks
-   * The name of the node.
+   * The node name.
    * 
    * This parameter is required.
    * 
    * @example
-   * demo
+   * 节点名称
    */
   customName?: string;
   /**
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > You can call [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -37,7 +37,7 @@ export class ModifyHybridCloudServerRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the node.
+   * The node ID.
    * 
    * This parameter is required.
    * 
@@ -67,10 +67,11 @@ export class ModifyHybridCloudServerRequest extends $dara.Model {
   regionCode?: string;
   /**
    * @remarks
-   * The region of the WAF instance. Valid values:
+   * The region where the WAF instance is deployed. 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
@@ -78,7 +79,7 @@ export class ModifyHybridCloudServerRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The Alibaba Cloud resource group ID.
    * 
    * @example
    * rg-acfm***q