@alicloud/waf-openapi20211001 6.6.1 → 6.7.0

package/src/models/DescribeDefenseRuleRequest.ts

@@ -3,25 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDefenseRuleRequest extends $dara.Model {
-  /**
-   * @remarks
-   * The type of the protection rule. Valid values:
-   * 
-   * - **template** (default): a protection rule template.
-   * 
-   * - **resource**: a rule for a protected object.
-   * 
-   * - **global**: a global rule.
-   * 
-   * @example
-   * template
-   */
   defenseType?: 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 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.
    * 
@@ -31,29 +18,19 @@ export class DescribeDefenseRuleRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region of the WAF instance. Valid values:
    * 
-   * - **cn-hangzhou**: the Chinese mainland.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: Outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
-  /**
-   * @remarks
-   * The protected object to which the protection rule applies.
-   * 
-   * > This parameter is required only when **DefenseType** is set to **resource**.
-   * 
-   * @example
-   * rencs***-waf
-   */
   resource?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -61,7 +38,7 @@ export class DescribeDefenseRuleRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule.
+   * The ID of the protection rule that you want to query.
    * 
    * This parameter is required.
    * 
@@ -71,9 +48,7 @@ export class DescribeDefenseRuleRequest extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * The ID of the protection rule template.
-   * 
-   * > This parameter is required only when **DefenseType** is set to **template**.
+   * The ID of the protection rule template to which the protection rule that you want to query belongs.
    * 
    * @example
    * 10318

package/src/models/DescribeDefenseRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
   /**
    * @remarks
-   * The configuration of the protection rule, returned as a JSON string. For more information, see the **Protection rule parameters** section in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
+   * The details of the protection rule. The value is a JSON string that contains multiple parameters. For more information, see the "**Protection rule parameters**" section of the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
    * 
    * @example
    * {\\"status\\":1,\\"policyId\\":1012,\\"action\\":\\"block\\"}
@@ -13,11 +13,10 @@ export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * The origin of the protection rule. This parameter indicates whether the rule was created by the user or by the system. Valid values:
+   * The origin of the protection rule. Valid values:
    * 
-   * - **custom**: a custom rule.
-   * 
-   * - **system**: a system-generated rule.
+   * *   **custom:** The protection rule is created by the user.
+   * *   **system:** The protection rule is automatically generated by the system.
    * 
    * @example
    * custom
@@ -25,91 +24,21 @@ export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
   defenseOrigin?: string;
   /**
    * @remarks
-   * The scenario to which the protection rule applies.
-   * 
-   * If the **DefenseType** parameter is set to **template**, the valid values are:
-   * 
-   * - **waf_group**: basic protection with regular expression rules.
-   * 
-   * - **waf_base**: web core protection.
-   * 
-   * - **waf_base_compliance**: basic protection with protocol compliance rules.
-   * 
-   * - **waf_base_sema**: basic protection with semantic analysis rules.
-   * 
-   * - **cc**: HTTP flood protection.
-   * 
-   * - **antiscan_dirscan**: directory traversal blocking in scan protection.
-   * 
-   * - **antiscan_highfreq**: high-frequency scan blocking in scan protection.
-   * 
-   * - **antiscan_scantools**: scanning tool blocking in scan protection.
-   * 
-   * - **ip_blacklist**: an IP address blacklist.
-   * 
-   * - **custom_acl**: a custom rule.
-   * 
-   * - **region_block**: a location blacklist.
-   * 
-   * - **tamperproof**: webpage tamper protection.
-   * 
-   * - **dlp**: data leakage prevention.
-   * 
-   * - **custom_response_block**: a custom response.
-   * 
-   * - **spike_throttle**: peak traffic throttling.
-   * 
-   * If the **DefenseType** parameter is set to **resource**, the valid values are:
-   * 
-   * - **account_identifier**: account identification.
-   * 
-   * - **custom_response**: a custom response.
-   * 
-   * - **waf_codec**: data decoding settings.
-   * 
-   * If the **DefenseType** parameter is set to **global**, the valid values are:
-   * 
-   * - **regular_custom**: a custom regular expression.
-   * 
-   * - **address_book**: an IP address book.
-   * 
-   * - **custom_response**: a custom response.
+   * The scenario in which the protection rule is used. For more information, see the description of **DefenseScene** in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
    * 
    * @example
    * waf_group
    */
   defenseScene?: string;
-  /**
-   * @remarks
-   * The type of the protection rule. Valid values:
-   * 
-   * - **template** (default): a protection rule template.
-   * 
-   * - **resource**: a rule for a protected object.
-   * 
-   * - **global**: a global rule.
-   * 
-   * @example
-   * template
-   */
   defenseType?: string;
   /**
    * @remarks
-   * The time when the protection rule was modified. This value is a UNIX timestamp. Unit: milliseconds.
+   * The most recent time when the protection rule was modified.
    * 
    * @example
    * 1665196746000
    */
   gmtModified?: number;
-  /**
-   * @remarks
-   * The protected object to which the protection rule applies.
-   * 
-   * > This parameter is returned only if the **DefenseType** parameter is set to **resource**.
-   * 
-   * @example
-   * rencs***-waf
-   */
   resource?: string;
   /**
    * @remarks
@@ -131,9 +60,8 @@ export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
    * @remarks
    * The status of the protection rule. Valid values:
    * 
-   * - **0**: disabled.
-   * 
-   * - **1**: enabled.
+   * *   **0:** disabled.
+   * *   **1:** enabled.
    * 
    * @example
    * 1
@@ -143,8 +71,6 @@ export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
    * @remarks
    * The ID of the protection rule template.
    * 
-   * > This parameter is returned only if the **DefenseType** parameter is set to **template**.
-   * 
    * @example
    * 9114
    */
@@ -191,7 +117,7 @@ export class DescribeDefenseRuleResponseBodyRule extends $dara.Model {
 export class DescribeDefenseRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
@@ -199,7 +125,7 @@ export class DescribeDefenseRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The details of the protection rule.
+   * The configurations of the protection rule. The value is a JSON string that contains multiple parameters.
    */
   rule?: DescribeDefenseRuleResponseBodyRule;
   static names(): { [key: string]: string } {

package/src/models/DescribeDefenseRuleStatisticsRequest.ts

@@ -4,19 +4,12 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDefenseRuleStatisticsRequest extends $dara.Model {
   /**
-   * @remarks
-   * The quaternary condition by which to group the rule statistics. This value cannot be the same as the primary, secondary, or tertiary condition.
-   * 
    * @example
    * riskLevel
    */
   fourthKey?: string;
   /**
    * @remarks
-   * 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.
    * 
    * @example
@@ -25,8 +18,6 @@ export class DescribeDefenseRuleStatisticsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The primary condition by which to group the rule statistics.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -34,37 +25,22 @@ export class DescribeDefenseRuleStatisticsRequest extends $dara.Model {
    */
   primaryKey?: 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
    */
   resourceManagerResourceGroupId?: string;
   /**
-   * @remarks
-   * The secondary condition by which to group the rule statistics. This value cannot be the same as the primary condition.
-   * 
    * @example
    * action
    */
   secondaryKey?: string;
   /**
    * @remarks
-   * The ID of the protection template.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -72,9 +48,6 @@ export class DescribeDefenseRuleStatisticsRequest extends $dara.Model {
    */
   templateId?: number;
   /**
-   * @remarks
-   * The tertiary condition by which to group the rule statistics. This value cannot be the same as the primary or secondary condition.
-   * 
    * @example
    * status
    */

package/src/models/DescribeDefenseRuleStatisticsResponseBody.ts

@@ -4,41 +4,26 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDefenseRuleStatisticsResponseBodyStatisticsInfos extends $dara.Model {
   /**
-   * @remarks
-   * The number of rules that match the specified grouping conditions.
-   * 
    * @example
    * 27
    */
   count?: number;
   /**
-   * @remarks
-   * The value of the quaternary grouping condition.
-   * 
    * @example
    * action
    */
   fourthValue?: string;
   /**
-   * @remarks
-   * The value of the primary grouping condition.
-   * 
    * @example
    * sytem
    */
   primaryValue?: string;
   /**
-   * @remarks
-   * The value of the secondary grouping condition.
-   * 
    * @example
    * block
    */
   secondaryValue?: string;
   /**
-   * @remarks
-   * The value of the tertiary grouping condition.
-   * 
    * @example
    * 1
    */
@@ -74,17 +59,10 @@ export class DescribeDefenseRuleStatisticsResponseBodyStatisticsInfos extends $d
 
 export class DescribeDefenseRuleStatisticsResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The rule statistics that are grouped by the specified conditions.
-   */
   statisticsInfos?: DescribeDefenseRuleStatisticsResponseBodyStatisticsInfos[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeDefenseRulesRequest.ts

@@ -3,25 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDefenseRulesRequest extends $dara.Model {
-  /**
-   * @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
    * 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 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.
    * 
@@ -31,7 +18,7 @@ export class DescribeDefenseRulesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The number of the page to return. Default value: **1**.
+   * The page number. Default value: **1**.
    * 
    * @example
    * 1
@@ -39,7 +26,7 @@ export class DescribeDefenseRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: **10**.
+   * The number of entries per page. Default value: **10**.
    * 
    * @example
    * 10
@@ -47,21 +34,20 @@ export class DescribeDefenseRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The query conditions. Specify this parameter as a JSON string.
+   * The query conditions. Specify a string that contains multiple parameters in the JSON format.
    * 
-   * > The query results for protection rules vary based on the query conditions. For more information, see **Query parameter details**.
+   * >  The results vary based on the query conditions. For more information, see the "**Query parameters**" section in this topic.
    * 
    * @example
-   * {\\"name\\":\\"IPblock_20220822_10\\",\\"scene\\":\\"custom_acl\\",\\"templateId\\":5327}
+   * {\\\\"name\\\\":\\\\"IP address blocking_20220822_10\\\\",\\\\"scene\\\\":\\\\"custom_acl\\\\",\\\\"templateId\\\\":5327}
    */
   query?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
+   * The region ID of the WAF instance. Valid values:
    * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -69,7 +55,7 @@ export class DescribeDefenseRulesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -77,13 +63,10 @@ export class DescribeDefenseRulesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The type of the protection rule. Valid values:
-   * 
-   * - **whitelist**: a whitelist rule
-   * 
-   * - **defense** (default): a protection rule
+   * The type of protection rule that you want to query. Valid values:
    * 
-   * > This parameter is required only when **DefenseType** is set to **template**.
+   * *   **whitelist:** whitelist rule.
+   * *   **defense:** defense rule. This is the default value.
    * 
    * @example
    * whitelist