@alicloud/waf-openapi20211001 6.5.2 → 6.6.1

package/src/models/DescribeApisecEventDomainStatisticRequest.ts

@@ -5,8 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecEventDomainStatisticRequest 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 available only for hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query Hybrid Cloud WAF clusters.
    * 
    * @example
    * 428
@@ -22,9 +23,9 @@ export class DescribeApisecEventDomainStatisticRequest 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 obtain the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -34,10 +35,11 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The sorting order. Valid values:
+   * The sort order of the results. Valid values:
+   * 
+   * - **asc**: sorts the results in ascending order.
    * 
-   * - **asc**: ascending order.
-   * - **desc**: descending order.
+   * - **desc**: sorts the results in descending order.
    * 
    * @example
    * desc
@@ -45,7 +47,7 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   orderWay?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -53,18 +55,19 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **5**.
+   * The number of entries per page. Default value: **5**. Maximum value: **100**.
    * 
    * @example
-   * 5
+   * 10
    */
   pageSize?: number;
   /**
    * @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

package/src/models/DescribeApisecEventDomainStatisticResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of APIs.
+   * The total number of APIs that have security events for the domain name.
    * 
    * @example
    * 10
@@ -13,7 +13,7 @@ export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Mo
   apiCount?: number;
   /**
    * @remarks
-   * The domain name.
+   * The domain name that is protected by WAF.
    * 
    * @example
    * a.aliyun.com
@@ -21,7 +21,7 @@ export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Mo
   domain?: string;
   /**
    * @remarks
-   * The number of high-risk security events.
+   * The number of high-risk security events for the domain name.
    * 
    * @example
    * 10
@@ -29,7 +29,7 @@ export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Mo
   high?: number;
   /**
    * @remarks
-   * The number of low-risk security events.
+   * The number of low-risk security events for the domain name.
    * 
    * @example
    * 2
@@ -37,7 +37,7 @@ export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Mo
   low?: number;
   /**
    * @remarks
-   * The number of medium-risk security events.
+   * The number of medium-risk security events for the domain name.
    * 
    * @example
    * 6
@@ -75,12 +75,12 @@ export class DescribeApisecEventDomainStatisticResponseBodyData extends $dara.Mo
 export class DescribeApisecEventDomainStatisticResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response parameters.
+   * The API security event statistics grouped by domain name.
    */
   data?: DescribeApisecEventDomainStatisticResponseBodyData[];
   /**
    * @remarks
-   * Id of the request.
+   * The ID of the request.
    * 
    * @example
    * 66A98669-*******-80A6-3014697B11AE
@@ -88,7 +88,7 @@ export class DescribeApisecEventDomainStatisticResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of domain names that have API security events.
    * 
    * @example
    * 10

package/src/models/DescribeApisecEventsRequest.ts

@@ -4,21 +4,24 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecEventsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The account that you want to use to filter events.
+   * 
    * @example
    * 1818743389962696
    */
   account?: string;
   /**
    * @remarks
-   * The API.
+   * The path of the API that is associated with the security event.
    * 
    * @example
-   * /apisec/v1/register.php
+   * /apisec/v1/***.php
    */
   apiFormat?: string;
   /**
    * @remarks
-   * The ID of the event-related API.
+   * The ID of the API.
    * 
    * @example
    * 820b860***6205da93b935b28
@@ -28,7 +31,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
    * @remarks
    * The business purpose of the API.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the business purposes of APIs.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported business purposes.
    * 
    * @example
    * SendMail
@@ -36,7 +39,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   apiTag?: string;
   /**
    * @remarks
-   * The Attack source IP.
+   * The IP address of the attacker that you want to use to filter events.
    * 
    * @example
    * 42.224.*.*
@@ -44,9 +47,9 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   attackIp?: string;
   /**
    * @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 required only in hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the IDs of hybrid cloud WAF clusters.
    * 
    * @example
    * 428
@@ -54,7 +57,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The end of the time range to query. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1683703260
@@ -72,24 +75,33 @@ export class DescribeApisecEventsRequest extends $dara.Model {
    * @remarks
    * The severity level of the event. Valid values:
    * 
-   * *   **high**
-   * *   **medium**
-   * *   **low**
+   * - **high**: high severity.
+   * 
+   * - **medium**: medium severity.
+   * 
+   * - **low**: low severity.
    * 
    * @example
    * low
    */
   eventLevel?: string;
   /**
+   * @remarks
+   * The dimension by which security events are categorized. Valid values:
+   * 
+   * - **ip**: IP security event. This is the default value.
+   * 
+   * - **account**: account security event.
+   * 
    * @example
    * ip
    */
   eventScope?: string;
   /**
    * @remarks
-   * The type of the event.
+   * The event type.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported event types.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported event types.
    * 
    * @example
    * ObtainSensitiveUnauthorized
@@ -99,7 +111,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
    * @remarks
    * The ID of the Web Application Firewall (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.
    * 
@@ -109,19 +121,21 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address that is protected by WAF.
    * 
    * @example
-   * a.aliyun.com
+   * a.***.com
    */
   matchedHost?: string;
   /**
    * @remarks
-   * The name of the sorting field. Valid values:
+   * The field that is used to sort the query results. Valid values:
    * 
-   * *   **allCnt**: the number of attacks
-   * *   **startTs**: the start time of the event
-   * *   **endTs**: the end time of the event
+   * - **allCnt**: the number of attacks.
+   * 
+   * - **startTs**: the start time of the event.
+   * 
+   * - **endTs**: the end time of the event.
    * 
    * @example
    * startTs
@@ -129,10 +143,11 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   orderKey?: string;
   /**
    * @remarks
-   * The sorting method. Valid values:
+   * The order in which the query results are sorted. Valid values:
    * 
-   * *   **desc** (default): descending order
-   * *   **asc**: ascending order
+   * - **desc**: descending order. This is the default value.
+   * 
+   * - **asc**: ascending order.
    * 
    * @example
    * desc
@@ -142,8 +157,9 @@ export class DescribeApisecEventsRequest extends $dara.Model {
    * @remarks
    * The source of the event type. Valid values:
    * 
-   * *   **custom**
-   * *   **default**
+   * - **custom**: a user-defined event type.
+   * 
+   * - **default**: a built-in event type.
    * 
    * @example
    * default
@@ -151,7 +167,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   origin?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -159,7 +175,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries to return on each page. Default value: **10**.
    * 
    * @example
    * 10
@@ -167,10 +183,11 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Value:
+   * The region where the WAF instance resides. 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
@@ -178,7 +195,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -186,7 +203,7 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1683648000
@@ -194,14 +211,18 @@ export class DescribeApisecEventsRequest extends $dara.Model {
   startTs?: number;
   /**
    * @remarks
-   * The event status. Valid values:
+   * The handling status of the event. Valid values:
+   * 
+   * - **toBeConfirmed**: pending confirmation.
+   * 
+   * - **confirmed**: confirmed but not yet handled.
+   * 
+   * - **actioned**: handled.
    * 
-   * *   **toBeConfirmed**
-   * *   **confirmed**
-   * *   **ignored**
+   * - **ignored**: ignored.
    * 
    * @example
-   * Ignore
+   * ignored
    */
   userStatus?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribeApisecEventsResponseBody.ts

@@ -5,8 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of attacks.
-   * >Notice: The parameter has been deprecated, please use the Attackips parameter.
+   * The total number of attacks in the security event.
    * 
    * @example
    * 10
@@ -14,7 +13,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   allCnt?: number;
   /**
    * @remarks
-   * The API.
+   * The path of the API that is associated with the security event.
    * 
    * @example
    * /apisec/v1/register.php
@@ -32,7 +31,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
    * @remarks
    * The business purpose of the API.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the business purposes of APIs.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported business purposes.
    * 
    * @example
    * SendMail
@@ -40,7 +39,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   apiTag?: string;
   /**
    * @remarks
-   * The client that is attacked.
+   * The type of client that initiated the attack, such as a browser or automation tool.
    * 
    * @example
    * Chrome
@@ -48,50 +47,68 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   attackClient?: string;
   /**
    * @remarks
-   * The information about the number of attacks. The value of this parameter is a JSON string that contains multiple parameters. Key indicates the timestamp in seconds, and Value indicates the number of attacks.
+   * The attack count over time. The value is a JSON string in which each key is a UNIX timestamp in seconds and each value is the number of attacks at that time.
    * 
    * @example
-   * {\\"1717498320\\":500,\\"1717498380\\":529,\\"1717498440\\":20,\\"1717498260\\":518,\\"1717498200\\":481,\\"1717498140\\":52}
+   * {
+   *     "1717498320": 500,
+   *     "1717498380": 529,
+   *     "1717498440": 20
+   * }
    * 
    * @deprecated
    */
   attackCntInfo?: string;
   /**
    * @remarks
-   * The source IP address of the attack.
+   * The IP address of the attacker. >Notice: This parameter is deprecated. Use the AttackIps parameter instead.
    * 
    * @example
-   * 104.234.140.33
+   * 104.234.140.**
    * 
    * @deprecated
    */
   attackIp?: string;
   /**
    * @remarks
-   * The information about the attack source IP address. The value of this parameter is a JSON string that contains multiple parameters. The value includes the following parameters:
+   * The information about the attacker IP address. The value is a JSON string that contains the following fields:
    * 
-   * *   **ip**: the IP address
-   * *   **country_id**: the country ID
-   * *   **region_id**: the region ID
-   * *   **cnt**: the number of attacks
+   * - **ip**: the IP address.
+   * 
+   * - **country_id**: the country.
+   * 
+   * - **region_id**: the region.
+   * 
+   * - **cnt**: the number of attacks.
    * 
    * @example
-   * [{\\"ip\\":\\"72.*.*.119\\",\\"country_id\\":\\"US\\",\\"region_id\\":\\"\\",\\"cnt\\":\\"2100\\"}]
+   * [
+   *     {
+   *         "ip": "72.*.*.119",
+   *         "country_id": "US",
+   *         "region_id": "",
+   *         "cnt": "2100"
+   *     }
+   * ]
    * 
    * @deprecated
    */
   attackIpInfo?: string;
   /**
    * @remarks
-   * The source IP addresses of the attacks.
+   * The list of attacker IP addresses.
    * 
    * @deprecated
    */
   attackIps?: string[];
+  /**
+   * @remarks
+   * The list of attackers that are associated with the security event.
+   */
   attackerList?: string[];
   /**
    * @remarks
-   * The end of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The end time of the event. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1683703260
@@ -99,7 +116,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   endTs?: number;
   /**
    * @remarks
-   * The ID of the event.
+   * The ID of the security event.
    * 
    * @example
    * c82cb276847e9c96f9597d9f4b0cdcff
@@ -107,14 +124,27 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   eventId?: string;
   /**
    * @remarks
-   * The details of the event. The value of this parameter is a JSON string that contains multiple parameters. The value includes the following parameters:
+   * The details of the security event. The value is a JSON string that contains the following fields:
+   * 
+   * - **ip_info**: the information about the attacker IP address. For more information, see the **AttackIpInfo** response parameter.
+   * 
+   * - **rule_id**: the ID of the rule that corresponds to the event.
    * 
-   * *   **ip_info**: the information about the attack source IP address. This parameter corresponds to the **AttackIpInfo** response parameter.
-   * *   **rule_id**: the ID of the rule corresponding to the event.
-   * *   **rule_tag**: the information about the rule corresponding to the event.
+   * - **rule_tag**: the information about the rule that corresponds to the event.
    * 
    * @example
-   * {}
+   * {
+   *     "ip_info": [
+   *         {
+   *             "ip": "112.224.143.**",
+   *             "country_id": "CN",
+   *             "region_id": "-",
+   *             "cnt": "4"
+   *         }
+   *     ],
+   *     "rule_id": "837**",
+   *     "rule_tag": "interface returns a large amount of sensitive information"
+   * }
    * 
    * @deprecated
    */
@@ -123,9 +153,11 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
    * @remarks
    * The severity level of the event. Valid values:
    * 
-   * *   **high**
-   * *   **medium**
-   * *   **low**
+   * - **high**: high severity.
+   * 
+   * - **medium**: medium severity.
+   * 
+   * - **low**: low severity.
    * 
    * @example
    * medium
@@ -133,9 +165,9 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   eventLevel?: string;
   /**
    * @remarks
-   * The type of the event.
+   * The event type.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported event types.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported event types.
    * 
    * @example
    * ObtainSensitiveUnauthorized
@@ -143,10 +175,11 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   eventTag?: string;
   /**
    * @remarks
-   * Indicates whether the API is followed. Valid values:
+   * Indicates whether the event is followed. Valid values:
+   * 
+   * - **1**: The event is followed.
    * 
-   * *   **1**: The API is followed.
-   * *   **0**: The API is not followed.
+   * - **0**: The event is not followed.
    * 
    * @example
    * 0
@@ -154,26 +187,27 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   follow?: number;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address that is protected by WAF.
    * 
    * @example
-   * a.aliyun.com
+   * a.***.com
    */
   matchedHost?: string;
   /**
    * @remarks
-   * The remarks.
+   * The remarks that are added to the security event.
    * 
    * @example
-   * Notified
+   * Notify
    */
   note?: string;
   /**
    * @remarks
    * The source of the event type. Valid values:
    * 
-   * *   **custom**
-   * *   **default**
+   * - **custom**: a user-defined event type.
+   * 
+   * - **default**: a built-in event type.
    * 
    * @example
    * custom
@@ -181,7 +215,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   origin?: string;
   /**
    * @remarks
-   * The country to which the attack source IP address belongs.
+   * The country where the attacker IP address is located.
    * 
    * @example
    * US
@@ -189,7 +223,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   remoteCountry?: string;
   /**
    * @remarks
-   * The region to which the attack source IP address belongs.
+   * The region where the attacker IP address is located.
    * 
    * @example
    * 110000
@@ -197,7 +231,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   remoteRegion?: string;
   /**
    * @remarks
-   * The sample API request. The value of this parameter is a JSON string that contains multiple parameters.
+   * A sample of the API request data. The value is a JSON string.
    * 
    * @example
    * {}
@@ -207,7 +241,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   requestData?: string;
   /**
    * @remarks
-   * The sample API response. The value of this parameter is a JSON string that contains multiple parameters.
+   * A sample of the API response data. The value is a JSON string.
    * 
    * @example
    * {}
@@ -217,7 +251,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   responseData?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The start time of the event. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1683648000
@@ -225,14 +259,18 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
   startTs?: number;
   /**
    * @remarks
-   * The event status. Valid values:
+   * The handling status of the event. Valid values:
+   * 
+   * - **toBeConfirmed**: pending confirmation.
+   * 
+   * - **confirmed**: confirmed but not yet handled.
+   * 
+   * - **actioned**: handled.
    * 
-   * *   **toBeConfirmed**
-   * *   **confirmed**
-   * *   **ignored**
+   * - **ignored**: ignored.
    * 
    * @example
-   * Ignore
+   * toBeConfirmed
    */
   userStatus?: string;
   static names(): { [key: string]: string } {
@@ -313,7 +351,7 @@ export class DescribeApisecEventsResponseBodyData extends $dara.Model {
 export class DescribeApisecEventsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The security events.
+   * The list of security events.
    */
   data?: DescribeApisecEventsResponseBodyData[];
   /**