@alicloud/waf-openapi20211001 6.6.1 → 6.7.1

package/src/models/DescribeApisecStatisticsResponseBody.ts

@@ -4,16 +4,13 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecStatisticsResponseBodyData extends $dara.Model {
   /**
-   * @remarks
-   * The number of accounts associated with the monitored APIs.
-   * 
    * @example
    * 1
    */
   account?: number;
   /**
    * @remarks
-   * The number of handled items.
+   * The number of handled events.
    * 
    * @example
    * 1
@@ -21,148 +18,137 @@ export class DescribeApisecStatisticsResponseBodyData extends $dara.Model {
   actioned?: number;
   /**
    * @remarks
-   * The number of APIs that are monitored by the API security module.
+   * The number of APIs.
    * 
    * @example
-   * 202
+   * /api/v1/login
    */
   api?: number;
   /**
    * @remarks
-   * The number of confirmed items.
+   * The number of confirmed events.
    * 
    * @example
-   * 11
+   * 10
    */
   confirmed?: number;
   /**
    * @remarks
-   * The number of domain names that are monitored by the API security module.
+   * The number of domain names.
    * 
    * @example
-   * 22
+   * a.aliyun.com
    */
   domain?: number;
   /**
    * @remarks
-   * The number of items that are manually verified as fixed.
+   * The number of fixed risks.
    * 
    * @example
-   * 13
+   * 0
    */
   fixed?: number;
   /**
    * @remarks
-   * The number of high-risk items.
+   * The number of high-risk events.
    * 
    * @example
-   * 135
+   * 10
    */
   high?: number;
   /**
    * @remarks
-   * The number of ignored items.
+   * The number of ignored risks.
    * 
    * @example
-   * 3
+   * 0
    */
   ignore?: number;
   /**
    * @remarks
-   * The number of low-risk items.
+   * The number of low-risk events.
    * 
    * @example
-   * 160
+   * 10
    */
   low?: number;
   /**
    * @remarks
-   * The number of medium-risk items.
+   * The number of moderate-risk events.
    * 
    * @example
-   * 27
+   * 10
    */
   medium?: number;
   /**
-   * @remarks
-   * The number of items that are verified as not fixed.
-   * 
    * @example
    * 0
    */
   notFixed?: number;
   /**
-   * @remarks
-   * The number of items that are verified as fixed by the system.
-   * 
    * @example
    * 1
    */
   systemFixed?: number;
   /**
    * @remarks
-   * The number of items to be confirmed.
+   * The number of events to be confirmed.
    * 
    * @example
-   * 295
+   * 10
    */
   toBeConfirmed?: number;
   /**
    * @remarks
-   * The number of items to be fixed.
+   * The number of risks to be fixed.
    * 
    * @example
-   * 3
+   * 10
    */
   toBeFixed?: number;
   /**
-   * @remarks
-   * The number of items to be verified by the system.
-   * 
    * @example
    * 2
    */
   toBeVerified?: number;
   /**
    * @remarks
-   * The number of new high-risk items detected today.
+   * The number of new high-risk events today.
    * 
    * @example
-   * 3
+   * 10
    */
   todayHigh?: string;
   /**
    * @remarks
-   * The number of new low-risk items detected today.
+   * The number of new low-risk events today.
    * 
    * @example
-   * 0
+   * 10
    */
   todayLow?: number;
   /**
    * @remarks
-   * The number of new medium-risk items detected today.
+   * The number of new moderate-risk events today.
    * 
    * @example
-   * 0
+   * 10
    */
   todayMedium?: string;
   /**
    * @remarks
-   * The total number of new items detected today.
+   * The total number of new events today.
    * 
    * @example
-   * 3
+   * 30
    */
   todayTotal?: string;
   /**
    * @remarks
-   * The total number of items.
-   * 
-   * > This is the sum of the values of the **High**, **Medium**, and **Low** response parameters.
+   * The total number of events.
    * 
    * @example
-   * 322
+   * 30
    */
   total?: number;
   static names(): { [key: string]: string } {
@@ -227,7 +213,7 @@ export class DescribeApisecStatisticsResponseBodyData extends $dara.Model {
 export class DescribeApisecStatisticsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The statistical results of API security risks or events.
+   * The returned results.
    */
   data?: DescribeApisecStatisticsResponseBodyData;
   /**

package/src/models/DescribeApisecSuggestionsRequest.ts

@@ -15,9 +15,8 @@ export class DescribeApisecSuggestionsRequest extends $dara.Model {
   apiId?: string;
   /**
    * @remarks
-   * The ID of the Hybrid Cloud WAF cluster.
-   * 
-   * > This parameter is available only in hybrid cloud scenarios. Call [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) to query the IDs of Hybrid Cloud WAF clusters.
+   * The ID of the hybrid cloud cluster.
+   * >For hybrid cloud scenarios only, you can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the hybrid cloud clusters.
    * 
    * @example
    * 428
@@ -27,7 +26,7 @@ export class DescribeApisecSuggestionsRequest 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 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.
    * 
    * This parameter is required.
    * 
@@ -37,11 +36,10 @@ export class DescribeApisecSuggestionsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region of the WAF instance. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
+   * The region in which the WAF instance is deployed. Valid values:
    * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland
+   * *   **ap-southeast-1**: outside the Chinese mainland
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeApisecSuggestionsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The request path of the API.
+   * The API.
    * 
    * @example
    * /apisec/v1/saveinfo
@@ -13,7 +13,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   apiFormat?: string;
   /**
    * @remarks
-   * The domain name or IP address associated with the API.
+   * The domain name or IP address of the API.
    * 
    * @example
    * a.aliyun.com
@@ -21,7 +21,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The ID of the protection suggestion.
+   * The rule ID of the protection suggestion.
    * 
    * @example
    * 15060a1f8fed40130b7c4a7bf8d8733b
@@ -29,23 +29,16 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   suggestId?: string;
   /**
    * @remarks
-   * The protection suggestion rule, in JSON format. The JSON string contains the following parameters:
+   * The rule content of the protection suggestion. The value is a string that consists of multiple parameters in the JSON format. Valid values:
    * 
-   * - **event_tags**: the event type.
-   * 
-   * - **black_iplist**: the IP address blacklist.
-   * 
-   * - **ip_baseline**: the IP address list.
-   * 
-   * - **freq_baseline**: the frequency limit information.
-   * 
-   * - **client_id_baseline**: the client information.
-   * 
-   * - **country_baseline**: the country information.
-   * 
-   * - **province_baseline**: the region information.
-   * 
-   * - **sensitive_type**: the sensitive information type.
+   * *   **event_tags**: event type
+   * *   **black_iplist**: IP address blacklist
+   * *   **ip_baseline**: IP address
+   * *   **freq_baseline**: throttling frequency
+   * *   **client_id_baseline**: client information
+   * *   **country_baseline**: country information
+   * *   **province_baseline**: province information
+   * *   **sensitive_type**: sensitive information
    * 
    * @example
    * {
@@ -56,23 +49,16 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   suggestRule?: string;
   /**
    * @remarks
-   * The type of the protection suggestion. Valid values:
-   * 
-   * - **BotRule**: a bot rule.
-   * 
-   * - **BlackIPRule**: an IP address blacklist rule.
-   * 
-   * - **WhiteIPRule**: an IP address whitelist rule.
-   * 
-   * - **RateLimitRule**: a rate limiting rule.
-   * 
-   * - **ClientRule**: a client rule.
-   * 
-   * - **GeoRule**: a region rule.
-   * 
-   * - **SensitiveRule**: a sensitive information rule.
+   * The rule type of the protection suggestion. Valid values:
    * 
-   * - **UnauthRule**: an authentication rule.
+   * *   **BotRule**: bot management rules
+   * *   **BlackIPRule**: IP address blacklist rules
+   * *   **WhiteIPRule**: IP address whitelist rules
+   * *   **RateLimitRule**: throttling rules
+   * *   **ClientRule**: client rules
+   * *   **GeoRule**: region-related rules
+   * *   **SensitiveRule**: sensitive information rules
+   * *   **UnauthRule**: authentication rules
    * 
    * @example
    * WhiteIPRule
@@ -110,7 +96,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
 export class DescribeApisecSuggestionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of protection suggestions for the API asset.
+   * The protection suggestions.
    */
   data?: DescribeApisecSuggestionsResponseBodyData[];
   /**

package/src/models/DescribeApisecUserOperationsRequest.ts

@@ -5,9 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecUserOperationsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Hybrid Cloud WAF cluster.
-   * 
-   * > This parameter is required only when WAF is deployed in hybrid cloud mode. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the IDs of Hybrid Cloud WAF clusters.
+   * The ID of the hybrid cloud cluster.
+   * >For hybrid cloud scenarios only, you can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the hybrid cloud clusters.
    * 
    * @example
    * 428
@@ -15,9 +14,9 @@ export class DescribeApisecUserOperationsRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The ID of the WAF instance.
+   * 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 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.
    * 
    * This parameter is required.
    * 
@@ -27,7 +26,7 @@ export class DescribeApisecUserOperationsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the threat detection or security event for which you want to query operation records.
+   * The object ID of the operation record.
    * 
    * This parameter is required.
    * 
@@ -37,11 +36,10 @@ export class DescribeApisecUserOperationsRequest extends $dara.Model {
   objectId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance resides. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
+   * The region in which the WAF instance is deployed. Valid values:
    * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland
+   * *   **ap-southeast-1**: outside the Chinese mainland
    * 
    * @example
    * cn-hangzhou
@@ -49,7 +47,7 @@ export class DescribeApisecUserOperationsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group to which the WAF instance belongs.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-aek2ax2y5****pi
@@ -59,9 +57,8 @@ export class DescribeApisecUserOperationsRequest extends $dara.Model {
    * @remarks
    * The type of the operation record. Valid values:
    * 
-   * - **abnormal**: threat detection.
-   * 
-   * - **event**: security event.
+   * *   **abnormal**: risk detection
+   * *   **event**: security event
    * 
    * @example
    * event

package/src/models/DescribeApisecUserOperationsResponseBody.ts

@@ -5,27 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The status of the threat detection or security event before the operation was performed.
+   * The state before the operation.
    * 
-   * Valid values for threat detection:
+   * Valid values of the risk state:
    * 
-   * - **toBeConfirmed**: to be confirmed.
+   * *   **toBeConfirmed**
+   * *   **confirmed**
+   * *   **toBeFixed**
+   * *   **fixed**
+   * *   **ignored**
    * 
-   * - **confirmed**: confirmed.
+   * Valid values of the event state:
    * 
-   * - **toBeFixed**: to be fixed.
-   * 
-   * - **fixed**: fixed.
-   * 
-   * - **ignored**: ignored.
-   * 
-   * Valid values for a security event:
-   * 
-   * - **toBeConfirmed**: to be confirmed.
-   * 
-   * - **confirmed**: confirmed.
-   * 
-   * - **ignored**: ignored.
+   * *   **toBeConfirmed**
+   * *   **confirmed**
+   * *   **ignored**
    * 
    * @example
    * ignored
@@ -33,35 +27,24 @@ export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
   fromStatus?: string;
   /**
    * @remarks
-   * The remarks that the user added to the operation record.
+   * The remarks.
    * 
    * @example
-   * Procesed
+   * Handled
    */
   note?: string;
   /**
    * @remarks
-   * The ID of the threat detection or security event associated with the operation record.
+   * The object ID of the operation record.
    * 
    * @example
    * 24d997acc48a67a01e09b9c5ad861287
    */
   objectId?: string;
-  /**
-   * @remarks
-   * The source of the operation. Valid values:
-   * 
-   * - **system**: the operation was automatically performed by the system.
-   * 
-   * - **custom**: the operation was manually performed by a user.
-   * 
-   * @example
-   * custom
-   */
   operationSource?: string;
   /**
    * @remarks
-   * The time when the operation was performed. This value is a UNIX timestamp. Unit: seconds.
+   * The time at which the operation was performed. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
    * 
    * @example
    * 1685072214
@@ -69,27 +52,21 @@ export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
   time?: number;
   /**
    * @remarks
-   * The status of the threat detection or security event after the operation was performed.
-   * 
-   * Valid values for threat detection:
-   * 
-   * - **toBeConfirmed**: to be confirmed.
+   * The state after the operation.
    * 
-   * - **confirmed**: confirmed.
+   * Valid values of the risk state:
    * 
-   * - **toBeFixed**: to be fixed.
+   * *   **toBeConfirmed**
+   * *   **confirmed**
+   * *   **toBeFixed**
+   * *   **fixed**
+   * *   **ignored**
    * 
-   * - **fixed**: fixed.
+   * Valid values of the event state:
    * 
-   * - **ignored**: ignored.
-   * 
-   * Valid values for a security event:
-   * 
-   * - **toBeConfirmed**: to be confirmed.
-   * 
-   * - **confirmed**: confirmed.
-   * 
-   * - **ignored**: ignored.
+   * *   **toBeConfirmed**
+   * *   **confirmed**
+   * *   **ignored**
    * 
    * @example
    * Confirmed
@@ -99,9 +76,8 @@ export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
    * @remarks
    * The type of the operation record. Valid values:
    * 
-   * - **abnormal**: threat detection.
-   * 
-   * - **event**: security event.
+   * *   **abnormal**: risk detection
+   * *   **event**: security event
    * 
    * @example
    * abnormal
@@ -109,7 +85,7 @@ export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The ID of the user who performed the operation.
+   * The user ID.
    * 
    * @example
    * 1610954****
@@ -153,12 +129,12 @@ export class DescribeApisecUserOperationsResponseBodyData extends $dara.Model {
 export class DescribeApisecUserOperationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The user operation records for API security.
+   * The operation records.
    */
   data?: DescribeApisecUserOperationsResponseBodyData[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * C9825654-327B-5156-A570-847054B4CF10

package/src/models/DescribeBaseRuleChangeLogRequest.ts

@@ -5,10 +5,6 @@ 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 query the ID of the current WAF instance.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -16,49 +12,26 @@ export class DescribeBaseRuleChangeLogRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
-   * @remarks
-   * Set the language property for rule names. Valid values:
-   * 
-   * - **zh**: Chinese rule names.
-   * 
-   * - **en**: English rule names.
-   * 
    * @example
    * zh
    */
   lang?: string;
   /**
-   * @remarks
-   * When performing a paged query, specify the page number to return. The default value is **1**, which means the first page of data is returned.
-   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
-   * @remarks
-   * When performing a paged query, specify the number of results per page.
-   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
-   * @remarks
-   * The region to which the WAF instance belongs. Valid values:
-   * 
-   * - **cn-hangzhou**: The Chinese mainland.
-   * 
-   * - **ap-southeast-1**: Outside the Chinese mainland.
-   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
-   * @remarks
-   * The Alibaba Cloud resource group ID.
-   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeBaseRuleChangeLogResponseBody.ts

@@ -4,45 +4,26 @@ 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 operation type. Valid values:
-   * 
-   * - add: Add.
-   * 
-   * - modify: Modify.
-   * 
    * @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 update time of the rule.
-   * 
    * @example
    * 1665460629000
    */
@@ -78,22 +59,12 @@ export class DescribeBaseRuleChangeLogResponseBodyRules extends $dara.Model {
 
 export class DescribeBaseRuleChangeLogResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * 6FBF08CB-8691-5B65-BBF8-***
    */
   requestId?: string;
-  /**
-   * @remarks
-   * List of ruleset changes.
-   */
   rules?: DescribeBaseRuleChangeLogResponseBodyRules[];
   /**
-   * @remarks
-   * The total number of rule change entries in the list.
-   * 
    * @example
    * 63
    */