@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/DescribeRuleHitsTopUrlResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeRuleHitsTopUrlResponseBodyRuleHitsTopUrl extends $dara.Model {
   /**
    * @remarks
-   * The number of requests that match protection rules.
+   * The number of requests that triggered the rule.
    * 
    * @example
    * 21862
@@ -15,7 +15,7 @@ export class DescribeRuleHitsTopUrlResponseBodyRuleHitsTopUrl extends $dara.Mode
    * @remarks
    * The request URL.
    * 
-   * >  The value is Base64-encoded.
+   * > The value of this parameter is Base64-encoded.
    * 
    * @example
    * d3d3LmFsaXl1bmRvYy5jb20vcGF0aDM=
@@ -55,7 +55,7 @@ export class DescribeRuleHitsTopUrlResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The top 10 URLs that match protection rules.
+   * The top 10 URLs that trigger protection rules.
    */
   ruleHitsTopUrl?: DescribeRuleHitsTopUrlResponseBodyRuleHitsTopUrl[];
   static names(): { [key: string]: string } {

package/src/models/DescribeSecurityEventLogsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventLogsRequestFilterConditions extends $dara.Model {
   /**
    * @remarks
-   * The field name. This operation supports all fields. For more information, see the **Supported field names** section below.
+   * The name of the field to filter. This operation supports all fields.
    * 
    * @example
    * matched_host
@@ -13,7 +13,7 @@ export class DescribeSecurityEventLogsRequestFilterConditions extends $dara.Mode
   key?: string;
   /**
    * @remarks
-   * The operator. For more information, see the **Supported operators** section below.
+   * The operator.
    * 
    * @example
    * eq
@@ -21,7 +21,7 @@ export class DescribeSecurityEventLogsRequestFilterConditions extends $dara.Mode
   opValue?: string;
   /**
    * @remarks
-   * The field content.
+   * The filter value.
    * 
    * @example
    * test.waf-top
@@ -65,7 +65,9 @@ export class DescribeSecurityEventLogsRequestFilterDateRange extends $dara.Model
   endDate?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.
+   * The start of the time range to query. The time range cannot exceed the last 30 days. The value is a UNIX timestamp. Unit: seconds.
+   * 
+   * > The start time must be within the last 30 days from the current time.
    * 
    * This parameter is required.
    * 
@@ -99,12 +101,12 @@ export class DescribeSecurityEventLogsRequestFilterDateRange extends $dara.Model
 export class DescribeSecurityEventLogsRequestFilter extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions. Each object describes a filter condition.
+   * A list of filter conditions. Each node describes a filter condition.
    */
   conditions?: DescribeSecurityEventLogsRequestFilterConditions[];
   /**
    * @remarks
-   * The time range for the query.
+   * The time range to query.
    * 
    * This parameter is required.
    */
@@ -141,7 +143,7 @@ export class DescribeSecurityEventLogsRequestFilter extends $dara.Model {
 export class DescribeSecurityEventLogsRequest extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions for the query. Multiple conditions are evaluated by using a logical AND.
+   * The filter conditions. A logical AND relationship exists between multiple filter conditions.
    * 
    * This parameter is required.
    */
@@ -150,7 +152,7 @@ export class DescribeSecurityEventLogsRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -160,7 +162,7 @@ export class DescribeSecurityEventLogsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return for a paged query. The default value is **1**, which indicates the first page.
    * 
    * This parameter is required.
    * 
@@ -170,7 +172,7 @@ export class DescribeSecurityEventLogsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: **100**.
+   * The number of entries to return on each page for a paged query. The maximum value is **100**.
    * 
    * This parameter is required.
    * 
@@ -180,13 +182,14 @@ export class DescribeSecurityEventLogsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * The region of the WAF instance. 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
-   * ap-southeast-1
+   * cn-hangzhou
    */
   regionId?: string;
   /**

package/src/models/DescribeSecurityEventLogsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventLogsResponseBodySecurityEventMetaDataDateRange extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This value is the same as the value of EndDate in the request parameters.
+   * The end of the time range used for the query. The value is a UNIX timestamp. Unit: seconds. This value is the same as the \\`EndDate\\` request parameter.
    * 
    * @example
    * 1713888600
@@ -13,7 +13,7 @@ export class DescribeSecurityEventLogsResponseBodySecurityEventMetaDataDateRange
   endDate?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This value is the same as the value of StartDate in the request parameters.
+   * The start of the time range used for the query. The value is a UNIX timestamp. Unit: seconds. This value is the same as the \\`StartDate\\` request parameter.
    * 
    * @example
    * 1713888000
@@ -45,12 +45,12 @@ export class DescribeSecurityEventLogsResponseBodySecurityEventMetaDataDateRange
 export class DescribeSecurityEventLogsResponseBodySecurityEventMetaData extends $dara.Model {
   /**
    * @remarks
-   * The time range that is used for the query.
+   * The time range used for the query.
    */
   dateRange?: DescribeSecurityEventLogsResponseBodySecurityEventMetaDataDateRange;
   /**
    * @remarks
-   * The unit of the statistics returned. The value is fixed as requests.
+   * The unit of the returned statistical data.
    * 
    * @example
    * requests
@@ -88,17 +88,17 @@ export class DescribeSecurityEventLogsResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * D827FCFE-90A7-4330-9326-D33C8B4C7726
+   * D827FCFE-90A7-4330-9326-******4C7726
    */
   requestId?: string;
   /**
    * @remarks
-   * The attack logs returned.
+   * A list of detailed attack logs.
    */
   securityEventLogs?: any[];
   /**
    * @remarks
-   * The total number of logs returned.
+   * The total number of attack logs found.
    * 
    * @example
    * 1000
@@ -106,7 +106,7 @@ export class DescribeSecurityEventLogsResponseBody extends $dara.Model {
   securityEventLogsTotalCount?: number;
   /**
    * @remarks
-   * The metadata of the time series data returned.
+   * The metadata of the returned data.
    */
   securityEventMetaData?: DescribeSecurityEventLogsResponseBodySecurityEventMetaData;
   static names(): { [key: string]: string } {

package/src/models/DescribeSecurityEventLogsShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventLogsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions for the query. Multiple conditions are evaluated by using a logical AND.
+   * The filter conditions. A logical AND relationship exists between multiple filter conditions.
    * 
    * This parameter is required.
    */
@@ -14,7 +14,7 @@ export class DescribeSecurityEventLogsShrinkRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -24,7 +24,7 @@ export class DescribeSecurityEventLogsShrinkRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return for a paged query. The default value is **1**, which indicates the first page.
    * 
    * This parameter is required.
    * 
@@ -34,7 +34,7 @@ export class DescribeSecurityEventLogsShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: **100**.
+   * The number of entries to return on each page for a paged query. The maximum value is **100**.
    * 
    * This parameter is required.
    * 
@@ -44,13 +44,14 @@ export class DescribeSecurityEventLogsShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * The region of the WAF instance. 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
-   * ap-southeast-1
+   * cn-hangzhou
    */
   regionId?: string;
   /**

package/src/models/DescribeSecurityEventTimeSeriesMetricRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventTimeSeriesMetricRequestFilterConditions extends $dara.Model {
   /**
    * @remarks
-   * The field name. This operation supports all fields. For details, see the **Supported field names** section below.
+   * The name of the field to filter. This operation supports all fields.
    * 
    * @example
    * matched_host
@@ -13,7 +13,7 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilterConditions extend
   key?: string;
   /**
    * @remarks
-   * The operator. For details, see the **Supported operators** section below.
+   * The operator.
    * 
    * @example
    * eq
@@ -21,7 +21,7 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilterConditions extend
   opValue?: string;
   /**
    * @remarks
-   * The field content.
+   * The filter value.
    * 
    * @example
    * test.waf-top
@@ -55,7 +55,7 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilterConditions extend
 export class DescribeSecurityEventTimeSeriesMetricRequestFilterDateRange extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. The value is a Unix timestamp. Unit: seconds.
+   * The end time of the query. This is a UNIX timestamp. Unit: seconds.
    * 
    * This parameter is required.
    * 
@@ -65,7 +65,9 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilterDateRange extends
   endDate?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a Unix timestamp. Unit: seconds.
+   * You can query data from the last 30 days. The start time of the query. This is a UNIX timestamp. Unit: seconds.
+   * 
+   * > ## The start time must be within the last 30 days.
    * 
    * This parameter is required.
    * 
@@ -99,12 +101,12 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilterDateRange extends
 export class DescribeSecurityEventTimeSeriesMetricRequestFilter extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions. Each object describes a filter condition.
+   * A list of filter conditions. Each node describes one filter condition.
    */
   conditions?: DescribeSecurityEventTimeSeriesMetricRequestFilterConditions[];
   /**
    * @remarks
-   * The time range for the query.
+   * The time range to query.
    * 
    * This parameter is required.
    */
@@ -141,7 +143,7 @@ export class DescribeSecurityEventTimeSeriesMetricRequestFilter extends $dara.Mo
 export class DescribeSecurityEventTimeSeriesMetricRequest extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions for the query. Multiple conditions are evaluated by using a logical AND.
+   * The filter conditions for the query. Multiple filter conditions have a logical AND relationship.
    * 
    * This parameter is required.
    */
@@ -150,7 +152,7 @@ export class DescribeSecurityEventTimeSeriesMetricRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -160,12 +162,15 @@ export class DescribeSecurityEventTimeSeriesMetricRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The metric whose time series data you want to return. The following metrics are supported:
+   * Specifies the content of the returned data. Different metrics correspond to different data content. This operation supports the following metrics:
+   * 
+   * - mitigated_requests: Returns the time series statistics of blocked requests.
+   * 
+   * - monitored_requests: Returns the time series statistics of requests that hit only observation-type rules.
    * 
-   * *   mitigated_requests: The system returns the time series data of requests that are blocked.
-   * *   monitored_requests: The system returns the time series data of requests that match Monitor protection rules.
-   * *   mitigated_requests_group_by_defense_scene: The system returns the number of requests that match each protection module. The returned results are grouped by protection module and can be used to generate time series charts. A request can match multiple protection modules. Therefore, the total number of matched requests is inconsistent with the total number of requests.
-   * *   mitigated_requests_group_by_block_defense_scene: The system returns the number of requests that are blocked by each protection module. The returned results are grouped by protection module and can be used to generate time series charts. A request can be blocked by only one protection module. Therefore, the total number of blocked requests is consistent with the total number of requests.
+   * - mitigated_requests_group_by_defense_scene: Returns data grouped by module. It records a time series graph of the hit count for each module. A single request may hit multiple modules. Therefore, the hit count returned by this metric may not be consistent with the number of requests.
+   * 
+   * - mitigated_requests_group_by_block_defense_scene: Returns data grouped by module. It records a time series graph of the number of blocked requests for each module. A single request is blocked by only one module. Therefore, the count returned by this metric is consistent with the number of requests.
    * 
    * This parameter is required.
    * 
@@ -175,13 +180,14 @@ export class DescribeSecurityEventTimeSeriesMetricRequest extends $dara.Model {
   metric?: 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.
    * 
-   * *   **cn-hangzhou**: The Chinese mainland.
-   * *   **ap-southeast-1**: Outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
-   * ap-southeast-1
+   * cn-hangzhou
    */
   regionId?: string;
   /**

package/src/models/DescribeSecurityEventTimeSeriesMetricResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventTimeSeriesMetricResponseBodySecurityEventTimeSeries extends $dara.Model {
   /**
    * @remarks
-   * The metric. This value is the same as the value of Metric in the request parameters.
+   * The content of the returned data. This is consistent with the \\`Metric\\` request parameter.
    * 
    * @example
    * monitored_requests
@@ -13,12 +13,12 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBodySecurityEventTimeS
   metric?: string;
   /**
    * @remarks
-   * The time points. Each point represents a time range.
+   * The time series. Each point represents the start time of a time range.
    */
   timestamps?: string[];
   /**
    * @remarks
-   * The data points. Each point represents a count for a time range.
+   * The data series. Each point represents the statistical count within a specific time range.
    */
   values?: number[];
   static names(): { [key: string]: string } {
@@ -55,7 +55,7 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBodySecurityEventTimeS
 export class DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaDataDateRange extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. The value is a Unix timestamp. Unit: seconds. This value is the same as the value of EndDate in the request parameters.
+   * The end time of the query. This is a UNIX timestamp. Unit: seconds. This value is the same as the \\`EndDate\\` request parameter.
    * 
    * @example
    * 1713888600
@@ -63,7 +63,7 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaData
   endDate?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a Unix timestamp. Unit: seconds. This value is the same as the value of StartDate in the request parameters.
+   * The start time of the query. This is a UNIX timestamp. Unit: seconds. This value is the same as the \\`StartDate\\` request parameter.
    * 
    * @example
    * 1713888000
@@ -95,7 +95,7 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaData
 export class DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaData extends $dara.Model {
   /**
    * @remarks
-   * The time granularity of data points in the time series data returned. For example, a value of 15m indicates that data points are collected at 15-minute intervals. For more information about time granularities, see the **Time granularities of data points in time series** section below.
+   * The time granularity of each data point in the returned time series data. For example, "15m" indicates that each returned data point represents statistics for a 15-minute interval. For more information about the time granularity of the returned data, see the Time granularity of time series data points section.
    * 
    * @example
    * 1m
@@ -103,12 +103,12 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaData
   aggregateInterval?: string;
   /**
    * @remarks
-   * The time range that is used for the query.
+   * The time range used for the query.
    */
   dateRange?: DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaDataDateRange;
   /**
    * @remarks
-   * The unit of the statistics returned. It is fixed as requests.
+   * The unit of the returned statistical data.
    * 
    * @example
    * requests
@@ -153,12 +153,12 @@ export class DescribeSecurityEventTimeSeriesMetricResponseBody extends $dara.Mod
   requestId?: string;
   /**
    * @remarks
-   * The time series data returned. This operation can return time series for multiple metrics.
+   * The returned time series data. The operation can return time series data for multiple values.
    */
   securityEventTimeSeries?: DescribeSecurityEventTimeSeriesMetricResponseBodySecurityEventTimeSeries[];
   /**
    * @remarks
-   * The metadata of the time series data returned.
+   * The metadata of the returned data.
    */
   timeSeriesMetaData?: DescribeSecurityEventTimeSeriesMetricResponseBodyTimeSeriesMetaData;
   static names(): { [key: string]: string } {

package/src/models/DescribeSecurityEventTimeSeriesMetricShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSecurityEventTimeSeriesMetricShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The filter conditions for the query. Multiple conditions are evaluated by using a logical AND.
+   * The filter conditions for the query. Multiple filter conditions have a logical AND relationship.
    * 
    * This parameter is required.
    */
@@ -14,7 +14,7 @@ export class DescribeSecurityEventTimeSeriesMetricShrinkRequest extends $dara.Mo
    * @remarks
    * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -24,12 +24,15 @@ export class DescribeSecurityEventTimeSeriesMetricShrinkRequest extends $dara.Mo
   instanceId?: string;
   /**
    * @remarks
-   * The metric whose time series data you want to return. The following metrics are supported:
+   * Specifies the content of the returned data. Different metrics correspond to different data content. This operation supports the following metrics:
    * 
-   * *   mitigated_requests: The system returns the time series data of requests that are blocked.
-   * *   monitored_requests: The system returns the time series data of requests that match Monitor protection rules.
-   * *   mitigated_requests_group_by_defense_scene: The system returns the number of requests that match each protection module. The returned results are grouped by protection module and can be used to generate time series charts. A request can match multiple protection modules. Therefore, the total number of matched requests is inconsistent with the total number of requests.
-   * *   mitigated_requests_group_by_block_defense_scene: The system returns the number of requests that are blocked by each protection module. The returned results are grouped by protection module and can be used to generate time series charts. A request can be blocked by only one protection module. Therefore, the total number of blocked requests is consistent with the total number of requests.
+   * - mitigated_requests: Returns the time series statistics of blocked requests.
+   * 
+   * - monitored_requests: Returns the time series statistics of requests that hit only observation-type rules.
+   * 
+   * - mitigated_requests_group_by_defense_scene: Returns data grouped by module. It records a time series graph of the hit count for each module. A single request may hit multiple modules. Therefore, the hit count returned by this metric may not be consistent with the number of requests.
+   * 
+   * - mitigated_requests_group_by_block_defense_scene: Returns data grouped by module. It records a time series graph of the number of blocked requests for each module. A single request is blocked by only one module. Therefore, the count returned by this metric is consistent with the number of requests.
    * 
    * This parameter is required.
    * 
@@ -39,13 +42,14 @@ export class DescribeSecurityEventTimeSeriesMetricShrinkRequest extends $dara.Mo
   metric?: 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.
    * 
-   * *   **cn-hangzhou**: The Chinese mainland.
-   * *   **ap-southeast-1**: Outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
-   * ap-southeast-1
+   * cn-hangzhou
    */
   regionId?: string;
   /**