@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/DescribeBaseRuleChangeLogRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBaseRuleChangeLogRequest extends $dara.Model {
   /**
    * @remarks
+   * 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.
    * 
    * @example
@@ -12,26 +16,49 @@ export class DescribeBaseRuleChangeLogRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The language of the rule names in the response. Valid values:
+   * 
+   * - **zh**: Chinese.
+   * 
+   * - **en**: English.
+   * 
    * @example
    * zh
    */
   lang?: string;
   /**
+   * @remarks
+   * The page number. Pages start from page 1. Default value: **1**.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @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 Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeBaseRuleChangeLogResponseBody.ts

@@ -4,26 +4,45 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBaseRuleChangeLogResponseBodyRules extends $dara.Model {
   /**
+   * @remarks
+   * The CVE ID of the vulnerability associated with the system rule.
+   * 
    * @example
    * CVE-2021-34538
    */
   cveId?: string;
   /**
+   * @remarks
+   * The type of change. Valid values:
+   * 
+   * - **add**: The rule was added.
+   * 
+   * - **modify**: The rule was modified.
+   * 
    * @example
    * add
    */
   operation?: string;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * 42755
    */
   ruleId?: number;
   /**
+   * @remarks
+   * The rule name.
+   * 
    * @example
    * Header XSS Scanner Behavior
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The time when the rule was updated, in UNIX timestamp format. Unit: milliseconds.
+   * 
    * @example
    * 1665460629000
    */
@@ -59,12 +78,22 @@ export class DescribeBaseRuleChangeLogResponseBodyRules extends $dara.Model {
 
 export class DescribeBaseRuleChangeLogResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6FBF08CB-8691-5B65-BBF8-***
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of rule change records.
+   */
   rules?: DescribeBaseRuleChangeLogResponseBodyRules[];
   /**
+   * @remarks
+   * The total number of rule change records.
+   * 
    * @example
    * 63
    */

package/src/models/DescribeBaseSystemRulesRequest.ts

@@ -4,12 +4,65 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBaseSystemRulesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The type of attack that the system protection rule detects. Valid values:
+   * 
+   * - **sqli**: SQL injection.
+   * 
+   * - **xss**: cross-site scripting (XSS).
+   * 
+   * - **cmdi**: OS command injection.
+   * 
+   * - **expression_injection**: expression injection.
+   * 
+   * - **java_deserialization**: Java deserialization.
+   * 
+   * - **dot_net_deserialization**: .NET deserialization.
+   * 
+   * - **php_deserialization**: PHP deserialization.
+   * 
+   * - **code_exec**: code execution.
+   * 
+   * - **ssrf**: server-side request forgery (SSRF).
+   * 
+   * - **path_traversal**: path traversal.
+   * 
+   * - **arbitrary_file_uploading**: arbitrary file upload.
+   * 
+   * - **webshell**: webshell.
+   * 
+   * - **rfilei**: remote file inclusion (RFI).
+   * 
+   * - **lfilei**: local file inclusion (LFI).
+   * 
+   * - **protocol_violation**: protocol violation.
+   * 
+   * - **scanner_behavior**: scanner behavior.
+   * 
+   * - **logic_flaw**: logic flaw.
+   * 
+   * - **arbitrary_file_reading**: arbitrary file read.
+   * 
+   * - **arbitrary_file_download**: arbitrary file download.
+   * 
+   * - **xxe**: external entity injection.
+   * 
+   * - **csrf**: cross-site request forgery (CSRF).
+   * 
+   * - **crlf**: CRLF injection.
+   * 
+   * - **other**: other.
+   * 
    * @example
    * sqli
    */
   detectType?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of your WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,57 +70,118 @@ export class DescribeBaseSystemRulesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The language of the response. Valid values:
+   * 
+   * - **zh** (default): Chinese.
+   * 
+   * - **en**: English.
+   * 
    * @example
    * zh
    */
   lang?: string;
   /**
+   * @remarks
+   * The number of the page to return. Default value: **1**.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 100.
+   * 
    * @example
    * 100
    */
   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 ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The risk level of the system protection rule. Valid values:
+   * 
+   * - **super_strict**: Very Strict.
+   * 
+   * - **strict**: Strict.
+   * 
+   * - **medium**: Medium.
+   * 
+   * - **loose**: Loose.
+   * 
    * @example
    * loose
    */
   riskLevel?: string;
   /**
+   * @remarks
+   * The action of the system protection rule. Valid values:
+   * 
+   * - **block**: Block.
+   * 
+   * - **monitor**: Monitor.
+   * 
    * @example
    * block
    */
   ruleAction?: string;
   /**
+   * @remarks
+   * The ID of the system protection rule to query.
+   * 
    * @example
    * 113089
    */
   ruleId?: number;
   ruleIds?: number[];
   /**
+   * @remarks
+   * The name of the system protection rule.
+   * 
    * @example
    * systemRuleTest
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The status of the system protection rule. Valid values:
+   * 
+   * - **1**: disabled.
+   * 
+   * - **0**: enabled.
+   * 
    * @example
    * 1
    */
   ruleStatus?: number;
   /**
+   * @remarks
+   * The ID of the protection template.
+   * 
+   * > - Specify this parameter to query the system protection rules in a specific WAF protection template.
+   * >
+   * > - If you leave this parameter empty, the default configurations of the system protection rules are queried.
+   * 
    * @example
    * 24354
    */

package/src/models/DescribeBaseSystemRulesResponseBody.ts

@@ -4,46 +4,135 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBaseSystemRulesResponseBodyRules extends $dara.Model {
   /**
+   * @remarks
+   * The CVE ID of the vulnerability that is associated with the system protection rule.
+   * 
    * @example
    * CVE-2021-34538
    */
   cveId?: string;
   /**
+   * @remarks
+   * The description of the system protection rule.
+   * 
    * @example
    * rule description
    */
   description?: string;
   /**
+   * @remarks
+   * The type of attack that the system protection rule detects. Valid values:
+   * 
+   * - **sqli**: SQL injection.
+   * 
+   * - **xss**: cross-site scripting (XSS).
+   * 
+   * - **cmdi**: OS command injection.
+   * 
+   * - **expression_injection**: expression injection.
+   * 
+   * - **java_deserialization**: Java deserialization.
+   * 
+   * - **dot_net_deserialization**: .NET deserialization.
+   * 
+   * - **php_deserialization**: PHP deserialization.
+   * 
+   * - **code_exec**: code execution.
+   * 
+   * - **ssrf**: server-side request forgery (SSRF).
+   * 
+   * - **path_traversal**: path traversal.
+   * 
+   * - **arbitrary_file_uploading**: arbitrary file upload.
+   * 
+   * - **webshell**: webshell.
+   * 
+   * - **rfilei**: remote file inclusion (RFI).
+   * 
+   * - **lfilei**: local file inclusion (LFI).
+   * 
+   * - **protocol_violation**: protocol violation.
+   * 
+   * - **scanner_behavior**: scanner behavior.
+   * 
+   * - **logic_flaw**: logic flaw.
+   * 
+   * - **arbitrary_file_reading**: arbitrary file read.
+   * 
+   * - **arbitrary_file_download**: arbitrary file download.
+   * 
+   * - **xxe**: external entity injection.
+   * 
+   * - **csrf**: cross-site request forgery (CSRF).
+   * 
+   * - **crlf**: CRLF injection.
+   * 
+   * - **other**: other.
+   * 
    * @example
    * sqli
    */
   detectType?: string;
   /**
+   * @remarks
+   * The risk level of the system protection rule. Valid values:
+   * 
+   * - **super_strict**: Very Strict.
+   * 
+   * - **strict**: Strict.
+   * 
+   * - **medium**: Medium.
+   * 
+   * - **loose**: Loose.
+   * 
    * @example
    * super_strict
    */
   riskLevel?: string;
   /**
+   * @remarks
+   * The action of the system protection rule. Valid values:
+   * 
+   * - **block**: Block.
+   * 
+   * - **monitor**: Monitor.
+   * 
    * @example
    * block
    */
   ruleAction?: string;
   /**
+   * @remarks
+   * The ID of the system protection rule.
+   * 
    * @example
    * 113089
    */
   ruleId?: number;
   /**
+   * @remarks
+   * The name of the system protection rule.
+   * 
    * @example
    * systemRuleTest
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The status of the system protection rule. Valid values:
+   * 
+   * - **1**: disabled.
+   * 
+   * - **0**: enabled.
+   * 
    * @example
    * 1
    */
   ruleStatus?: number;
   /**
+   * @remarks
+   * The time when the system protection rule was last updated. This value is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1665460629000
    */
@@ -87,12 +176,22 @@ export class DescribeBaseSystemRulesResponseBodyRules extends $dara.Model {
 
 export class DescribeBaseSystemRulesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 80736FA5-FA87-55F6-AA69-C5477C6FE6D0
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of system protection rules.
+   */
   rules?: DescribeBaseSystemRulesResponseBodyRules[];
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 2
    */

package/src/models/DescribeBotAppKeyRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBotAppKeyRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Web Application Firewall (WAF) instance.
+   * 
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of your WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,16 +16,29 @@ export class DescribeBotAppKeyRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The version of the AppKey. Set the value to 1.
+   * 
    * @example
    * 1
    */
   keyVersion?: string;
   /**
+   * @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 ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-aek2uo27badl***
    */

package/src/models/DescribeBotAppKeyResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBotAppKeyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * AppKey。
+   * The AppKey for bot management.
    * 
    * @example
    * N1Kiv3AGZm******
    */
   appKey?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0C4ADFD4-5B7D-591D-A607-A45C*****
    */

package/src/models/DescribeBotRuleLabelsRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBotRuleLabelsRequest extends $dara.Model {
   /**
    * @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
@@ -12,31 +16,59 @@ export class DescribeBotRuleLabelsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The type of bot rule label to query.
+   * 
    * @example
    * human_machine_challenge
    */
   labelType?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Valid values: 1 to 200. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token to retrieve the next page of results. This parameter is returned if a next page exists.
+   * 
+   * > If a value is returned for this parameter, it indicates that more results are available. Use the returned **NextToken** value in the next request to retrieve the next page of results. Repeat this process until no value is returned for this parameter. This indicates that all results have been retrieved.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @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 ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The type of bot management scenario. Valid values:
+   * 
+   * - **web**: web protection.
+   * 
+   * - **app**: app protection.
+   * 
    * @example
    * app
    */

package/src/models/DescribeBotRuleLabelsResponseBody.ts

@@ -4,21 +4,43 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBotRuleLabelsResponseBodyRuleLabels extends $dara.Model {
   /**
+   * @remarks
+   * The bot behavior that corresponds to the rule label. Valid values:
+   * 
+   * - **malicious**: malicious bot.
+   * 
+   * - **suspicious**: suspected bot.
+   * 
+   * - **normal**: normal bot.
+   * 
    * @example
    * malicious
    */
   botBehavior?: string;
   /**
+   * @remarks
+   * The key of the bot management rule label.
+   * 
    * @example
    * malicious_crawler_python
    */
   labelKey?: string;
   /**
+   * @remarks
+   * The type of the bot rule label.
+   * 
    * @example
    * human_machine_challenge
    */
   labelType?: string;
   /**
+   * @remarks
+   * The bot management scenarios to which the rule belongs. Multiple scenarios are separated by commas (,). Valid values:
+   * 
+   * - **web**: web protection.
+   * 
+   * - **app**: app protection.
+   * 
    * @example
    * Web,app
    */
@@ -52,22 +74,40 @@ export class DescribeBotRuleLabelsResponseBodyRuleLabels extends $dara.Model {
 
 export class DescribeBotRuleLabelsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The maximum number of entries returned per page. Valid values: 1 to 200. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token to retrieve the next page of results. This parameter is returned if a next page exists.
+   * 
+   * > If a value is returned for this parameter, it indicates that more results are available. Use the returned **NextToken** value in the next request to retrieve the next page of results. Repeat this process until no value is returned for this parameter. This indicates that all results have been retrieved.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of bot management rule labels.
+   */
   ruleLabels?: DescribeBotRuleLabelsResponseBodyRuleLabels[];
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 8
    */