@alicloud/waf-openapi20211001 6.5.2 → 6.6.1

package/src/models/DescribeInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   /**
    * @remarks
-   * The maximum number of IP addresses that can be added to the match content of a match condition. For more information, see [Match conditions](https://help.aliyun.com/document_detail/374354.html).
+   * The maximum number of IP addresses that can be added to the match content. For more information about match content, see [Match conditions](https://help.aliyun.com/document_detail/374354.html).
    * 
    * @example
    * 100
@@ -13,10 +13,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   aclRuleMaxIpCount?: number;
   /**
    * @remarks
-   * Indicates whether the scan protection module is supported. Valid values:
+   * Indicates whether scan protection is supported. Valid values:
    * 
-   * *   **true:** The scan protection module is supported.
-   * *   **false:** The scan protection module is not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -24,7 +25,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   antiScan?: boolean;
   /**
    * @remarks
-   * The maximum number of scan protection rule templates that can be configured.
+   * The maximum number of scan protection templates that can be configured.
    * 
    * @example
    * 20
@@ -40,10 +41,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   backendMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the basic protection rule module is supported. Valid values:
+   * Indicates whether basic protection rules are supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The basic protection rule module is supported.
-   * *   **false:** The basic protection rule module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -51,7 +53,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   baseWafGroup?: boolean;
   /**
    * @remarks
-   * The maximum number of protection rules that can be included in a basic protection rule template.
+   * The maximum number of protection rules that can be included in a single basic protection rule template.
    * 
    * @example
    * 100
@@ -67,10 +69,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   baseWafGroupRuleTemplateMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the bot management module is supported. Valid values:
+   * Indicates whether bot management is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The bot management module is supported.
-   * *   **false:** The bot management module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -78,10 +81,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   bot?: boolean;
   /**
    * @remarks
-   * Indicates whether bot management for app protection is supported. Valid values:
+   * Indicates whether scenario-specific bot protection for apps is supported. Valid values:
    * 
-   * *   **true:** Bot management for app protection is supported.
-   * *   **false:** Bot management for app protection is not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -89,7 +93,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   botApp?: string;
   /**
    * @remarks
-   * The maximum number of bot management rule templates that can be configured.
+   * The maximum number of bot management protection templates that can be configured.
    * 
    * @example
    * 50
@@ -97,10 +101,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   botTemplateMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether bot management for website protection is supported. Valid values:
+   * Indicates whether scenario-specific bot protection for websites is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** Bot management for website protection is supported.
-   * *   **false:** Bot management for website protection is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -116,10 +121,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   cnameResourceMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the custom response module is supported. Valid values:
+   * Indicates whether custom responses are supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The custom response module is supported.
-   * *   **false:** The custom response module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -127,7 +133,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customResponse?: boolean;
   /**
    * @remarks
-   * The maximum number of rules that can be included in a custom response rule template.
+   * The maximum number of protection rules that can be included in a single custom response template.
    * 
    * @example
    * 100
@@ -135,7 +141,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customResponseRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of custom response rule templates that can be configured.
+   * The maximum number of custom response templates that can be configured.
    * 
    * @example
    * 20
@@ -143,10 +149,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customResponseTemplateMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the custom rule module is supported. Valid values:
+   * Indicates whether custom rules are supported. Valid values:
    * 
-   * *   **true:** The custom rule module is supported.
-   * *   **false:** The custom rule module is not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -154,7 +161,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customRule?: boolean;
   /**
    * @remarks
-   * The action that can be included in a custom rule.
+   * The action string for the custom rule.
    * 
    * @example
    * block
@@ -162,7 +169,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customRuleAction?: string;
   /**
    * @remarks
-   * The match conditions that can be used in a custom rule. For more information, see **Match condition parameters** in the "**Parameters of custom rules (custom_acl)**" section in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The match condition for the custom rule. For more information, see the description of the **conditions** parameter for **custom_acl** rules in CreateDefenseRule.
    * 
    * @example
    * URL
@@ -170,7 +177,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customRuleCondition?: string;
   /**
    * @remarks
-   * The maximum number of rules that can be included in a custom rule template.
+   * The maximum number of protection rules that can be included in a single custom rule template.
    * 
    * @example
    * 100
@@ -178,7 +185,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The statistical object for rate limiting in a custom rule.
+   * The rate limiting object for the custom rule.
    * 
    * @example
    * header
@@ -194,7 +201,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   customRuleTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of protected object groups that can be configured.
+   * The maximum number of protection groups that can be configured.
    * 
    * @example
    * 100
@@ -202,7 +209,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   defenseGroupMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of protected objects that can be included in a protected object group.
+   * The maximum number of protected objects that can be included in a protection group.
    * 
    * @example
    * 100
@@ -210,7 +217,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   defenseObjectInGroupMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of protected objects to which a protection rule template can be applied.
+   * The maximum number of protected objects that can be associated with a template.
    * 
    * @example
    * 100
@@ -226,10 +233,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   defenseObjectMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the data leakage prevention module is supported. Valid values:
+   * Indicates whether data leak prevention is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The data leakage prevention module is supported.
-   * *   **false:** The data leakage prevention module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -237,7 +245,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   dlp?: boolean;
   /**
    * @remarks
-   * The maximum number of rules that can be included in a data leakage prevention rule template.
+   * The maximum number of protection rules that can be included in a single data leak prevention template.
    * 
    * @example
    * 50
@@ -245,13 +253,18 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   dlpRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of data leakage prevention rule templates that can be configured.
+   * The maximum number of data leak prevention templates that can be configured.
    * 
    * @example
    * 50
    */
   dlpTemplateMaxCount?: number;
   /**
+   * @remarks
+   * The pay-as-you-go QPS of the subscription instance. For more information, see [WAF 3.0 subscription plans](https://help.aliyun.com/document_detail/441231.html).
+   * 
+   * > This parameter has no meaning for pay-as-you-go instances.
+   * 
    * @example
    * 2000
    */
@@ -260,29 +273,41 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
    * @remarks
    * Indicates whether exclusive IP addresses are supported. Valid values:
    * 
-   * *   **true:** Exclusive IP addresses are supported.
-   * *   **false:** Exclusive IP addresses are not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
    */
   exclusiveIp?: boolean;
   /**
+   * @remarks
+   * The extra QPS of the subscription instance. For more information, see [WAF 3.0 subscription plans](https://help.aliyun.com/document_detail/441231.html).
+   * 
+   * > This parameter has no meaning for pay-as-you-go instances.
+   * 
    * @example
    * 10000
    */
   extendQps?: number;
   /**
+   * @remarks
+   * The free queries per second (QPS) of the subscription instance. For more information, see [WAF 3.0 subscription plans](https://help.aliyun.com/document_detail/441231.html).
+   * 
+   * > This parameter has no meaning for pay-as-you-go instances.
+   * 
    * @example
    * 1000
    */
   freeQps?: number;
   /**
    * @remarks
-   * Indicates whether global server load balancing (GSLB) is supported. Valid values:
+   * Indicates whether Global Server Load Balancing (GSLB) is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** GSLB is supported.
-   * *   **false:** GSLB is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -290,7 +315,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   gslb?: boolean;
   /**
    * @remarks
-   * The HTTP port range that is supported. For more information, see [View supported ports](https://help.aliyun.com/document_detail/385578.html).
+   * The available HTTP ports. For more information, see [Port numbers supported by WAF]().
    * 
    * @example
    * 80
@@ -298,7 +323,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   httpPorts?: string;
   /**
    * @remarks
-   * The HTTPS port range that is supported. For more information, see [View supported ports](https://help.aliyun.com/document_detail/385578.html).
+   * The available HTTPS ports. For more information, see [Port numbers supported by WAF]().
    * 
    * @example
    * 443
@@ -306,10 +331,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   httpsPorts?: string;
   /**
    * @remarks
-   * Indicates whether the IP address blacklist module is supported. Valid values:
+   * Indicates whether the IP address blacklist is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The IP address blacklist module is supported.
-   * *   **false:** The IP address blacklist module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -317,7 +343,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   ipBlacklist?: boolean;
   /**
    * @remarks
-   * The maximum number of IP addresses that can be added to an IP address blacklist rule.
+   * The maximum number of IP addresses that can be added to a blacklist rule.
    * 
    * @example
    * 200
@@ -325,7 +351,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   ipBlacklistIpInRuleMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of rules that can be included in an IP address blacklist rule template.
+   * The maximum number of protection rules that can be included in a single blacklist template.
    * 
    * @example
    * 100
@@ -333,7 +359,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   ipBlacklistRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of IP address blacklist rule templates that can be configured.
+   * The maximum number of blacklist templates that can be configured.
    * 
    * @example
    * 20
@@ -343,8 +369,9 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
    * @remarks
    * Indicates whether IPv6 is supported. Valid values:
    * 
-   * *   **true:** IPv6 is supported.
-   * *   **false:** IPv6 is not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -352,10 +379,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   ipv6?: boolean;
   /**
    * @remarks
-   * Indicates whether the log collection feature is supported. Valid values:
+   * Indicates whether Simple Log Service is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The log collection feature is supported.
-   * *   **false:** The log collection feature is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -363,10 +391,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   logService?: boolean;
   /**
    * @remarks
-   * Indicates whether major event protection is supported. Valid values:
+   * Indicates whether critical event protection is supported. Valid values:
    * 
-   * *   **true:** Major event protection is supported.
-   * *   **false:** Major event protection is not supported.
+   * - **true**: Supported.
+   * 
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -374,23 +403,29 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   majorProtection?: boolean;
   /**
    * @remarks
-   * The maximum number of major event protection rule templates that can be configured.
+   * The maximum number of critical event protection templates that can be configured.
    * 
    * @example
    * 20
    */
   majorProtectionTemplateMaxCount?: number;
   /**
+   * @remarks
+   * The traffic billing protection threshold for the pay-as-you-go instance. For more information, see [Traffic billing protection](https://help.aliyun.com/document_detail/2249021.html) for pay-as-you-go instances.
+   * 
+   * > This parameter has no meaning for subscription instances.
+   * 
    * @example
    * 2000
    */
   qpsBillingCap?: number;
   /**
    * @remarks
-   * Indicates whether the website tamper-proofing module is supported. Valid values:
+   * Indicates whether webpage tamper protection is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The website tamper-proofing module is supported.
-   * *   **false:** The website tamper-proofing module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -398,7 +433,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   tamperproof?: boolean;
   /**
    * @remarks
-   * The maximum number of rules that can be included in a website tamper-proofing rule template.
+   * The maximum number of protection rules that can be included in a single webpage tamper protection template.
    * 
    * @example
    * 50
@@ -406,7 +441,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   tamperproofRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of website tamper-proofing rule templates that can be configured.
+   * The maximum number of webpage tamper protection templates that can be configured.
    * 
    * @example
    * 50
@@ -414,7 +449,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   tamperproofTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of IP addresses or CIDR blocks that can be added to an IP address blacklist in a batch.
+   * The maximum number of IP addresses that can be imported to the IP address blacklist in a single batch.
    * 
    * @example
    * 2,000
@@ -422,7 +457,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   vastIpBlacklistInFileMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of IP addresses or CIDR blocks that can be added to an IP address blacklist on a page.
+   * The maximum number of IP addresses that can be added to the IP address blacklist from the console in a single operation.
    * 
    * @example
    * 500
@@ -430,7 +465,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   vastIpBlacklistInOperationMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of IP addresses or CIDR blocks that can be added to an IP address blacklist per Alibaba Cloud account.
+   * The maximum number of IP addresses that can be added to the IP address blacklist for a single user.
    * 
    * @example
    * 50,000
@@ -438,10 +473,11 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   vastIpBlacklistMaxCount?: number;
   /**
    * @remarks
-   * Indicates whether the whitelist module is supported. Valid values:
+   * Indicates whether the IP address whitelist is supported. Valid values:
+   * 
+   * - **true**: Supported.
    * 
-   * *   **true:** The whitelist module is supported.
-   * *   **false:** The whitelist module is not supported.
+   * - **false**: Not supported.
    * 
    * @example
    * true
@@ -449,7 +485,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   whitelist?: boolean;
   /**
    * @remarks
-   * The logical operators that can be used in a whitelist rule. For more information, see **Match condition parameters** in the "**Parameters of whitelist rules (whitelist)**" section in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The logical operator for the whitelist rule. For more information, see the description of the **conditions** parameter for **whitelist** rules in CreateDefenseRule.
    * 
    * @example
    * contain
@@ -457,7 +493,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   whitelistLogical?: string;
   /**
    * @remarks
-   * The match fields that can be used in a whitelist rule. For more information, see **Match condition parameters** in the "**Parameters of whitelist rules (whitelist)**" section in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The match field for the whitelist rule. For more information, see the description of the **conditions** parameter for **whitelist** rules in CreateDefenseRule.
    * 
    * @example
    * URL
@@ -465,7 +501,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   whitelistRuleCondition?: string;
   /**
    * @remarks
-   * The maximum number of rules that can be included in a whitelist rule template.
+   * The maximum number of protection rules that can be included in a single whitelist template.
    * 
    * @example
    * 100
@@ -473,7 +509,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
   whitelistRuleInTemplateMaxCount?: number;
   /**
    * @remarks
-   * The maximum number of whitelist rule templates that can be configured.
+   * The maximum number of whitelist templates that can be configured.
    * 
    * @example
    * 20
@@ -611,7 +647,7 @@ export class DescribeInstanceResponseBodyDetails extends $dara.Model {
 export class DescribeInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the WAF instance.
+   * The details of the instance.
    */
   details?: DescribeInstanceResponseBodyDetails;
   /**
@@ -624,7 +660,7 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   edition?: string;
   /**
    * @remarks
-   * The expiration time of the WAF instance.
+   * The expiration time of the instance. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 4809859200000
@@ -632,10 +668,11 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * Indicates whether the WAF instance has overdue payments. Valid values:
+   * Indicates whether the instance has an overdue payment:
    * 
-   * *   **0**: The WAF instance does not have overdue payments.
-   * *   **1**: The WAF instance has overdue payments.
+   * - **0**: No.
+   * 
+   * - **1**: Yes.
    * 
    * @example
    * 1
@@ -651,22 +688,41 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The billing method of the WAF instance. Valid values:
+   * The billing method of the instance. Valid values:
+   * 
+   * - **POSTPAY**: The instance is a pay-as-you-go instance.
    * 
-   * *   **POSTPAY:** The WAF instance uses the pay-as-you-go billing method.
-   * *   **PREPAY:** The WAF instance uses the subscription billing method.
+   * - **PREPAY**: The instance is a subscription instance.
    * 
    * @example
    * POSTPAY
    */
   payType?: string;
+  /**
+   * @remarks
+   * The processing status of the instance. Valid values:
+   * 
+   * - **commodity_converting**: The instance is being upgraded or downgraded.
+   * 
+   * - **commodity_convert_check_failed**: The check for the instance upgrade or downgrade fails.
+   * 
+   * - **commodity_convert_process_failed**: The instance upgrade or downgrade fails.
+   * 
+   * - **order_create_failed**: The order fails to be created.
+   * 
+   * - **order_pending_payment**: The order is pending payment.
+   * 
+   * @example
+   * order_pending_payment
+   */
   processStatus?: string;
   /**
    * @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
@@ -674,7 +730,7 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-3014697B11AE
@@ -682,7 +738,7 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The purchase time of the WAF instance. The time is in the UNIX timestamp format. The time is displayed in UTC. Unit: milliseconds.
+   * The time when the instance was purchased. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1668496310000
@@ -690,11 +746,13 @@ export class DescribeInstanceResponseBody extends $dara.Model {
   startTime?: number;
   /**
    * @remarks
-   * The status of the WAF instance. Valid values:
+   * The current status of the instance. Valid values:
+   * 
+   * - **1**: Normal.
+   * 
+   * - **2**: The instance has expired.
    * 
-   * *   **1:** The WAF instance is in a normal state.
-   * *   **2:** The WAF instance has expired.
-   * *   **3:** The WAF instance has been released.
+   * - **3**: The instance is released.
    * 
    * @example
    * 1