@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/DescribeUserAbnormalTypeRequest.ts

@@ -6,7 +6,8 @@ export class DescribeUserAbnormalTypeRequest 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. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the IDs of hybrid cloud clusters.
    * 
    * @example
    * 993
@@ -14,7 +15,7 @@ export class DescribeUserAbnormalTypeRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The end of the time range to query. Specify the time as a UNIX timestamp in seconds. The time is in UTC.
    * 
    * @example
    * 1726113600
@@ -22,9 +23,9 @@ export class DescribeUserAbnormalTypeRequest extends $dara.Model {
   endTime?: number;
   /**
    * @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.
    * 
@@ -34,10 +35,11 @@ export class DescribeUserAbnormalTypeRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. 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
@@ -53,12 +55,18 @@ export class DescribeUserAbnormalTypeRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The beginning of the time range to query. Specify the time as a UNIX timestamp in seconds. The time is in UTC.
    * 
    * @example
    * 1723435200
    */
   startTime?: number;
+  /**
+   * @remarks
+   * The list of risk states for which to collect statistics.
+   * 
+   * > By default, statistics are collected for risks in the **toBeConfirmed**, **toBeFixed**, **toBeVerified**, and **notFixed** states.
+   */
   userStatusList?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeUserAbnormalTypeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeUserAbnormalTypeResponseBodyAbnormal extends $dara.Model {
   /**
    * @remarks
-   * The code of the risk.
+   * The code that identifies the specific risk, such as `Risk_InternalWeakPasswd`.
    * 
    * @example
    * Risk_InternalWeakPasswd
@@ -13,7 +13,7 @@ export class DescribeUserAbnormalTypeResponseBodyAbnormal extends $dara.Model {
   abnormalCode?: string;
   /**
    * @remarks
-   * The number of risks.
+   * The total number of risks detected for this risk type.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class DescribeUserAbnormalTypeResponseBodyAbnormal extends $dara.Model {
   abnormalCount?: number;
   /**
    * @remarks
-   * The parent type of the risk.
+   * The parent category of the risk, such as `RiskType_Account`.
    * 
    * @example
    * RiskType_Account
@@ -29,12 +29,12 @@ export class DescribeUserAbnormalTypeResponseBodyAbnormal extends $dara.Model {
   abnormalParentType?: string;
   /**
    * @remarks
-   * The type of the risk.
+   * The type of the risk detected by API security.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported types of risks.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported risk types.
    * 
    * @example
-   * LackOfSpeedLimit
+   * Risk_InternalWeakPasswd
    */
   abnormalType?: string;
   static names(): { [key: string]: string } {
@@ -67,12 +67,12 @@ export class DescribeUserAbnormalTypeResponseBodyAbnormal extends $dara.Model {
 export class DescribeUserAbnormalTypeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The types and statistics of risks.
+   * The risk types detected by API security and the number of risks for each type.
    */
   abnormal?: DescribeUserAbnormalTypeResponseBodyAbnormal[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 3E1CB966-1407-5988-9432-7***D784

package/src/models/DescribeUserApiRequestRequest.ts

@@ -5,8 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeUserApiRequestRequest extends $dara.Model {
   /**
    * @remarks
-   * The API.
-   * >Notice: This parameter is deprecated, please use ApiId to query.
+   * The API operation.
+   * 
+   * >Notice: 
+   * 
+   * This parameter is deprecated. Use the ApiId parameter instead.
    * 
    * @example
    * /api/v1/know
@@ -27,7 +30,8 @@ export class DescribeUserApiRequestRequest 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. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to obtain information about hybrid cloud clusters.
    * 
    * @example
    * 428
@@ -35,8 +39,11 @@ export class DescribeUserApiRequestRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The domain name or IP address of the API.
-   * >Notice: This parameter is deprecated, please use ApiId to query.
+   * The domain name or IP address of the API operation.
+   * 
+   * >Notice: 
+   * 
+   * This parameter is deprecated. Use the ApiId parameter instead.
    * 
    * @example
    * c.***.com
@@ -46,9 +53,9 @@ export class DescribeUserApiRequestRequest extends $dara.Model {
   domain?: 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.
    * 
@@ -58,10 +65,11 @@ export class DescribeUserApiRequestRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. 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
@@ -77,18 +85,27 @@ export class DescribeUserApiRequestRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The type of the statistics. Valid values:
-   * 
-   * *   **api_ip**: total traffic
-   * *   **api_cross_border_ip**: cross-border traffic
-   * *   **api_bot_ip**: bot traffic
-   * *   **remote_region**: geographical location
-   * *   **client_id**: client type
-   * *   **http_referer**: Referer
-   * *   **api_cnt**: total number of calls
-   * *   **bot_cnt**: number of bot calls
-   * *   **cross_border_cnt**: number of cross-border requests
-   * *   **api_freq**: call frequency
+   * The type of statistics. Valid values:
+   * 
+   * - **api_ip**: total traffic.
+   * 
+   * - **api_cross_border_ip**: cross-border traffic.
+   * 
+   * - **api_bot_ip**: bot traffic.
+   * 
+   * - **remote_region**: geographic location statistics.
+   * 
+   * - **client_id**: client type statistics.
+   * 
+   * - **http_referer**: Referer statistics.
+   * 
+   * - **api_cnt**: total number of calls.
+   * 
+   * - **bot_cnt**: number of bot requests.
+   * 
+   * - **cross_border_cnt**: number of cross-border requests.
+   * 
+   * - **api_freq**: call frequency.
    * 
    * @example
    * api_ip

package/src/models/DescribeUserApiRequestResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeUserApiRequestResponseBodyRequests extends $dara.Model {
   /**
    * @remarks
-   * The number of entries returned.
+   * The number of statistics.
    * 
    * @example
    * 76
@@ -13,12 +13,15 @@ export class DescribeUserApiRequestResponseBodyRequests extends $dara.Model {
   count?: number;
   /**
    * @remarks
-   * The type of the statistics. Valid values:
+   * The statistics information. This includes:
    * 
-   * *   **client_list**: client
-   * *   **ip**: IP address
-   * *   **region_id** region
-   * *   **country_id**: country
+   * - **client_list**: the client tool.
+   * 
+   * - **ip**: the IP address information.
+   * 
+   * - **region_id**: the region.
+   * 
+   * - **country_id**: the country.
    * 
    * @example
    * {
@@ -65,7 +68,7 @@ export class DescribeUserApiRequestResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The statistics.
+   * The list of statistics.
    */
   requests?: DescribeUserApiRequestResponseBodyRequests[];
   static names(): { [key: string]: string } {

package/src/models/DescribeUserAssetRequest.ts

@@ -6,7 +6,7 @@ export class DescribeUserAssetRequest 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
@@ -14,16 +14,15 @@ export class DescribeUserAssetRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The type of the statistics. Valid values:
-   * 
-   * *   **asset_num**: total number of APIs
-   * *   **asset_active**: number of active APIs
-   * *   **asset_newborn**: number of new APIs
-   * *   **asset_offline**: number of deactivated APIs
-   * *   **asset_bot**: number of APIs that are called by bots
-   * *   **asset_cross_border**: number of APIs that are called for cross-border data transfer
-   * *   **sensitive_api**: number of response-sensitive APIs
-   * *   **sensitive_domain**: number of response-sensitive domain names
+   * The type of statistics. Valid values:
+   * - **asset_num**: total number of API assets.
+   * - **asset_active**: number of active APIs.
+   * - **asset_newborn**: number of APIs added today.
+   * - **asset_offline**: number of inactive APIs.
+   * - **asset_bot**: number of APIs with bot requests.
+   * - **asset_cross_border**: number of APIs with cross-border data transfer.
+   * - **sensitive_api**: number of APIs with sensitive data in responses.
+   * - **sensitive_domain**: number of sites with sensitive data in responses.
    * 
    * This parameter is required.
    * 
@@ -33,8 +32,8 @@ export class DescribeUserAssetRequest extends $dara.Model {
   dataType?: string;
   /**
    * @remarks
-   * The time at which the API was called. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
-   * >Notice: The parameter has been deprecated.
+   * The query time in UNIX timestamp format (UTC). Unit: seconds.
+   * >Notice: This parameter is deprecated.
    * 
    * @example
    * 1723435200
@@ -44,9 +43,9 @@ export class DescribeUserAssetRequest extends $dara.Model {
   days?: 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.
    * 
@@ -56,10 +55,11 @@ export class DescribeUserAssetRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region where the WAF instance is deployed. 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

package/src/models/DescribeUserAssetResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeUserAssetResponseBodyAssets extends $dara.Model {
   /**
    * @remarks
-   * The number of APIs returned.
+   * The number of statistics.
    * 
    * @example
    * 134
@@ -13,7 +13,7 @@ export class DescribeUserAssetResponseBodyAssets extends $dara.Model {
   assetNum?: number;
   /**
    * @remarks
-   * The time at which the API was called. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The time of the statistics in UNIX timestamp format (UTC). Unit: seconds.
    * 
    * @example
    * 1723435200
@@ -45,7 +45,7 @@ export class DescribeUserAssetResponseBodyAssets extends $dara.Model {
 export class DescribeUserAssetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The API statistics.
+   * The list of asset statistics.
    */
   assets?: DescribeUserAssetResponseBodyAssets[];
   /**

package/src/models/DescribeUserEventTrendRequest.ts

@@ -6,22 +6,27 @@ export class DescribeUserEventTrendRequest 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
    */
   clusterId?: string;
   /**
+   * @remarks
+   * The dimension of security events. Valid values:
+   * - **ip** (default): IP security events.
+   * - **account**: account security events.
+   * 
    * @example
    * ip
    */
   eventScope?: 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.
    * 
@@ -31,10 +36,11 @@ export class DescribeUserEventTrendRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region where the WAF instance is deployed. 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

package/src/models/DescribeUserEventTrendResponseBody.ts

@@ -29,8 +29,8 @@ export class DescribeUserEventTrendResponseBodyTrend extends $dara.Model {
   eventMedium?: number;
   /**
    * @remarks
-   * The time at which the API was called. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
-   * >Notice: The parameter has been deprecated, it is recommended to use the Timestamp parameter.
+   * The statistics time, in UNIX timestamp format (UTC). Unit: seconds.
+   * >Notice: This parameter is deprecated. Use the Timestamp parameter instead.
    * 
    * @example
    * 1723435200
@@ -40,7 +40,7 @@ export class DescribeUserEventTrendResponseBodyTrend extends $dara.Model {
   timeStamp?: number;
   /**
    * @remarks
-   * The time at which the API was called. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The statistics time, in UNIX timestamp format (UTC). Unit: seconds.
    * 
    * @example
    * 1723435200
@@ -86,7 +86,7 @@ export class DescribeUserEventTrendResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The trends of attacks.
+   * The attack trend list.
    */
   trend?: DescribeUserEventTrendResponseBodyTrend[];
   static names(): { [key: string]: string } {

package/src/models/DescribeUserEventTypeRequest.ts

@@ -6,7 +6,8 @@ export class DescribeUserEventTypeRequest 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. Call [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) to obtain information about hybrid cloud clusters.
    * 
    * @example
    * 976
@@ -14,22 +15,29 @@ export class DescribeUserEventTypeRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The end time of the query. The value is a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
    * 1726113600
    */
   endTime?: number;
   /**
+   * @remarks
+   * The dimension of the security event. Valid values:
+   * 
+   * - **ip** (default): IP security events.
+   * 
+   * - **account**: account security events.
+   * 
    * @example
    * ip
    */
   eventScope?: 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -39,10 +47,11 @@ export class DescribeUserEventTypeRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * The region of the WAF instance. Valid values:
    * 
-   * *   **cn-hangzhou**: Chinese mainland
-   * *   **ap-southeast-1**: outside the Chinese mainland
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -58,12 +67,18 @@ export class DescribeUserEventTypeRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The start time of the query. The value is a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
    * 1723435200
    */
   startTime?: number;
+  /**
+   * @remarks
+   * A list of security event statuses.
+   * 
+   * > By default, statistics are collected for security events in the **toBeConfirmed**, **confirmed**, and **actioned** states.
+   */
   userStatusList?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeUserEventTypeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeUserEventTypeResponseBodyEvent extends $dara.Model {
   /**
    * @remarks
-   * The code of the security event.
+   * The event code.
    * 
    * @example
    * Event_LoginCollision
@@ -21,7 +21,7 @@ export class DescribeUserEventTypeResponseBodyEvent extends $dara.Model {
   eventCount?: number;
   /**
    * @remarks
-   * The parent type of the security event.
+   * The parent type of the event.
    * 
    * @example
    * EventType_Account
@@ -29,12 +29,12 @@ export class DescribeUserEventTypeResponseBodyEvent extends $dara.Model {
   eventParentType?: string;
   /**
    * @remarks
-   * The type of the security event.
+   * The type of the event.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported types of security events.
+   * > Call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported event types.
    * 
    * @example
-   * Event_AbnormalFrequency
+   * Event_LoginCollision
    */
   eventType?: string;
   static names(): { [key: string]: string } {
@@ -67,12 +67,12 @@ export class DescribeUserEventTypeResponseBodyEvent extends $dara.Model {
 export class DescribeUserEventTypeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The types and statistics of security events.
+   * A list of security event types and their statistics.
    */
   event?: DescribeUserEventTypeResponseBodyEvent[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 177BA739-6512-5470-98C6-E***0BAA3D

package/src/models/DescribeUserLogFieldConfigRequest.ts

@@ -4,12 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeUserLogFieldConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The log delivery type. Valid values:
+   * 
+   * - **sls**: Simple Log Service.
+   * 
    * @example
    * sls
    */
   deliveryType?: string;
   /**
    * @remarks
+   * 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.
    * 
    * @example
@@ -17,11 +26,21 @@ export class DescribeUserLogFieldConfigRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The region in which 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 resource group.
+   * 
    * @example
    * rg-aek24******
    */