@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/CreateDefenseResourceRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDefenseResourceRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The key of the tag.
+   * 
    * @example
    * demoTagKey
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the tag.
+   * 
    * @example
    * TagValue1
    */
@@ -37,14 +43,27 @@ export class CreateDefenseResourceRequestTag extends $dara.Model {
 }
 
 export class CreateDefenseResourceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The custom header fields used to obtain the actual client IP address when XFF proxy is enabled.
+   * 
+   * > If XffStatus is set to 1, WAF uses the first IP address from the specified header field as the client IP address to prevent XFF forgery. If you specify multiple header fields, WAF reads them in order. If no valid client IP address is found in the specified header fields, WAF falls back to the first IP address in the X-Forwarded-For header field.
+   */
   customHeaders?: string[];
   /**
+   * @remarks
+   * The description of the protected object.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The configuration details of the protected object, in JSON format.
+   * 
+   * > The required parameters vary based on the values of **Product** and **Pattern**. For more information, see the **Description of the Detail parameter** section.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -53,6 +72,10 @@ export class CreateDefenseResourceRequest extends $dara.Model {
   detail?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,12 +83,21 @@ export class CreateDefenseResourceRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the protected object belongs. This parameter is required only in multi-account scenarios. By default, the protected object belongs to the WAF administrator account.
+   * 
    * @example
    * 123221XXX
    */
   ownerUserId?: string;
   /**
    * @remarks
+   * The type of the protected object. Valid values:
+   * 
+   * - **domain**: domain name.
+   * 
+   * - **multi_service**: hybrid cloud deployment.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -74,6 +106,20 @@ export class CreateDefenseResourceRequest extends $dara.Model {
   pattern?: string;
   /**
    * @remarks
+   * The name of the Alibaba Cloud service. Valid values:
+   * 
+   * - **alb**: Application Load Balancer (ALB).
+   * 
+   * - **ecs**: Elastic Compute Service (ECS).
+   * 
+   * - **clb4**: Layer 4 Classic Load Balancer (CLB).
+   * 
+   * - **clb7**: Layer 7 CLB.
+   * 
+   * - **nlb**: Network Load Balancer (NLB).
+   * 
+   * - **waf**: Web Application Firewall (WAF).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -81,31 +127,68 @@ export class CreateDefenseResourceRequest extends $dara.Model {
    */
   product?: 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 name of the protected object.
+   * 
+   * > - Only protected objects of hybrid cloud deployments support custom names.
+   * 
    * @example
    * abctest.com
    */
   resource?: string;
+  /**
+   * @remarks
+   * The name of the protection group to which the protected object is added.
+   * 
+   * @example
+   * testGroup
+   */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
+   * The origin type of the protected object. Valid values:
+   * 
+   * - **custom**: a user-defined protected object.
+   * 
    * This parameter is required.
    * 
    * @example
    * custom
    */
   resourceOrigin?: string;
+  /**
+   * @remarks
+   * A list of tags. You can add up to 20 tags.
+   */
   tag?: CreateDefenseResourceRequestTag[];
   /**
+   * @remarks
+   * Indicates whether the X-Forwarded-For (XFF) proxy feature is enabled. Valid values:
+   * 
+   * - **0** (default): disabled.
+   * 
+   * - **1**: enabled.
+   * 
    * @example
    * 0
    */

package/src/models/CreateDefenseResourceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDefenseResourceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1738C613-D054-5191-888B-DC0CF4C3A4A0
    */
   requestId?: string;
   /**
+   * @remarks
+   * The name of the protected object that is created.
+   * 
    * @example
    * cdX.XXX-call.cn-alb
    */

package/src/models/CreateDefenseResourceShrinkRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDefenseResourceShrinkRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The key of the tag.
+   * 
    * @example
    * demoTagKey
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the tag.
+   * 
    * @example
    * TagValue1
    */
@@ -37,14 +43,27 @@ export class CreateDefenseResourceShrinkRequestTag extends $dara.Model {
 }
 
 export class CreateDefenseResourceShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The custom header fields used to obtain the actual client IP address when XFF proxy is enabled.
+   * 
+   * > If XffStatus is set to 1, WAF uses the first IP address from the specified header field as the client IP address to prevent XFF forgery. If you specify multiple header fields, WAF reads them in order. If no valid client IP address is found in the specified header fields, WAF falls back to the first IP address in the X-Forwarded-For header field.
+   */
   customHeadersShrink?: string;
   /**
+   * @remarks
+   * The description of the protected object.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The configuration details of the protected object, in JSON format.
+   * 
+   * > The required parameters vary based on the values of **Product** and **Pattern**. For more information, see the **Description of the Detail parameter** section.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -53,6 +72,10 @@ export class CreateDefenseResourceShrinkRequest extends $dara.Model {
   detail?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,12 +83,21 @@ export class CreateDefenseResourceShrinkRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the protected object belongs. This parameter is required only in multi-account scenarios. By default, the protected object belongs to the WAF administrator account.
+   * 
    * @example
    * 123221XXX
    */
   ownerUserId?: string;
   /**
    * @remarks
+   * The type of the protected object. Valid values:
+   * 
+   * - **domain**: domain name.
+   * 
+   * - **multi_service**: hybrid cloud deployment.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -74,6 +106,20 @@ export class CreateDefenseResourceShrinkRequest extends $dara.Model {
   pattern?: string;
   /**
    * @remarks
+   * The name of the Alibaba Cloud service. Valid values:
+   * 
+   * - **alb**: Application Load Balancer (ALB).
+   * 
+   * - **ecs**: Elastic Compute Service (ECS).
+   * 
+   * - **clb4**: Layer 4 Classic Load Balancer (CLB).
+   * 
+   * - **clb7**: Layer 7 CLB.
+   * 
+   * - **nlb**: Network Load Balancer (NLB).
+   * 
+   * - **waf**: Web Application Firewall (WAF).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -81,31 +127,68 @@ export class CreateDefenseResourceShrinkRequest extends $dara.Model {
    */
   product?: 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 name of the protected object.
+   * 
+   * > - Only protected objects of hybrid cloud deployments support custom names.
+   * 
    * @example
    * abctest.com
    */
   resource?: string;
+  /**
+   * @remarks
+   * The name of the protection group to which the protected object is added.
+   * 
+   * @example
+   * testGroup
+   */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
+   * The origin type of the protected object. Valid values:
+   * 
+   * - **custom**: a user-defined protected object.
+   * 
    * This parameter is required.
    * 
    * @example
    * custom
    */
   resourceOrigin?: string;
+  /**
+   * @remarks
+   * A list of tags. You can add up to 20 tags.
+   */
   tag?: CreateDefenseResourceShrinkRequestTag[];
   /**
+   * @remarks
+   * Indicates whether the X-Forwarded-For (XFF) proxy feature is enabled. Valid values:
+   * 
+   * - **0** (default): disabled.
+   * 
+   * - **1**: enabled.
+   * 
    * @example
    * 0
    */

package/src/models/CreateDefenseRuleRequest.ts

@@ -5,18 +5,53 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDefenseRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The module to which the protection rule that you want to create belongs.
-   * 
-   * *   **waf_group:** the basic protection rule module.
-   * *   **antiscan:** the scan protection module.
-   * *   **ip_blacklist:** the IP address blacklist module.
-   * *   **custom_acl:** the custom rule module.
-   * *   **whitelist:** the whitelist module.
-   * *   **region_block:** the region blacklist module.
-   * *   **custom_response:** the custom response module.
-   * *   **cc:** the HTTP flood protection module.
-   * *   **tamperproof:** the website tamper-proofing module.
-   * *   **dlp:** the data leakage prevention module.
+   * The scenario to which the protection rule is applied.
+   * 
+   * If **DefenseType** is set to **template**, valid values are:
+   * 
+   * - **waf_group**: basic protection.
+   * 
+   * - **waf_base**: web core protection.
+   * 
+   * - **antiscan**: scan protection.
+   * 
+   * - **ip_blacklist**: IP address blacklist.
+   * 
+   * - **custom_acl**: custom rule.
+   * 
+   * - **whitelist**: whitelist.
+   * 
+   * - **region_block**: geo-blocking.
+   * 
+   * - **custom_response**: custom response.
+   * 
+   * - **cc**: HTTP flood protection.
+   * 
+   * - **tamperproof**: webpage tamper-proofing.
+   * 
+   * - **dlp**: data leakage prevention.
+   * 
+   * - **spike_throttle**: rate limiting for bursts of traffic.
+   * 
+   * - **bot_manager**: bot management.
+   * 
+   * If **DefenseType** is set to **resource**, valid values are:
+   * 
+   * - **account_identifier**: account identification.
+   * 
+   * - **custom_response**: custom response.
+   * 
+   * - **waf_codec**: decoding.
+   * 
+   * If **DefenseType** is set to **global**, valid values are:
+   * 
+   * - **regular_custom**: custom regular expression.
+   * 
+   * - **address_book**: address book.
+   * 
+   * - **custom_response**: custom response.
+   * 
+   * > You can apply a global custom response to a protected object or a rule. If you configure custom response rules at different levels, the rule with the finest-grained scope takes precedence. The priority is as follows: rule > protected object > default page.
    * 
    * This parameter is required.
    * 
@@ -24,12 +59,25 @@ export class CreateDefenseRuleRequest extends $dara.Model {
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @remarks
+   * The type of the protection rule. Valid values:
+   * 
+   * - **template** (default): a template-based protection rule.
+   * 
+   * - **resource**: a rule for a specific protected object.
+   * 
+   * - **global**: a global protection rule.
+   * 
+   * @example
+   * template
+   */
   defenseType?: 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.
+   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to get the ID of your WAF instance.
    * 
    * This parameter is required.
    * 
@@ -39,15 +87,25 @@ export class CreateDefenseRuleRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region where the WAF instance is deployed. Valid values:
+   * 
+   * - **cn-hangzhou**: Chinese mainland.
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The protected object to which the rule applies.
+   * 
+   * > This parameter is required only when **DefenseType** is set to **resource**.
+   * 
+   * @example
+   * sec****-waf
+   */
   resource?: string;
   /**
    * @remarks
@@ -59,19 +117,21 @@ export class CreateDefenseRuleRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The configurations of the protection rule. The value is a JSON string that contains multiple parameters.
+   * The details of the protection rule. This value is a JSON string.
    * 
-   * >  The parameters vary based on the **protection module**, which is specified by **DefenseScene**. For more information, see the "**Parameters of protection rules**" section in this topic.
+   * > The parameters in the JSON string vary based on the value of **DefenseScene**. For more information, see **Protection rule parameters**.
    * 
    * This parameter is required.
    * 
    * @example
-   * For more information, see the following section
+   * waf_group
    */
   rules?: string;
   /**
    * @remarks
-   * The ID of the rule template for which you want to create a protection rule.
+   * The ID of the protection rule template.
+   * 
+   * > This parameter is required only when **DefenseType** is set to **template**.
    * 
    * @example
    * 1122

package/src/models/CreateDefenseRuleResponseBody.ts

@@ -8,12 +8,12 @@ export class CreateDefenseRuleResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 26E46541-7AAB-5565-801D-F14DBDC5F186
+   * 26E46541-7AAB-5565-801D-F14DBDC5****
    */
   requestId?: string;
   /**
    * @remarks
-   * The IDs of the protection rules. Multiple IDs are separated by commas (,).
+   * The comma-separated IDs of the created protection rules.
    * 
    * @example
    * 22215,23354,462165

package/src/models/CreateDefenseTemplateRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDefenseTemplateRequest extends $dara.Model {
   /**
    * @remarks
-   * The scenario in which you want to use the protection rule template. For more information, see the description of the **DefenseScene** parameter in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The protection scenario. For more information, see the **DefenseScene** parameter in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
    * 
    * This parameter is required.
    * 
@@ -13,20 +13,29 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @remarks
+   * The sub-scenario of the protection template. Valid values:
+   * 
+   * - **bot_custom_acl**: a protection template for advanced custom rules for Bot management.
+   * 
+   * @example
+   * bot_custom_acl
+   */
   defenseSubScene?: string;
   /**
    * @remarks
-   * The description of the protection rule template.
+   * The description of the protection template.
    * 
    * @example
-   * Test
+   * test
    */
   description?: string;
   /**
    * @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.
+   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -36,10 +45,11 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region where the WAF instance is deployed. Valid values:
+   * 
+   * - **cn-hangzhou**: Chinese mainland.
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -47,7 +57,7 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -55,7 +65,9 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The name of the protection rule template.
+   * The name of the protection template. The name must be 1 to 255 characters in length and can contain letters, digits, underscores (_), periods (.), and hyphens (-).
+   * 
+   * > Template names must be unique within the same protection scenario (**DefenseScene**).
    * 
    * This parameter is required.
    * 
@@ -65,7 +77,7 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   templateName?: string;
   /**
    * @remarks
-   * The origin of the protection rule template that you want to create. Set the value to **custom**. The value specifies that the protection rule template is a custom template.
+   * The origin of the protection template. The value must be **custom**, which indicates a user-defined template.
    * 
    * This parameter is required.
    * 
@@ -75,10 +87,11 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   templateOrigin?: string;
   /**
    * @remarks
-   * The status of the protection rule template. Valid values:
+   * The status of the protection template. Valid values:
+   * 
+   * - **0**: Disabled.
    * 
-   * *   **0:** disabled.
-   * *   **1:** enabled.
+   * - **1**: Enabled.
    * 
    * This parameter is required.
    * 
@@ -88,10 +101,11 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   templateStatus?: number;
   /**
    * @remarks
-   * The type of the protection rule template. Valid values:
+   * The type of the protection template. Valid values:
    * 
-   * *   **user_default:** default template.
-   * *   **user_custom:** custom template.
+   * - **user_default**: a default template created by the user.
+   * 
+   * - **user_custom**: a custom template created by the user.
    * 
    * This parameter is required.
    * 
@@ -99,7 +113,19 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
    * user_default
    */
   templateType?: string;
+  /**
+   * @remarks
+   * The protected object groups to unbind from the default protection template. Specify the value in the [**"group1","group2",...**] format.
+   * 
+   * > This parameter takes effect only when you create a **default template** (**TemplateType** is set to **user_default**).
+   */
   unbindResourceGroups?: string[];
+  /**
+   * @remarks
+   * The protected objects to unbind from the default protection template. Specify the value in the [**"XX1","XX2",...**] format.
+   * 
+   * > This parameter takes effect only when you create a **default template** (**TemplateType** is set to **user_default**).
+   */
   unbindResources?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateDefenseTemplateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDefenseTemplateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F48ABDF7-D777-5F26-892A-57349765D7A9
@@ -13,7 +13,7 @@ export class CreateDefenseTemplateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the protection rule template.
+   * The ID of the protection template.
    * 
    * @example
    * 2212