@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/CreateDefenseResourceRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDefenseResourceRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * demoTagKey
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * TagValue1
    */
@@ -37,14 +43,27 @@ export class CreateDefenseResourceRequestTag extends $dara.Model {
 }
 
 export class CreateDefenseResourceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A list of custom header fields.
+   * 
+   * > If you set XffStatus 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 tries to obtain the client IP address from the header fields in sequence. If WAF fails to obtain the client IP address from the specified header fields, it uses 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 detailed parameters of the protected object. This parameter is a string that consists of a JSON struct.
+   * 
+   * > The 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 account to which the protected object belongs. This parameter is used in multi-account scenarios. By default, the protected object belongs to the WAF administrator account.
+   * 
    * @example
    * 123221XXX
    */
   ownerUserId?: string;
   /**
    * @remarks
+   * The protection mode 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 is deployed. 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 you want to add the protected object. This parameter is optional.
+   * 
+   * @example
+   * testGroup
+   */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
+   * The source of the protected object. Only the following value is supported:
+   * 
+   * - **custom**: a custom object.
+   * 
    * This parameter is required.
    * 
    * @example
    * custom
    */
   resourceOrigin?: string;
+  /**
+   * @remarks
+   * A list of tags. You can add up to 20 tags.
+   */
   tag?: CreateDefenseResourceRequestTag[];
   /**
+   * @remarks
+   * Specifies whether to enable the X-Forwarded-For (XFF) proxy. Valid values:
+   * 
+   * - **0**: disabled. This is the default value.
+   * 
+   * - **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 tag key.
+   * 
    * @example
    * demoTagKey
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * TagValue1
    */
@@ -37,14 +43,27 @@ export class CreateDefenseResourceShrinkRequestTag extends $dara.Model {
 }
 
 export class CreateDefenseResourceShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A list of custom header fields.
+   * 
+   * > If you set XffStatus 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 tries to obtain the client IP address from the header fields in sequence. If WAF fails to obtain the client IP address from the specified header fields, it uses 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 detailed parameters of the protected object. This parameter is a string that consists of a JSON struct.
+   * 
+   * > The 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 account to which the protected object belongs. This parameter is used in multi-account scenarios. By default, the protected object belongs to the WAF administrator account.
+   * 
    * @example
    * 123221XXX
    */
   ownerUserId?: string;
   /**
    * @remarks
+   * The protection mode 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 is deployed. 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 you want to add the protected object. This parameter is optional.
+   * 
+   * @example
+   * testGroup
+   */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
+   * The source of the protected object. Only the following value is supported:
+   * 
+   * - **custom**: a custom object.
+   * 
    * This parameter is required.
    * 
    * @example
    * custom
    */
   resourceOrigin?: string;
+  /**
+   * @remarks
+   * A list of tags. You can add up to 20 tags.
+   */
   tag?: CreateDefenseResourceShrinkRequestTag[];
   /**
+   * @remarks
+   * Specifies whether to enable the X-Forwarded-For (XFF) proxy. Valid values:
+   * 
+   * - **0**: disabled. This is the default value.
+   * 
+   * - **1**: enabled.
+   * 
    * @example
    * 0
    */

package/src/models/CreateDefenseRuleRequest.ts

@@ -5,18 +5,51 @@ 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 protection scenario for the rule.
+   * 
+   * When **DefenseType** is **template**, valid values are:
+   * 
+   * - **waf_group**: basic protection.
+   * 
+   * - **waf_base**: new version of Web core protection.
+   * 
+   * - **antiscan**: scan protection.
+   * 
+   * - **ip_blacklist**: IP blacklist.
+   * 
+   * - **custom_acl**: custom rules.
+   * 
+   * - **whitelist**: whitelist.
+   * 
+   * - **region_block**: location blacklist.
+   * 
+   * - **custom_response**: legacy custom response.
+   * 
+   * - **cc**: HTTP flood protection.
+   * 
+   * - **tamperproof**: webpage tamper protection.
+   * 
+   * - **dlp**: data leak prevention.
+   * 
+   * - **spike_throttle**: peak traffic throttling.
+   * 
+   * When **DefenseType** is **resource**, valid values are:
+   * 
+   * - **account_identifier**: account extraction.
+   * 
+   * - **custom_response**: new version of custom response.
+   * 
+   * - **waf_codec**: decoding.
+   * 
+   * When **DefenseType** is **global**, valid values are:
+   * 
+   * - **regular_custom**: custom regex.
+   * 
+   * - **address_book**: address book.
+   * 
+   * - **custom_response**: new version of custom response.
+   * 
+   * > For globally configured custom responses, users can reference them under protected objects or rules. When referenced at different levels, the effective logic follows this order: rule level > protected object level > default page.
    * 
    * This parameter is required.
    * 
@@ -24,12 +57,25 @@ export class CreateDefenseRuleRequest extends $dara.Model {
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @remarks
+   * The type of the protection rule. Valid values:
+   * 
+   * - **template** (default): template-based protection rules.
+   * 
+   * - **resource**: rules applied at the protected object level.
+   * 
+   * - **global**: global-level rules.
+   * 
+   * @example
+   * template
+   */
   defenseType?: 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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -41,17 +87,27 @@ export class CreateDefenseRuleRequest 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.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The protected object associated with the rule.
+   * 
+   * > Provide this parameter only when **DefenseType** is **resource**.
+   * 
+   * @example
+   * sec****-waf
+   */
   resource?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -59,19 +115,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 rule configuration content, specified as 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 specific parameters vary based on the specified **DefenseType** (**DefenseScene**). For details, see **Protection Rule Parameter Descriptions**.
    * 
    * 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 template to which the rule belongs.
+   * 
+   * > Provide this parameter only when **DefenseType** is **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 IDs of the created protection rules, separated by commas (,).
    * 
    * @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 of the [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html) operation.
    * 
    * This parameter is required.
    * 
@@ -13,19 +13,26 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @example
+   * bot_custom_acl
+   */
+  defenseSubScene?: string;
   /**
    * @remarks
-   * The description of the protection rule template.
+   * The description of the protection template.
+   * 
+   * - **bot_custom_acl**: Represents the protection template for advanced custom rules in bot management.
    * 
    * @example
-   * Test
+   * test
    */
   description?: 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 the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -35,10 +42,7 @@ export class CreateDefenseTemplateRequest 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.
+   * The region where the WAF instance is deployed. Valid values:
    * 
    * @example
    * cn-hangzhou
@@ -46,7 +50,11 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
+   * 
+   * - **cn-hangzhou**: Represents the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: Represents regions outside the Chinese mainland.
    * 
    * @example
    * rg-acfm***q
@@ -54,7 +62,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 long and can contain letters, digits, Chinese characters, underscores (_), periods (.), and hyphens (-).
+   * 
+   * > The names of templates for the same protection scenario (**DefenseScene**) must be unique.
    * 
    * This parameter is required.
    * 
@@ -64,7 +74,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**.
    * 
    * This parameter is required.
    * 
@@ -74,10 +84,11 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   templateOrigin?: string;
   /**
    * @remarks
-   * The status of the protection rule template. Valid values:
+   * Indicates whether the protection template is enabled. Valid values:
+   * 
+   * - **0**: Disabled.
    * 
-   * *   **0:** disabled.
-   * *   **1:** enabled.
+   * - **1**: Enabled.
    * 
    * This parameter is required.
    * 
@@ -87,10 +98,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**: The user\\"s default template.
+   * 
+   * - **user_custom**: A user-defined template.
    * 
    * This parameter is required.
    * 
@@ -98,11 +110,22 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
    * user_default
    */
   templateType?: string;
+  /**
+   * @remarks
+   * The protected objects to unbind when you create a default template. Use the [**"XX1","XX2",...**] format.
+   * 
+   * > This parameter takes effect only when you create a **default template** (**TemplateType** is set to **user_default**).
+   */
   unbindResourceGroups?: string[];
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   */
   unbindResources?: string[];
   static names(): { [key: string]: string } {
     return {
       defenseScene: 'DefenseScene',
+      defenseSubScene: 'DefenseSubScene',
       description: 'Description',
       instanceId: 'InstanceId',
       regionId: 'RegionId',
@@ -119,6 +142,7 @@ export class CreateDefenseTemplateRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       defenseScene: 'string',
+      defenseSubScene: 'string',
       description: 'string',
       instanceId: 'string',
       regionId: 'string',

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