@alicloud/waf-openapi20211001 6.6.1 → 6.7.0

package/src/models/DescribeApisecApiResourcesResponseBody.ts

@@ -5,31 +5,28 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of threats associated with the API.
+   * The number of API-related risks.
    * 
    * @example
    * 2
    */
   abnormalNum?: number;
   /**
-   * @remarks
-   * The number of account security events associated with the API.
-   * 
    * @example
    * 1
    */
   accountEventNum?: number;
   /**
    * @remarks
-   * The total number of requests in the last 30 days.
+   * The total number of calls to this API in the previous 30 days.
    * 
    * @example
-   * 1683388800
+   * 10
    */
   allCnt?: number;
   /**
    * @remarks
-   * The API endpoint path.
+   * The API.
    * 
    * @example
    * /v1/etl/finddatabyvid
@@ -40,35 +37,35 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
    * The ID of the API.
    * 
    * @example
-   * 197b52abcd81d6a8bd4***e477
+   * 867ade***24ee6e205b8da82b8f84
    */
   apiId?: string;
   /**
    * @remarks
-   * The detailed information about the API. The value is a JSON string that contains the following fields:
-   * 
-   * - **param_num**: the number of API parameters.
-   * 
-   * - **request_method**: the request method.
-   * 
-   * - **protocol**: the request protocol.
-   * 
-   * - **api_url**: the request URL.
-   * 
-   * - **poc_payload**: the request.
-   * 
-   * - **request**: the request sample.
-   * 
-   * - **response**: the response sample.
-   * 
-   * - **param**: the request parameters.
-   * 
-   * > This parameter is returned only when you specify the **ApiId** request parameter.
+   * The API-related information. The value of this parameter is a JSON string that contains multiple parameters. The value includes the following parameters:
+   * 
+   * * **param_num**: the number of API parameters
+   * * **request_method**: the request method
+   * * **protocol**: the request protocol
+   * * **api_url**: the request URL
+   * * **poc_payload**: the request
+   * * **request**: the sample request
+   * * **response**: the sample response
+   * * **param**: the request parameters
    */
   apiInfo?: string;
   /**
    * @remarks
-   * The HTTP request method of the API. Valid values: **GET**, **POST**, **HEAD**, **PUT**, **DELETE**, **CONNECT**, **PATCH**, and **OPTIONS**.
+   * The request method of the API. Valid values:
+   * 
+   * * **GET**
+   * * **POST**
+   * * **HEAD**
+   * * **PUT**
+   * * **DELETE**
+   * * **CONNECT**
+   * * **PATCH**
+   * * **OPTIONS**
    * 
    * @example
    * POST
@@ -76,15 +73,12 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiMethod?: string;
   /**
    * @remarks
-   * The sensitive data classification of the API. The value is a JSON string that contains the following fields:
-   * 
-   * - **request_sensitive_list**: the list of sensitive data types in the request.
+   * The API-related sensitive information. The value of this parameter is a JSON string that contains multiple parameters. The value includes the following parameters:
    * 
-   * - **response_sensitive_list**: the list of sensitive data types in the response.
-   * 
-   * - **sensitive_list**: the list of sensitive data types.
-   * 
-   * - **sensitive_level**: the sensitivity level.
+   * * **request_sensitive_list**: the sensitive data type in the request
+   * * **response_sensitive_list**: the sensitive data type in the response
+   * * **sensitive_list**: sensitive data types
+   * * **sensitive_level**: sensitivity level
    * 
    * @example
    * {
@@ -97,7 +91,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitive?: string;
   /**
    * @remarks
-   * The types of sensitive data detected in the API request. The value is a JSON array of sensitive data type IDs.
+   * The sensitive data type in the request.
    * 
    * @example
    * ["1002","1005"]
@@ -105,7 +99,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitiveRequest?: string;
   /**
    * @remarks
-   * The types of sensitive data detected in the API response. The value is a JSON array of sensitive data type IDs.
+   * The sensitive data type in the response.
    * 
    * @example
    * ["1002","1005"]
@@ -113,13 +107,11 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitiveResponse?: string;
   /**
    * @remarks
-   * The lifecycle status of the API. Valid values:
-   * 
-   * - **NewbornInterface**: newly discovered.
+   * The API status. Valid values:
    * 
-   * - **OfflineInterface**: inactive.
-   * 
-   * - **normal**: active.
+   * *   **NewbornInterface**: The API is newly added.
+   * *   **OfflineInterface**: The API is inactive.
+   * *   **normal**: The API is normal.
    * 
    * @example
    * NewbornInterface
@@ -129,7 +121,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
    * @remarks
    * The business purpose of the API.
    * 
-   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to obtain 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
@@ -137,13 +129,11 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiTag?: string;
   /**
    * @remarks
-   * The type of service that the API serves. Valid values:
-   * 
-   * - **PublicAPI**: public-facing service.
-   * 
-   * - **ThirdpartAPI**: third-party service.
+   * The service object. Valid values:
    * 
-   * - **InternalAPI**: internal service.
+   * *   **PublicAPI**: public services
+   * *   **ThirdpartAPI**: cooperation with third-party partners
+   * *   **InternalAPI**: internal office
    * 
    * @example
    * PublicAPI
@@ -151,11 +141,10 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiType?: string;
   /**
    * @remarks
-   * Indicates whether the API requires authentication. Valid values:
+   * Indicates whether authentication is required. Valid values:
    * 
-   * - **0**: The API requires authentication.
-   * 
-   * - **1**: The API does not require authentication.
+   * * **0**: Authentication is required.
+   * * **1**: Authentication is not required.
    * 
    * @example
    * 1
@@ -163,7 +152,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   authFlag?: string;
   /**
    * @remarks
-   * The number of bot requests in the last 30 days.
+   * The number of bot-initiated requests in the previous 30 days.
    * 
    * @example
    * 2
@@ -171,7 +160,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   botCnt?: number;
   /**
    * @remarks
-   * The number of cross-border requests in the last 30 days.
+   * The number of the cross-border requests in the previous 30 days.
    * 
    * @example
    * 2
@@ -179,7 +168,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   crossBorderCnt?: number;
   /**
    * @remarks
-   * The number of security events associated with the API.
+   * The number of API-related security events.
    * 
    * @example
    * 2
@@ -187,14 +176,14 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   eventNum?: number;
   /**
    * @remarks
-   * The list of API samples.
+   * The sample APIs.
    * 
    * @deprecated
    */
   examples?: string[];
   /**
    * @remarks
-   * The time when the API was first discovered. The value is a UNIX timestamp. Unit: seconds.
+   * The time when the API asset was first detected. This value is a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
    * 1683388800
@@ -202,11 +191,10 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   farthestTs?: number;
   /**
    * @remarks
-   * Indicates whether the API is followed. Valid values:
-   * 
-   * - **1**: The API is followed.
+   * Specifies whether to follow the API. Valid values:
    * 
-   * - **0**: The API is not followed.
+   * *   **1**: follows the API.
+   * *   **0**: does not follow the API.
    * 
    * @example
    * 1
@@ -214,7 +202,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   follow?: number;
   /**
    * @remarks
-   * The time of the most recent access to the API. The value is a UNIX timestamp. Unit: seconds.
+   * The time at which the API was last accessed. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
    * 
    * @example
    * 1683388800
@@ -222,7 +210,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   lastestTs?: number;
   /**
    * @remarks
-   * The domain name or IP address that the API resides on.
+   * The domain name or IP address of the API.
    * 
    * @example
    * a.aliyun.com
@@ -230,15 +218,15 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The remarks of the API asset.
+   * The remarks.
    * 
    * @example
-   * loginApi
+   * Password changed
    */
   note?: string;
   /**
    * @remarks
-   * The list of protected objects associated with the API.
+   * The list of protection objects corresponding to this asset.
    */
   resources?: string[];
   static names(): { [key: string]: string } {
@@ -317,7 +305,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
 export class DescribeApisecApiResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of API assets.
+   * The API assets.
    */
   data?: DescribeApisecApiResourcesResponseBodyData[];
   /**
@@ -330,7 +318,7 @@ export class DescribeApisecApiResourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of returned entries.
+   * The total number of entries returned.
    * 
    * @example
    * 5

package/src/models/DescribeApisecAssetTrendRequest.ts

@@ -5,9 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecAssetTrendRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the hybrid cloud WAF cluster.
-   * 
-   * > This parameter is applicable only to hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the ID of the hybrid cloud WAF cluster.
+   * The ID of the hybrid cloud cluster.
    * 
    * @example
    * 590
@@ -15,17 +13,17 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.
+   * The end of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
-   * 1668496310000
+   * 1683183599
    */
   endTime?: number;
   /**
    * @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.
+   * >  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 +33,10 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which 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
@@ -47,7 +44,7 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-aek**7uq
@@ -55,10 +52,10 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.
+   * The beginning of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
-   * 1668496310000
+   * 1668496310
    */
   startTime?: number;
   static names(): { [key: string]: string } {

package/src/models/DescribeApisecAssetTrendResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of active APIs.
+   * The number of active assets.
    * 
    * @example
    * 60
@@ -13,7 +13,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetActive?: number;
   /**
    * @remarks
-   * The total number of API assets.
+   * The total number of assets.
    * 
    * @example
    * 80
@@ -21,7 +21,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetCount?: number;
   /**
    * @remarks
-   * The number of inactive APIs.
+   * The number of deactivated assets.
    * 
    * @example
    * 20
@@ -29,7 +29,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetOffline?: number;
   /**
    * @remarks
-   * The timestamp of the data point. This value is a UNIX timestamp. Unit: seconds.
+   * The time for statistics. Specify a UNIX timestamp in UTC. Unit: seconds.
    * 
    * @example
    * 1683600042
@@ -65,12 +65,12 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
 export class DescribeApisecAssetTrendResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The API asset trend data.
+   * The data returned.
    */
   data?: DescribeApisecAssetTrendResponseBodyData[];
   /**
    * @remarks
-   * The request ID.
+   * Id of the request.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0

package/src/models/DescribeApisecEventDetailRequest.ts

@@ -4,41 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecEventDetailRequest extends $dara.Model {
   /**
-   * @remarks
-   * The ID of the Hybrid Cloud WAF cluster.
-   * 
-   * > This parameter applies only to hybrid cloud scenarios. You can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query information about hybrid cloud WAF clusters.
-   * 
    * @example
    * 428
    */
   clusterId?: string;
   /**
-   * @remarks
-   * The type of the detailed information about the security event. Valid values:
-   * 
-   * - **event_info** (default): attack details.
-   * 
-   * - **api_info**: API information.
-   * 
-   * - **cnt_info**: attack trend.
-   * 
-   * - **ip_info**: attacker IP information.
-   * 
-   * - **sensitive_info**: information about access to sensitive data.
-   * 
-   * - **request_data**: request information.
-   * 
-   * - **response_data**: response information.
-   * 
    * @example
    * event_info
    */
   detailType?: string;
   /**
    * @remarks
-   * The ID of the API security event.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -46,23 +22,12 @@ export class DescribeApisecEventDetailRequest extends $dara.Model {
    */
   eventId?: string;
   /**
-   * @remarks
-   * The dimension of the security event. Valid values:
-   * 
-   * - **ip** (default): IP security event.
-   * 
-   * - **account**: account security event.
-   * 
    * @example
    * ip
    */
   eventScope?: string;
   /**
    * @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.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -70,21 +35,11 @@ export class DescribeApisecEventDetailRequest extends $dara.Model {
    */
   instanceId?: 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 ID of the Alibaba Cloud resource group.
-   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeApisecEventDetailResponseBody.ts

@@ -4,126 +4,62 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecEventDetailResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The total number of attacks in the security event.
-   * 
    * @example
    * 345
    */
   attackCnt?: string;
-  /**
-   * @remarks
-   * The list of attackers associated with the security event.
-   */
   attackerList?: string[];
   /**
-   * @remarks
-   * The details of the security event.
-   * 
    * @example
    * {\\"location\\":[\\"FR\\",\\"CN\\"],\\"location_type\\":\\"country\\"}
    */
   detailValue?: string;
   /**
-   * @remarks
-   * The end of the time range during which the security event occurred. This value is a UNIX timestamp. Unit: seconds.
-   * 
    * @example
    * 1683703260
    */
   endTs?: string;
   /**
-   * @remarks
-   * The ID of the API security event.
-   * 
    * @example
    * 18ba94fea9***e66ba0557b7b91
    */
   eventId?: string;
   /**
-   * @remarks
-   * The severity level of the security event. Valid values:
-   * 
-   * - **high**: high severity.
-   * 
-   * - **medium**: medium severity.
-   * 
-   * - **low**: low severity.
-   * 
    * @example
    * low
    */
   eventLevel?: string;
   /**
-   * @remarks
-   * The dimension of the security event. Valid values:
-   * 
-   * - **ip** (default): IP security event.
-   * 
-   * - **account**: account security event.
-   * 
    * @example
    * ip
    */
   eventScope?: string;
   /**
-   * @remarks
-   * The type of the security event.
-   * 
-   * > You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported event types.
-   * 
    * @example
    * ObtainSensitiveUnauthorized
    */
   eventTag?: string;
   /**
-   * @remarks
-   * The remarks added to the security event.
-   * 
    * @example
    * already confirmed.
    */
   note?: string;
   /**
-   * @remarks
-   * The source of the event type rule. Valid values:
-   * 
-   * - **custom**: a user-defined rule.
-   * 
-   * - **default**: a built-in rule.
-   * 
    * @example
    * custom
    */
   origin?: string;
   /**
-   * @remarks
-   * The ID of the request.
-   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
   /**
-   * @remarks
-   * The beginning of the time range during which the security event occurred. This value is a UNIX timestamp. Unit: seconds.
-   * 
    * @example
    * 1683648000
    */
   startTs?: string;
   /**
-   * @remarks
-   * The event status. Valid values:
-   * 
-   * - **toBeConfirmed**: to be confirmed.
-   * 
-   * - **confirmed**: confirmed.
-   * 
-   * - **actioned**: handled.
-   * 
-   * - **ignored**: ignored.
-   * 
    * @example
    * toBeConfirmed
    */