@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

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[];
   /**

package/src/models/DescribeApisecExamplesRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecExamplesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The type of API security threat.
+   * 
    * @example
    * LackOfSpeedLimit
    */
   abnormalTag?: string;
   /**
    * @remarks
+   * The ID of the API.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,17 +22,33 @@ export class DescribeApisecExamplesRequest extends $dara.Model {
    */
   apiId?: string;
   /**
+   * @remarks
+   * The ID of the Hybrid Cloud WAF cluster.
+   * 
+   * > This parameter is available only in hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query information about Hybrid Cloud WAF clusters.
+   * 
    * @example
    * 176
    */
   clusterId?: string;
   /**
+   * @remarks
+   * The type of the example. Valid values:
+   * 
+   * - **sensitive**: sensitive data.
+   * 
+   * - **risk**: threat.
+   * 
    * @example
    * sensitive
    */
   exampleType?: 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
@@ -35,29 +56,49 @@ export class DescribeApisecExamplesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Valid values: 1 to 5. Default value: 5.
+   * 
    * @example
    * 5
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The region where 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 list of sensitive data types in requests.
+   */
   requestSensitiveTypeList?: string[];
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
-   * @example
-   * LackOfSpeedLimit
+   * @remarks
+   * The list of sensitive data types in responses.
    */
   responseSensitiveTypeList?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeApisecExamplesResponseBody.ts

@@ -4,10 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData extends $dara.Model {
   /**
+   * @remarks
+   * The code that indicates the type of sensitive data in the request.
+   * 
    * @example
    * 1000
    */
   sensitiveCode?: string;
+  /**
+   * @remarks
+   * The list of sensitive data.
+   */
   sensitiveDataList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -37,10 +44,17 @@ export class DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData exte
 
 export class DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData extends $dara.Model {
   /**
+   * @remarks
+   * The code that indicates the type of sensitive data in the response.
+   * 
    * @example
    * 1000
    */
   sensitiveCode?: string;
+  /**
+   * @remarks
+   * The list of sensitive data.
+   */
   sensitiveDataList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -70,19 +84,68 @@ export class DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData ext
 
 export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
   /**
+   * @remarks
+   * The complete URL of the API request.
+   * 
    * @example
    * http://www.test.com/api/v1/hello.php?token=TkJGQw
    */
   apiUrl?: string;
+  /**
+   * @remarks
+   * The proof-of-concept (PoC) request.
+   */
   pocPayload?: string;
   /**
+   * @remarks
+   * The protocol type of the API request. Valid values:
+   * 
+   * - **http**: HTTP
+   * 
+   * - **https**: HTTPS
+   * 
    * @example
    * http
    */
   protocol?: string;
+  /**
+   * @remarks
+   * The content of the sample request. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields:
+   * 
+   * - **method**: the request method.
+   * 
+   * - **host**: the requested domain name.
+   * 
+   * - **header**: the request header.
+   * 
+   * - **server_port**: the service port.
+   * 
+   * - **body**: the request body.
+   * 
+   * - **url**: the URI of the request.
+   * 
+   * - **server_protocol**: the server-side protocol.
+   * 
+   * > If the **body** content exceeds 16 KB, only a portion of the content is returned.
+   */
   request?: string;
+  /**
+   * @remarks
+   * The list of sensitive data in the request.
+   */
   requestSensitiveData?: DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData[];
   /**
+   * @remarks
+   * The content of the sample response. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields:
+   * 
+   * - **status**: the status code.
+   * 
+   * - **header**: the response header.
+   * 
+   * - **body**: the response body.
+   * 
+   * > If the **body** content exceeds 16 KB, only a portion of the content is returned.
+   * 
    * @example
    * {
    *   "header": {
@@ -95,6 +158,10 @@ export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
    * }
    */
   response?: string;
+  /**
+   * @remarks
+   * The list of sensitive data in the response.
+   */
   responseSensitiveData?: DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData[];
   static names(): { [key: string]: string } {
     return {
@@ -136,23 +203,39 @@ export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
 }
 
 export class DescribeApisecExamplesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API security examples.
+   */
   examples?: DescribeApisecExamplesResponseBodyExamples[];
   /**
+   * @remarks
+   * The number of entries returned on each page. Valid values: 1 to 5. Default value: 5.
+   * 
    * @example
    * 5
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 5
    */

package/src/models/DescribeApisecLogDeliveriesRequest.ts

@@ -7,7 +7,7 @@ export class DescribeApisecLogDeliveriesRequest 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.
+   * > 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,8 +19,9 @@ export class DescribeApisecLogDeliveriesRequest 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/DescribeApisecLogDeliveriesResponseBody.ts

@@ -7,9 +7,11 @@ export class DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs extends $dar
    * @remarks
    * The type of the log subscription. Valid values:
    * 
-   * *   **risk**: risk information.
-   * *   **event**: attack event information.
-   * *   **asset**: asset information.
+   * - **risk**: risk information.
+   * 
+   * - **event**: attack event information.
+   * 
+   * - **asset**: asset information.
    * 
    * @example
    * risk
@@ -43,8 +45,9 @@ export class DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs extends $dar
    * @remarks
    * The status of API security log subscription. Valid values:
    * 
-   * *   **true**: enabled.
-   * *   **false**: disabled.
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
    * 
    * @example
    * true
@@ -87,7 +90,7 @@ export class DescribeApisecLogDeliveriesResponseBody extends $dara.Model {
   deliveryConfigs?: DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 2EFCFE18-78F8-5079-B312-07***48B

package/src/models/DescribeApisecMatchedHostsRequest.ts

@@ -6,7 +6,7 @@ export class DescribeApisecMatchedHostsRequest 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
    * 433
@@ -14,9 +14,9 @@ export class DescribeApisecMatchedHostsRequest 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.
    * 
@@ -34,7 +34,7 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return in a paging query. Default value: **1**, which indicates the first page.
    * 
    * @example
    * 1
@@ -42,7 +42,7 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries per page in a paging query. Default value: **10**, which indicates 10 entries per page.
    * 
    * @example
    * 8
@@ -50,10 +50,11 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   pageSize?: 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**: Chinese mainland
-   * *   **ap-southeast-1**: outside the Chinese mainland
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -70,10 +71,9 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   /**
    * @remarks
    * The detection type. Valid values:
-   * 
-   * *   **api**: API-related domain names
-   * *   **abnormal**: risk-related domain names
-   * *   **event**: security event-related domain names
+   * - **api**: the domain name list of API assets.
+   * - **abnormal**: the domain name list of risks.
+   * - **event**: the domain name list of security events.
    * 
    * @example
    * event