@alicloud/waf-openapi20211001 6.6.1 → 6.7.0

package/src/models/DescribeApisecEventDomainStatisticRequest.ts

@@ -5,9 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   /**
    * @remarks
-   * 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.
+   * 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
@@ -23,9 +22,9 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   endTime?: number;
   /**
    * @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 obtain 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.
    * 
@@ -35,11 +34,10 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The sort order of the results. Valid values:
-   * 
-   * - **asc**: sorts the results in ascending order.
+   * The sorting order. Valid values:
    * 
-   * - **desc**: sorts the results in descending order.
+   * - **asc**: ascending order.
+   * - **desc**: descending order.
    * 
    * @example
    * desc
@@ -47,7 +45,7 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   orderWay?: string;
   /**
    * @remarks
-   * The page number of the page to return. Default value: **1**.
+   * The page number. Default value: **1**.
    * 
    * @example
    * 1
@@ -55,19 +53,18 @@ export class DescribeApisecEventDomainStatisticRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **5**. Maximum value: **100**.
+   * The number of entries per page. Default value: **5**.
    * 
    * @example
-   * 10
+   * 5
    */
   pageSize?: number;
   /**
    * @remarks
-   * The region where 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

package/src/models/DescribeApisecEventDomainStatisticResponseBody.ts

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

package/src/models/DescribeApisecEventsRequest.ts

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

package/src/models/DescribeApisecEventsResponseBody.ts

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