@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeDefenseRulesResponseBody.ts

@@ -4,15 +4,18 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
-   * {"empty":"test"}
+   * 42755
    * 
    * @deprecated
    */
   actionExternal?: string;
   /**
    * @remarks
-   * The details of the protection rule. The value is a string that contains multiple parameters in the JSON format. For more information, see the "**Rule parameters**" section in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The details of the protection rule. The value is a JSON string. For more information, see the **description of the Rule parameter** in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
    * 
    * @example
    * {\\"policyId\\":1012,\\"action\\":\\"block\\"}
@@ -20,10 +23,11 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * The origin of the protection rule. Valid values:
+   * The source of the protection rule. Valid values:
+   * 
+   * - **custom**: The rule is created by the user.
    * 
-   * *   **custom:** The protection rule is created by the user.
-   * *   **system:** The protection rule is automatically generated by the system.
+   * - **system**: The rule is automatically generated by the system.
    * 
    * @example
    * custom
@@ -31,57 +35,129 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
   defenseOrigin?: string;
   /**
    * @remarks
-   * The protection module for which the protection rule is created. Valid values:
+   * The protection scenario.
+   * 
+   * If the **DefenseType** request parameter is set to **template**, the valid values are:
+   * 
+   * - **waf_group**: regular expression rules for basic protection.
+   * 
+   * - **waf_base**: rules for the new web core protection feature.
+   * 
+   * - **waf_base_compliance**: protocol compliance rules for basic protection.
+   * 
+   * - **waf_base_sema**: semantic rules for basic protection.
+   * 
+   * - **cc**: HTTP flood protection.
+   * 
+   * - **antiscan_dirscan**: directory traversal blocking for scan protection.
+   * 
+   * - **antiscan_highfreq**: high-frequency scan blocking for scan protection.
+   * 
+   * - **antiscan_scantools**: scanner blocking for scan protection.
+   * 
+   * - **ip_blacklist**: IP address blacklist.
+   * 
+   * - **custom_acl**: custom rules.
    * 
-   * *   **waf_group**: the basic protection rule module.
-   * *   **waf_base_compliance**: the protocol compliance feature of the basic protection rule module.
-   * *   **waf_base_sema**: the semantic analysis feature of the basic protection rule module.
-   * *   **cc**: the HTTP flood protection module.
-   * *   **antiscan_dirscan**: the directory traversal blocking feature of the scan protection module.
-   * *   **antiscan_highfreq**: the high-frequency scanning blocking feature of the scan protection module.
-   * *   **antiscan_scantools**: the scanner blocking feature of the scan protection module.
-   * *   **ip_blacklist**: the IP address blacklist module.
-   * *   **custom_acl**: the custom rule module.
-   * *   **region_block**: the region blacklist module.
-   * *   **tamperproof**: the website tamper-proofing module.
-   * *   **dlp**: the data leakage prevention module.
-   * *   **custom_response_block**: the custom response module.
+   * - **region_block**: Geo-blocking.
+   * 
+   * - **tamperproof**: webpage tamper protection.
+   * 
+   * - **dlp**: data leakage prevention.
+   * 
+   * - **custom_response_block**: custom response.
+   * 
+   * - **spike_throttle**: peak traffic throttling.
+   * 
+   * If the **DefenseType** request parameter is set to **resource**, the valid values are:
+   * 
+   * - **account_identifier**: account fetch.
+   * 
+   * - **custom_response**: new custom response.
+   * 
+   * - **waf_codec**: decoding.
+   * 
+   * If the **DefenseType** request parameter is set to **global**, the valid values are:
+   * 
+   * - **regular_custom**: custom regular expression.
+   * 
+   * - **address_book**: address book.
+   * 
+   * - **custom_response**: new custom response.
    * 
    * @example
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @remarks
+   * The type of the protection rule. Valid values:
+   * 
+   * - **template** (default): template protection rules.
+   * 
+   * - **resource**: rules for protected objects.
+   * 
+   * - **global**: global rules.
+   * 
+   * @example
+   * template
+   */
   defenseType?: string;
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
-   * test
+   * rule description
    * 
    * @deprecated
    */
   description?: string;
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
-   * 123,456
+   * 42755
    * 
    * @deprecated
    */
   detailRuleIds?: string;
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
-   * empty
+   * {\\"DetectType\\":\\"sqli\\"}
    * 
    * @deprecated
    */
   externalInfo?: string;
+  /**
+   * @remarks
+   * The time when the protection rule was created. This value is a UNIX timestamp. Unit: milliseconds.
+   * 
+   * @example
+   * 1665460629000
+   */
   gmtCreate?: number;
   /**
    * @remarks
-   * The most recent time when the protection rule was modified.
+   * The time when the protection rule was last modified. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1665460629000
    */
   gmtModified?: number;
+  /**
+   * @remarks
+   * The protected object to which the rule is applied.
+   * 
+   * > This parameter is returned only when the **DefenseType** request parameter is set to **resource**.
+   * 
+   * @example
+   * rencs***-waf
+   */
   resource?: string;
   /**
    * @remarks
@@ -100,8 +176,11 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
    */
   ruleName?: string;
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
-   * test
+   * custom_cc
    * 
    * @deprecated
    */
@@ -110,8 +189,9 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
    * @remarks
    * The status of the protection rule. Valid values:
    * 
-   * *   **0:** disabled.
-   * *   **1:** enabled.
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -119,7 +199,7 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The ID of the protection rule template.
+   * The ID of the protection template.
    * 
    * @example
    * 5673
@@ -179,7 +259,7 @@ export class DescribeDefenseRulesResponseBodyRules extends $dara.Model {
 export class DescribeDefenseRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 80736FA5-FA87-55F6-AA69-C5477C6FE6D0
@@ -187,7 +267,7 @@ export class DescribeDefenseRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The protection rules.
+   * The list of protection rules.
    */
   rules?: DescribeDefenseRulesResponseBodyRules[];
   /**

package/src/models/DescribeDefenseSceneConfigRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the configuration item that you want to query. For more information, see the **ConfigKey** parameter in [ModifyDefenseSceneConfig](https://help.aliyun.com/document_detail/2968435.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeDefenseSceneConfigRequest extends $dara.Model {
   configKey?: string;
   /**
    * @remarks
+   * The defense scenario whose configuration you want to query. For more information, see the **DefenseScene** parameter in [ModifyDefenseSceneConfig](https://help.aliyun.com/document_detail/2968435.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,10 @@ export class DescribeDefenseSceneConfigRequest extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of your WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,11 +36,21 @@ export class DescribeDefenseSceneConfigRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The region of the WAF instance. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeDefenseSceneConfigResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDefenseSceneConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The value of the configuration item. For more information, see the **ConfigValue** parameter in [ModifyDefenseSceneConfig](https://help.aliyun.com/document_detail/2968435.html).
+   * 
    * @example
    * true
    */
   configValue?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */

package/src/models/DescribeDefenseTemplateRequest.ts

@@ -7,7 +7,7 @@ export class DescribeDefenseTemplateRequest 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.
+   * > 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.
    * 
@@ -17,10 +17,11 @@ export class DescribeDefenseTemplateRequest extends $dara.Model {
   instanceId?: 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
@@ -36,7 +37,7 @@ export class DescribeDefenseTemplateRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule template.
+   * The ID of the protection template that you want to query.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeDefenseTemplateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   /**
    * @remarks
-   * The scenario in which the template is used. For more information, see the description of the **DefenseScene** parameter in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The scenario in which the protection template is used. For more information, see the description of the **DefenseScene** parameter in the [CreateDefenseRule](~~CreateDefenseRule~~) operation.
    * 
    * @example
    * waf_group
@@ -13,11 +13,15 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
-   * The sub-scenario in which the template is used. Valid values:
+   * The sub-scenario of the protection template. Valid values:
    * 
-   * *   **web**: The template is a bot management template that is used for website protection.
-   * *   **app**: The template is a bot management template that is used for app protection.
-   * *   **basic**: The template is a bot management template that is used for basic protection.
+   * - **web**: the bot management template for website protection.
+   * 
+   * - **app**: the bot management template for app protection.
+   * 
+   * - **basic**: the basic bot management template.
+   * 
+   * - **bot_custom_acl**: the bot management template for custom protection rules.
    * 
    * @example
    * app
@@ -25,7 +29,7 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   defenseSubScene?: string;
   /**
    * @remarks
-   * The description of the protection rule template.
+   * The description of the protection template.
    * 
    * @example
    * test
@@ -33,7 +37,7 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The most recent time when the protection rule template was modified.
+   * The most recent time the protection template was modified. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1665283642000
@@ -41,7 +45,7 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   gmtModified?: number;
   /**
    * @remarks
-   * The ID of the protection rule template.
+   * The ID of the protection template.
    * 
    * @example
    * 10097
@@ -49,7 +53,7 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   templateId?: number;
   /**
    * @remarks
-   * The name of the protection rule template.
+   * The name of the protection template.
    * 
    * @example
    * test0621
@@ -57,7 +61,7 @@ export class DescribeDefenseTemplateResponseBodyTemplate extends $dara.Model {
   templateName?: string;
   /**
    * @remarks
-   * The origin of the protection rule template. If the value of this parameter is custom, the protection rule template is created by the user.
+   * The origin of the protection template. A value of **custom** indicates that the template is user-defined.
    * 
    * @example
    * custom
@@ -65,10 +69,11 @@ export class DescribeDefenseTemplateResponseBodyTemplate 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.
-   * *   **1:** enabled.
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -76,10 +81,11 @@ export class DescribeDefenseTemplateResponseBodyTemplate 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**: the default template.
    * 
-   * *   **user_default:** default template.
-   * *   **user_custom:** custom template.
+   * - **user_custom**: a custom template.
    * 
    * @example
    * user_default
@@ -133,7 +139,7 @@ export class DescribeDefenseTemplateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The information about the template.
+   * The details of the protection template.
    */
   template?: DescribeDefenseTemplateResponseBodyTemplate;
   static names(): { [key: string]: string } {

package/src/models/DescribeDefenseTemplateValidGroupsRequest.ts

@@ -5,18 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplateValidGroupsRequest extends $dara.Model {
   /**
    * @remarks
-   * The scenario in which the protection template is used.
-   * 
-   * *   **waf_group**: basic protection.
-   * *   **antiscan**: scan protection.
-   * *   **ip_blacklist**: IP address blacklist.
-   * *   **custom_acl**: custom rule.
-   * *   **whitelist**: whitelist.
-   * *   **region_block**: region blacklist.
-   * *   **custom_response**: custom response.
-   * *   **cc**: HTTP flood protection.
-   * *   **tamperproof**: website tamper-proofing.
-   * *   **dlp**: data leakage prevention.
+   * The protection scenario. For more information, see the valid values for the **DefenseScene** parameter in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html) when **DefenseType** is set to **template**.
    * 
    * This parameter is required.
    * 
@@ -26,7 +15,7 @@ export class DescribeDefenseTemplateValidGroupsRequest extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
-   * The name of the protected object group that you want to query.
+   * The name of the protected object group. Use this parameter to filter results by group name.
    * 
    * @example
    * group221
@@ -36,7 +25,7 @@ export class DescribeDefenseTemplateValidGroupsRequest 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.
    * 
@@ -46,7 +35,7 @@ export class DescribeDefenseTemplateValidGroupsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -62,10 +51,11 @@ export class DescribeDefenseTemplateValidGroupsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @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**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeDefenseTemplateValidGroupsResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplateValidGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The names of the protected object groups.
+   * A list of protected object group names.
    */
   groups?: string[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 6EA4B39A-9C0C-5E57-993E-30B6****3AD0

package/src/models/DescribeDefenseTemplateValidResourcesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplateValidResourcesRequest extends $dara.Model {
   /**
    * @remarks
+   * The protection scenario of the protection template. For more information, see the valid values for the **DefenseScene** parameter in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html) when **DefenseType** is set to **template**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,10 @@ export class DescribeDefenseTemplateValidResourcesRequest extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
+   * The ID of the Web Application Firewall (WAF) instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of your WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,31 +26,55 @@ export class DescribeDefenseTemplateValidResourcesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number of the page to return. Default value: **1**.
+   * 
    * @example
    * 2
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: **20**.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @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 that you want to query. You can specify this parameter to filter the results.
+   * 
    * @example
    * mgw.realperson.antdigital.com
    */
   resource?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm2thcppfv6ay
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The ID of the protection template.
+   * 
+   * > If you do not specify this parameter, the protected objects that can be associated with a new protection template for the specified protection scenario (**DefenseScene**) are returned.
+   * 
    * @example
    * 21202
    */

package/src/models/DescribeDefenseTemplateValidResourcesResponseBody.ts

@@ -4,12 +4,22 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDefenseTemplateValidResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C54DD36B-6380-57E5-89BA-2642757C4DB8
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The names of the protected objects that are valid for the protection template.
+   */
   resources?: string[];
   /**
+   * @remarks
+   * The total number of protected objects that match the query criteria.
+   * 
    * @example
    * 34
    */