@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeApisecSlsProjectsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecSlsProjectsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Web Application Firewall (WAF) instance.
+   * 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.
+   * > 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.
    * 
@@ -19,7 +19,7 @@ export class DescribeApisecSlsProjectsRequest extends $dara.Model {
    * @remarks
    * The ID of the region where logs are stored.
    * 
-   * >  You can call the [DescribeUserSlsLogRegions](https://help.aliyun.com/document_detail/2712598.html) operation to query available log storage regions.
+   * > You can call the [DescribeUserSlsLogRegions](https://help.aliyun.com/document_detail/2712598.html) operation to query available log storage regions.
    * 
    * This parameter is required.
    * 
@@ -31,8 +31,9 @@ export class DescribeApisecSlsProjectsRequest extends $dara.Model {
    * @remarks
    * The region where the WAF instance is deployed. Valid values:
    * 
-   * *   **cn-hangzhou**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeApisecSlsProjectsResponseBody.ts

@@ -10,7 +10,7 @@ export class DescribeApisecSlsProjectsResponseBody extends $dara.Model {
   projects?: string[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0

package/src/models/DescribeApisecStatisticsRequest.ts

@@ -5,25 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecStatisticsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the hybrid cloud cluster.
+   * The ID of the Hybrid Cloud WAF cluster.
    * 
-   * >  This parameter is available only in hybrid cloud scenarios. You can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query hybrid cloud clusters.
+   * > This parameter is available only in hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query Hybrid Cloud WAF clusters.
    * 
    * @example
    * 428
    */
   clusterId?: string;
   /**
+   * @remarks
+   * The end of the time range to query. This value is a UNIX timestamp. Unit: seconds.
+   * 
    * @example
-   * 4809859200000
+   * 1726113600
    */
   endTime?: number;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * The ID of the Web Application Firewall (WAF) instance.
    * 
-   * * **cn-hangzhou**: Chinese mainland
-   * * **ap-southeast-1**: outside the Chinese mainland
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -33,10 +35,11 @@ export class DescribeApisecStatisticsRequest extends $dara.Model {
   instanceId?: 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**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -51,21 +54,29 @@ export class DescribeApisecStatisticsRequest extends $dara.Model {
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds.
+   * 
    * @example
-   * 1668496310000
+   * 1668496310
    */
   startTime?: number;
   /**
    * @remarks
-   * The type of the statistics. Valid values:
+   * The type of detection statistics. Valid values:
    * 
-   * *   **risk**: risk-related statistics.
-   * *   **event**: event-related statistics.
+   * - **risk**: statistics on security risks.
+   * 
+   * - **event**: statistics on attacks.
    * 
    * @example
-   * asset_num
+   * risk
    */
   type?: string;
+  /**
+   * @remarks
+   * The list of statuses used to filter the detection statistics.
+   */
   userStatusList?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeApisecStatisticsResponseBody.ts

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

package/src/models/DescribeApisecSuggestionsRequest.ts

@@ -16,7 +16,7 @@ export class DescribeApisecSuggestionsRequest extends $dara.Model {
   /**
    * @remarks
    * 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.
+   * > This parameter applies only to hybrid cloud scenarios. You can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to obtain hybrid cloud cluster information.
    * 
    * @example
    * 428
@@ -24,9 +24,9 @@ export class DescribeApisecSuggestionsRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The ID of the Web Application Firewall (WAF) instance.
+   * Instance 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.
+   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query instance ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -38,8 +38,9 @@ export class DescribeApisecSuggestionsRequest extends $dara.Model {
    * @remarks
    * The region in which the WAF instance is deployed. 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

package/src/models/DescribeApisecSuggestionsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The API.
+   * The API operation.
    * 
    * @example
    * /apisec/v1/saveinfo
@@ -13,7 +13,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   apiFormat?: string;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address to which the API operation belongs.
    * 
    * @example
    * a.aliyun.com
@@ -21,7 +21,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The rule ID of the protection suggestion.
+   * The ID of the protection suggestion.
    * 
    * @example
    * 15060a1f8fed40130b7c4a7bf8d8733b
@@ -29,16 +29,15 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   suggestId?: string;
   /**
    * @remarks
-   * 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**: 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
+   * The content of the protection suggestion rule, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:
+   * - **event_tags**: the event type.
+   * - **black_iplist**: the IP blacklist.
+   * - **ip_baseline**: the IP list.
+   * - **freq_baseline**: the throttling frequency information.
+   * - **client_id_baseline**: the client information.
+   * - **country_baseline**: the country information.
+   * - **province_baseline**: the region information.
+   * - **sensitive_type**: the sensitive information type.
    * 
    * @example
    * {
@@ -49,16 +48,15 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
   suggestRule?: string;
   /**
    * @remarks
-   * The rule type of the protection suggestion. Valid values:
-   * 
-   * *   **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
+   * The type of the protection suggestion. Valid values: 
+   * - **BotRule**: bot rule.
+   * - **BlackIPRule**: IP blacklist rule.
+   * - **WhiteIPRule**: IP whitelist rule.
+   * - **RateLimitRule**: throttling rule.
+   * - **ClientRule**: client rule.
+   * - **GeoRule**: geo-blocking rule.
+   * - **SensitiveRule**: sensitive information rule.
+   * - **UnauthRule**: authentication rule.
    * 
    * @example
    * WhiteIPRule
@@ -96,7 +94,7 @@ export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
 export class DescribeApisecSuggestionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The protection suggestions.
+   * The list of protection suggestions.
    */
   data?: DescribeApisecSuggestionsResponseBodyData[];
   /**

package/src/models/DescribeApisecUserOperationsRequest.ts

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

package/src/models/DescribeApisecUserOperationsResponseBody.ts

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