@alicloud/waf-openapi20211001 6.5.2 → 6.6.1

package/src/models/DescribeDefenseResourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseResourceResponseBodyResourceResponseHeaders extends $dara.Model {
   /**
    * @remarks
-   * Specifies the key for a custom response header.
+   * The key of the custom response header.
    * 
    * @example
    * Header-Key
@@ -13,7 +13,7 @@ export class DescribeDefenseResourceResponseBodyResourceResponseHeaders extends
   key?: string;
   /**
    * @remarks
-   * Specifies the value for a custom response header.
+   * The value of the custom response header.
    * 
    * @example
    * Header-Value
@@ -45,10 +45,11 @@ export class DescribeDefenseResourceResponseBodyResourceResponseHeaders extends
 export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   /**
    * @remarks
-   * The status of the tracking cookie.
+   * Indicates whether the tracking cookie feature is enabled. Valid values:
    * 
-   * *   **0**: disabled.
-   * *   **1**: enabled.
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -56,10 +57,11 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   acwCookieStatus?: number;
   /**
    * @remarks
-   * The status of the secure attribute of the tracking cookie.
+   * Indicates whether the secure attribute of the tracking cookie is enabled. Valid values:
+   * 
+   * - **0**: disabled.
    * 
-   * *   **0**: disabled.
-   * *   **1**: enabled.
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -67,10 +69,11 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   acwSecureStatus?: number;
   /**
    * @remarks
-   * The status of the secure attribute of the slider CAPTCHA cookie.
+   * Indicates whether the secure attribute of the slider CAPTCHA cookie is enabled. Valid values:
+   * 
+   * - **0**: disabled.
    * 
-   * *   **0**: disabled.
-   * *   **1**: enabled.
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -78,9 +81,9 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   acwV3SecureStatus?: number;
   /**
    * @remarks
-   * The custom header fields.
+   * The list of custom header fields used to identify the actual client IP address.
    * 
-   * >  If the value of XffStatus is 1, the first IP address in the specified header field is used as the originating IP address of the client to prevent X-Forwarded-For (XFF) forgery. If you specify multiple header fields, WAF reads the values of the header fields in sequence until the originating IP address is obtained. If the originating IP address cannot be obtained, the first IP address in the XFF header field is used as the originating IP address of the client.
+   * > This parameter takes effect only when XffStatus is set to 1. WAF uses the first IP address in the specified header fields as the client source IP address to prevent X-Forwarded-For (XFF) spoofing. If multiple headers are specified, WAF checks them in order. If the first header does not contain a source IP address, WAF checks the next header. If none of the specified headers contain a source IP address, WAF uses the first IP address in the X-Forwarded-For header.
    */
   customHeaders?: string[];
   /**
@@ -93,7 +96,7 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The details of the protected object. Different key-value pairs indicate different attributes of the protected object.
+   * The details of the protected object. The fields vary based on the cloud service type.
    * 
    * @example
    * {
@@ -104,7 +107,7 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   detail?: { [key: string]: any };
   /**
    * @remarks
-   * The time when the protected object was created. Unit: milliseconds.
+   * The time when the protected object was created. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1607493144000
@@ -112,16 +115,23 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   gmtCreate?: number;
   /**
    * @remarks
-   * The time when the protected object was modified. Unit: milliseconds.
+   * The time when the protected object was modified. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1691720010000
    */
   gmtModified?: number;
+  /**
+   * @remarks
+   * The ID of the WAF instance.
+   * 
+   * @example
+   * waf_v2_public_cn-wwo****
+   */
   instanceId?: string;
   /**
    * @remarks
-   * The user ID (UID) of the Alibaba Cloud account to which the protected object belongs.
+   * The ID of the Alibaba Cloud account to which the protected object belongs.
    * 
    * @example
    * 170457******9107
@@ -129,7 +139,7 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   ownerUserId?: string;
   /**
    * @remarks
-   * The pattern used for the protected object.
+   * The protection pattern of the protected object.
    * 
    * @example
    * domain
@@ -137,7 +147,7 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   pattern?: string;
   /**
    * @remarks
-   * The name of the cloud service.
+   * The type of cloud service to which the protected object belongs.
    * 
    * @example
    * alb
@@ -171,8 +181,9 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
    * @remarks
    * The origin of the protected object. Valid values:
    * 
-   * *   **custom**
-   * *   **access**
+   * - **custom**: The protected object is created through provisioning.
+   * 
+   * - **access**: The protected object is user-defined.
    * 
    * @example
    * custom
@@ -180,15 +191,16 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
   resourceOrigin?: string;
   /**
    * @remarks
-   * The response header.
+   * The custom response headers configured for the protected object.
    */
   responseHeaders?: DescribeDefenseResourceResponseBodyResourceResponseHeaders[];
   /**
    * @remarks
-   * Indicates whether a Layer 7 proxy is deployed in front of WAF, such as Anti-DDoS Proxy and Alibaba Cloud CDN. Valid values:
+   * Indicates whether a Layer 7 proxy such as Anti-DDoS or CDN is enabled in front of WAF. Valid values:
+   * 
+   * - **0**: disabled.
    * 
-   * *   **0**: No Layer 7 proxy is deployed.
-   * *   **1**: A Layer 7 proxy is deployed.
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -261,7 +273,7 @@ export class DescribeDefenseResourceResponseBodyResource extends $dara.Model {
 export class DescribeDefenseResourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 439AADF2-368C-5E98-B14E-3086****0573
@@ -269,7 +281,7 @@ export class DescribeDefenseResourceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The protected object.
+   * The details of the protected object.
    */
   resource?: DescribeDefenseResourceResponseBodyResource;
   static names(): { [key: string]: string } {

package/src/models/DescribeDefenseResourceTemplatesRequest.ts

@@ -7,7 +7,7 @@ export class DescribeDefenseResourceTemplatesRequest 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to obtain the instance ID.
    * 
    * This parameter is required.
    * 
@@ -17,10 +17,11 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region of the WAF instance. 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
@@ -28,12 +29,12 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the protected object or protected object group that you want to query.
+   * The name of the protected object or protected object group, or the ID of the protected asset to query.
    * 
    * This parameter is required.
    * 
    * @example
-   * xxxxxhemicals.cn-waf
+   * mitsuichemicals.cn-waf
    */
   resource?: string;
   /**
@@ -46,10 +47,13 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The type of the protected resource. Valid values:
+   * The type of protected resource. Valid values:
+   * 
+   * - **single** (default): A protected object.
    * 
-   * *   **single**: protected object. This is the default value.
-   * *   **group**: protected object group.
+   * - **group**: A protected object group.
+   * 
+   * - **asset**: A protected asset.
    * 
    * @example
    * single
@@ -65,7 +69,7 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * The name of the rule.
+   * The name of the protection rule.
    * 
    * @example
    * demoRuleName
@@ -73,10 +77,11 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The type of the protection rule. Valid values:
+   * The type of protection rule. Valid values:
+   * 
+   * - **defense** (default): A protection rule.
    * 
-   * *   **defense**: defense rule. This is the default value.
-   * *   **whitelist**: whitelist rule.
+   * - **whitelist**: A whitelist rule.
    * 
    * @example
    * whitelist
@@ -84,7 +89,7 @@ export class DescribeDefenseResourceTemplatesRequest extends $dara.Model {
   ruleType?: string;
   /**
    * @remarks
-   * The name of the protection rule template.
+   * The name of the protection template to query.
    * 
    * @example
    * test221

package/src/models/DescribeDefenseResourceTemplatesResponseBody.ts

@@ -5,18 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseResourceTemplatesResponseBodyTemplates 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 **DefenseScene** parameter in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
    * 
    * @example
    * whitelist
@@ -24,11 +13,13 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
   defenseScene?: string;
   /**
    * @remarks
-   * The sub-scenario in which the template is used. Valid values:
+   * The sub-scenario of the template. Valid values:
    * 
-   * *   **web**: bot management for website protection.
-   * *   **app**: bot management for app protection.
-   * *   **basic**: bot management for basic protection.
+   * - **web**: The bot management template for web protection.
+   * 
+   * - **app**: The bot management template for app protection.
+   * 
+   * - **basic**: The basic bot management template.
    * 
    * @example
    * basic
@@ -36,15 +27,15 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
   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 time when the protection template was created, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1692930539000
@@ -55,7 +46,7 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
    * The ID of the protection template.
    * 
    * @example
-   * 12345
+   * 34328
    */
   templateId?: number;
   /**
@@ -63,12 +54,12 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
    * The name of the protection template.
    * 
    * @example
-   * TestTemplateName
+   * antiscanTemplate
    */
   templateName?: string;
   /**
    * @remarks
-   * The origin of the protection template. The value custom indicates that the template is a custom template created by the user.
+   * The origin of the protection template. The value custom indicates a user-created template.
    * 
    * @example
    * custom
@@ -78,8 +69,9 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
    * @remarks
    * The status of the protection template. Valid values:
    * 
-   * *   **0**: disabled.
-   * *   **1**: enabled.
+   * - **0**: Disabled.
+   * 
+   * - **1**: Enabled.
    * 
    * @example
    * 1
@@ -87,10 +79,11 @@ export class DescribeDefenseResourceTemplatesResponseBodyTemplates extends $dara
   templateStatus?: number;
   /**
    * @remarks
-   * The type of the protection template. Valid values:
+   * The type of the template. Valid values:
+   * 
+   * - **user_default**: The default template for the user.
    * 
-   * *   **user_default**: default template.
-   * *   **user_custom**: custom template.
+   * - **user_custom**: A custom template created by the user.
    * 
    * @example
    * user_custom
@@ -139,7 +132,7 @@ export class DescribeDefenseResourceTemplatesResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 2305CEB0-BA5A-5543-A1D3-3F1D0891****
+   * 2305CEB0-BA5A-5543-A1D3-3F1D08911B1C
    */
   requestId?: string;
   /**

package/src/models/DescribeDefenseResourcesRequest.ts

@@ -47,7 +47,7 @@ export class DescribeDefenseResourcesRequest 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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * @example
    * waf_cdnsdf3****
@@ -55,7 +55,7 @@ export class DescribeDefenseResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number of the paginated results Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -63,7 +63,7 @@ export class DescribeDefenseResourcesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of results per page. Default value: **10**.
+   * The number of entries to return on each page. Default value: **10**.
    * 
    * @example
    * 10
@@ -71,9 +71,9 @@ export class DescribeDefenseResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The query conditions. Specify the value of this parameter as a string in the JSON format.
+   * The query conditions. This parameter is a JSON string.
    * 
-   * >  The results vary based on the query condition. For more information, see the "**Query parameters**" section in this topic.
+   * > The query results vary based on the query conditions. For more information, see **Query parameter details**.
    * 
    * @example
    * {\\"product\\":\\"waf\\"}
@@ -81,10 +81,11 @@ export class DescribeDefenseResourcesRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * 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
@@ -100,7 +101,7 @@ export class DescribeDefenseResourcesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The tag of the resource. You can specify up to 20 tags.
+   * A list of resource tags. You can specify up to 20 tags.
    */
   tag?: DescribeDefenseResourcesRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/DescribeDefenseResourcesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDefenseResourcesResponseBodyResourcesResponseHeaders extends $dara.Model {
   /**
    * @remarks
-   * Specifies the key for a custom response header.
+   * The key of the custom response header.
    * 
    * @example
    * Header-Key
@@ -13,7 +13,7 @@ export class DescribeDefenseResourcesResponseBodyResourcesResponseHeaders extend
   key?: string;
   /**
    * @remarks
-   * Specifies the value for a custom response header.
+   * The value of the custom response header.
    * 
    * @example
    * Header-Value
@@ -45,10 +45,11 @@ export class DescribeDefenseResourcesResponseBodyResourcesResponseHeaders extend
 export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   /**
    * @remarks
-   * The status of the tracking cookie.
+   * Indicates whether the tracking cookie feature is enabled.
    * 
-   * *   **0**: disabled
-   * *   **1**: enabled. This is the default value.
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -56,10 +57,11 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   acwCookieStatus?: number;
   /**
    * @remarks
-   * The status of the secure attribute of the tracking cookie.
+   * Indicates whether the secure attribute of the tracking cookie is enabled.
+   * 
+   * - **0**: disabled.
    * 
-   * *   **0**: disabled. This is the default value.
-   * *   **1**: enabled.
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -67,10 +69,11 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   acwSecureStatus?: number;
   /**
    * @remarks
-   * The status of the secure attribute of the slider CAPTCHA cookie.
+   * Indicates whether the secure attribute of the slider CAPTCHA cookie is enabled.
+   * 
+   * - **0**: disabled.
    * 
-   * *   **0**: disabled. This is the default value.
-   * *   **1**: enabled.
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -78,7 +81,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   acwV3SecureStatus?: number;
   /**
    * @remarks
-   * The custom header fields that are used to identify the originating IP addresses of clients. If the value of XffStatus is 1 and CustomHeaders is left empty, the first IP addresses in the XFF header fields are used as the originating IP addresses of clients.
+   * The custom XFF header that is used to obtain the real IP address of a client. If \\`XffStatus\\` is set to 1 and this parameter is left empty, the first IP address in the XFF header is used as the client IP address.
    */
   customHeaders?: string[];
   /**
@@ -91,12 +94,15 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The description of the protected object. Different key-value pairs in a map indicate different properties of the protected object.
+   * The details of the protected object. The key-value pairs vary by product type.
+   * 
+   * @example
+   * {"domain":"eou.eleme.cn","uri":"/"}
    */
   detail?: { [key: string]: any };
   /**
    * @remarks
-   * The creation time of the protected object. Unit: seconds.
+   * The time when the protected object was created. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1652149203187
@@ -104,16 +110,23 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   gmtCreate?: number;
   /**
    * @remarks
-   * The most recent modification time of the protected object. Unit: seconds.
+   * The time when the protected object was modified. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1665633032000
    */
   gmtModified?: number;
+  /**
+   * @remarks
+   * The ID of the WAF instance.
+   * 
+   * @example
+   * waf_v2_public_cn-k*****
+   */
   instanceId?: string;
   /**
    * @remarks
-   * The Alibaba Cloud account to which the protected object belongs. You can specify this parameter to query protected objects that belong to a specific Alibaba Cloud account. Exact match is supported.
+   * The account to which the asset of the protected object belongs. This parameter is returned in a multi-account management scenario.
    * 
    * @example
    * 135*********46
@@ -121,7 +134,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   ownerUserId?: string;
   /**
    * @remarks
-   * The protection pattern.
+   * The protection mode of the protected object.
    * 
    * @example
    * domain
@@ -129,7 +142,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   pattern?: string;
   /**
    * @remarks
-   * The name of the cloud service.
+   * The type of cloud service to which the protected object belongs.
    * 
    * @example
    * alb
@@ -145,7 +158,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   resource?: string;
   /**
    * @remarks
-   * The name of the protected object group to which the protected object belongs.
+   * The name of the protected object group to which the protected object is added.
    * 
    * @example
    * test
@@ -153,7 +166,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   resourceGroup?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -161,7 +174,7 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The origin of the protected object.
+   * The source of the protected object.
    * 
    * @example
    * custom
@@ -169,12 +182,12 @@ export class DescribeDefenseResourcesResponseBodyResources extends $dara.Model {
   resourceOrigin?: string;
   /**
    * @remarks
-   * The response header.
+   * The custom response headers configured for the protected object.
    */
   responseHeaders?: DescribeDefenseResourcesResponseBodyResourcesResponseHeaders[];
   /**
    * @remarks
-   * Indicates whether the X-Forwarded-For (XFF) header is used.
+   * Indicates whether the X-Forwarded-For (XFF) proxy is enabled for the protected object.
    * 
    * @example
    * 1
@@ -250,17 +263,17 @@ export class DescribeDefenseResourcesResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 618F2626-DB27-5187-8C6C-4E61A491DF29
+   * 618F2626-DB27-5187-8C6C-4E61A491****
    */
   requestId?: string;
   /**
    * @remarks
-   * The protected objects.
+   * The list of protected objects.
    */
   resources?: DescribeDefenseResourcesResponseBodyResources[];
   /**
    * @remarks
-   * The total number of entries that are returned.
+   * The total number of returned entries.
    * 
    * @example
    * 73