@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeDefenseTemplatesRequest.ts

@@ -5,18 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplatesRequest 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 description of the **DefenseScene** parameter in the [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html) topic.
    * 
    * @example
    * region_block
@@ -24,11 +13,15 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
-   * The sub-scenario in which the protection template is used. Valid values:
+   * The sub-scenario of the protection template. Valid values:
    * 
-   * *   **web**: bot management for website protection.
-   * *   **app**: bot management for app protection.
-   * *   **basic**: bot management for basic protection.
+   * - **web**: the web protection template for bot management.
+   * 
+   * - **app**: the app protection template for bot management.
+   * 
+   * - **basic**: the basic protection template for bot management.
+   * 
+   * - **bot_custom_acl**: the advanced custom protection rule template for bot management.
    * 
    * @example
    * basic
@@ -36,7 +29,7 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   defenseSubScene?: 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.
    * 
@@ -48,7 +41,7 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -56,7 +49,7 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **20**.
+   * The number of entries to return on each page. Default value: **20**.
    * 
    * @example
    * 10
@@ -64,10 +57,11 @@ export class DescribeDefenseTemplatesRequest 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
@@ -75,17 +69,17 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the protected object or protected object group.
+   * The name of the protected object or protected object group, or the ID of the protected asset.
    * 
-   * >  If you specify ResourceType, you must specify this parameter.
+   * > You must specify the Resource and ResourceType parameters to filter query results.
    * 
    * @example
-   * xxxqiu.cc-ecs
+   * ruiqiu.cc-ecs
    */
   resource?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmvyknl****fa
@@ -95,10 +89,13 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
    * @remarks
    * The type of the protected resource. Valid values:
    * 
-   * *   **single**: protected object. This is the default value.
-   * *   **group**: protected object group.
+   * - **single** (default): a protected object.
    * 
-   * >  If you specify Resource, you must specify this parameter.
+   * - **group**: a protected object group.
+   * 
+   * - **asset**: a protected asset.
+   * 
+   * > You must specify the Resource and ResourceType parameters to filter query results.
    * 
    * @example
    * single
@@ -109,12 +106,12 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
    * The ID of the protection template.
    * 
    * @example
-   * 12345
+   * 39395
    */
   templateId?: number;
   /**
    * @remarks
-   * The IDs of the protection templates that you want to query. Separate multiple template IDs with commas (,).
+   * The IDs of the protection templates that you want to query. You can specify this parameter to query the protected objects for which multiple protection templates take effect. Separate multiple template IDs with commas (,).
    * 
    * @example
    * 189731,189539,189538,189531,189540,189542,189541
@@ -122,18 +119,19 @@ export class DescribeDefenseTemplatesRequest extends $dara.Model {
   templateIds?: string;
   /**
    * @remarks
-   * The name of the protection template.
+   * The name of the protection template to query.
    * 
    * @example
-   * testTemplateName
+   * test
    */
   templateName?: string;
   /**
    * @remarks
-   * The type of the protection template. Valid values:
+   * The type of the protection template that you want to create. Valid values:
+   * 
+   * - **user_default**: default protection template.
    * 
-   * *   **user_default**: default template.
-   * *   **user_custom**: custom template.
+   * - **user_custom**: custom protection template.
    * 
    * @example
    * user_default

package/src/models/DescribeDefenseTemplatesResponseBody.ts

@@ -5,18 +5,29 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseTemplatesResponseBodyTemplates 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. Valid values:
+   * 
+   * - **waf_group**: Basic Protection.
+   * 
+   * - **antiscan**: Scan Protection.
+   * 
+   * - **ip_blacklist**: IP Blocklist.
+   * 
+   * - **custom_acl**: Custom Rule.
+   * 
+   * - **whitelist**: Allowlist.
+   * 
+   * - **region_block**: Geographic Blocking.
+   * 
+   * - **custom_response**: Custom Response.
+   * 
+   * - **cc**: HTTP Flood Protection.
+   * 
+   * - **tamperproof**: Webpage Tamper Protection.
+   * 
+   * - **dlp**: Data Loss Prevention.
+   * 
+   * - **bot_manager**: Bot Management.
    * 
    * @example
    * whitelist
@@ -24,11 +35,15 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
-   * The sub-scenario in which the protection template is used. Valid values:
+   * The sub-scenario for the Bot Management template. This parameter is returned only when `DefenseScene` is set to `bot_manager`. Valid values:
+   * 
+   * - **web**: web protection
    * 
-   * *   **web**: bot management for website protection.
-   * *   **app**: bot management for app protection.
-   * *   **basic**: bot management for basic protection.
+   * - **app**: app protection
+   * 
+   * - **basic**: basic protection
+   * 
+   * - **bot_custom_acl**: The protection template for advanced Custom Rules in Bot Management.
    * 
    * @example
    * basic
@@ -36,15 +51,15 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
   defenseSubScene?: string;
   /**
    * @remarks
-   * The description of the protection template.
+   * The description of the template.
    * 
    * @example
-   * test
+   * testTemplate
    */
   description?: string;
   /**
    * @remarks
-   * The time when the protection template was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * The last modification time of the protection template. This value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1683776070000
@@ -55,7 +70,7 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
    * The ID of the protection template.
    * 
    * @example
-   * 12345
+   * 56477
    */
   templateId?: number;
   /**
@@ -63,12 +78,12 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
    * The name of the protection template.
    * 
    * @example
-   * testTemplateName
+   * template-blockarea1
    */
   templateName?: string;
   /**
    * @remarks
-   * The origin of the protection template. The value custom indicates that the protection template is a custom template created by the user.
+   * The origin of the protection template to be created. The value is custom, which indicates a user-defined template.
    * 
    * @example
    * custom
@@ -78,8 +93,9 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
    * @remarks
    * The status of the protection template. Valid values:
    * 
-   * *   **0**: disabled.
-   * *   **1**: enabled.
+   * - **0**: Disabled.
+   * 
+   * - **1**: Enabled.
    * 
    * @example
    * 1
@@ -89,8 +105,9 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
    * @remarks
    * The type of the protection template. Valid values:
    * 
-   * *   **user_default**: default template.
-   * *   **user_custom**: custom template.
+   * - **user_default**: The user\\"s default protection template.
+   * 
+   * - **user_custom**: A custom protection template defined by the user.
    * 
    * @example
    * user_custom
@@ -136,20 +153,20 @@ export class DescribeDefenseTemplatesResponseBodyTemplates extends $dara.Model {
 export class DescribeDefenseTemplatesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
-   * 4F26D2F1-E288-5104-8518-05E240E3****
+   * 4F26D2F1-E288-5104-8518-05E240E337A4
    */
   requestId?: string;
   /**
    * @remarks
-   * The protection templates.
+   * An array of protection templates.
    */
   templates?: DescribeDefenseTemplatesResponseBodyTemplates[];
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of protection templates returned.
    * 
    * @example
    * 100

package/src/models/DescribeDomainDetailRequest.ts

@@ -5,18 +5,24 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDomainDetailRequest extends $dara.Model {
   /**
    * @remarks
-   * The domain name that you want to query.
+   * The domain name to query.
    * 
    * @example
    * www.aliyundoc.com
    */
   domain?: string;
+  /**
+   * @remarks
+   * The domain name ID.
+   * 
+   * @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.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -26,10 +32,11 @@ export class DescribeDomainDetailRequest 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**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou