@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeApisecApiResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The API.
+   * The API operation.
    * 
    * @example
    * /auth/login
@@ -22,15 +22,14 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
    * The request method of the API. Valid values:
-   * 
-   * * **GET**
-   * * **POST**
-   * * **HEAD**
-   * * **PUT**
-   * * **DELETE**
-   * * **CONNECT**
-   * * **PATCH**
-   * * **OPTIONS**
+   * - **GET**: GET request.
+   * - **POST**: POST request.
+   * - **HEAD**: HEAD request.
+   * - **PUT**: PUT request.
+   * - **DELETE**: DELETE request.
+   * - **CONNECT**: CONNECT request.
+   * - **PATCH**: PATCH request.
+   * - **OPTIONS**: OPTIONS request.
    * 
    * @example
    * POST
@@ -38,11 +37,10 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiMethod?: string;
   /**
    * @remarks
-   * The API status. Valid values:
-   * 
-   * * **NewbornInterface**: The API is newly added.
-   * * **OfflineInterface**: The API is inactive.
-   * * **normal**: The API is normal.
+   * The status of the API. Valid values:
+   * - **NewbornInterface**: newly added.
+   * - **OfflineInterface**: inactive.
+   * - **normal**: normal.
    * 
    * @example
    * OfflineInterface
@@ -52,7 +50,7 @@ export class DescribeApisecApiResourcesRequest 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.
+   * > You can call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported business purposes.
    * 
    * @example
    * SendMail
@@ -61,10 +59,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
    * The service object. Valid values:
-   * 
-   * * **PublicAPI**: public services
-   * * **ThirdpartAPI**: cooperation with third-party partners
-   * * **InternalAPI**: internal office
+   * - **PublicAPI**: public service.
+   * - **ThirdpartAPI**: third-party collaboration.
+   * - **InternalAPI**: internal office.
    * 
    * @example
    * innerAPI
@@ -72,10 +69,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiType?: string;
   /**
    * @remarks
-   * Specifies whether authentication is required. Valid values:
-   * 
-   * * **0**: Authentication is required.
-   * * **1**: Authentication is not required.
+   * Specifies whether the API has an authentication field. Valid values:
+   * - **0**: has authentication.
+   * - **1**: does not have authentication.
    * 
    * @example
    * 0
@@ -84,8 +80,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
    * The ID of the hybrid cloud 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 applies only to hybrid cloud scenarios. You can call [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) to obtain hybrid cloud cluster information.
    * 
    * @example
    * 740
@@ -93,7 +88,7 @@ export class DescribeApisecApiResourcesRequest 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 time of the query, in UNIX timestamp (UTC) format. Unit: seconds.
    * 
    * @example
    * 1683388800
@@ -101,10 +96,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * Specifies whether to follow the API. Valid values:
-   * 
-   * * **1**: follows the API.
-   * * **0**: does not follow the API.
+   * Specifies whether the API is followed. Valid values:
+   * - **1**: followed.
+   * - **0**: not followed.
    * 
    * @example
    * 0
@@ -112,9 +106,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   follow?: 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.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to obtain the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -124,7 +118,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address to which the API operation belongs.
    * 
    * @example
    * a.aliyun.com
@@ -135,20 +129,19 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
    * The remarks.
    * 
    * @example
-   * API for logon
+   * loginApi
    */
   note?: string;
   /**
    * @remarks
-   * The name of the sorting field. Valid values:
-   * 
-   * * **allCnt**: the total number of calls to the API in the previous 30 days
-   * * **botCnt**: the number of bot-initiated requests in the previous 30 days
-   * * **crossBorderCnt**: the number of cross-border requests in the previous 30 days
-   * * **abnormalNum**: the number of API-related risks
-   * * **eventNum**: the number of API-related security events
-   * * **farthestTs**: the time when the API was first detected
-   * * **lastestTs**: the time of the most recent access to the API
+   * The name of the field used for sorting. Valid values:
+   * - **allCnt**: total access volume in the last 30 days.
+   * - **botCnt**: bot access volume in the last 30 days.
+   * - **crossBorderCnt**: cross-border access volume in the last 30 days.
+   * - **abnormalNum**: number of risks associated with the API.
+   * - **eventNum**: number of events associated with the API.
+   * - **farthestTs**: first discovery time.
+   * - **lastestTs**: most recent access time.
    * 
    * @example
    * allCnt
@@ -156,10 +149,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   orderKey?: string;
   /**
    * @remarks
-   * The sorting method. Valid values:
-   * 
-   * * **desc** (default): descending order
-   * * **asc**: ascending order
+   * The sort order. Valid values:
+   * - **desc**: descending order (default).
+   * - **asc**: ascending order.
    * 
    * @example
    * desc
@@ -167,7 +159,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   orderWay?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return in a paging query. Default value: **1**, which indicates that the first page is returned.
    * 
    * @example
    * 1
@@ -175,7 +167,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries to return on each page in a paging query. Default value: **10**, which indicates that each page contains 10 entries.
    * 
    * @example
    * 10
@@ -183,10 +175,11 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Value:
+   * 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
@@ -194,9 +187,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The sensitive data type in the request.
+   * The type of sensitive information in the request.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported sensitive data types.
+   * > You can call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported sensitive information types.
    * 
    * @example
    * 1004,1005
@@ -204,7 +197,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   requestSensitiveType?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The Alibaba Cloud resource group ID.
    * 
    * @example
    * rg-acfm***q
@@ -213,11 +206,10 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
    * The sensitivity level of the API. Valid values:
-   * 
-   * * **L1**: high sensitivity
-   * * **L2**: moderate sensitivity
-   * * **L3**: low sensitivity
-   * * **N**: non-sensitivity
+   * - **L1**: high sensitivity.
+   * - **L2**: medium sensitivity.
+   * - **L3**: low sensitivity.
+   * - **N**: not sensitive.
    * 
    * @example
    * L3
@@ -225,9 +217,8 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   sensitiveLevel?: string;
   /**
    * @remarks
-   * The sensitive data type in the response.
-   * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported sensitive data types.
+   * The type of sensitive data in the response.
+   * > You can call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported sensitive data types.
    * 
    * @example
    * 1004
@@ -235,7 +226,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   sensitiveType?: 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 query, in UNIX timestamp (UTC) format. Unit: seconds.
    * 
    * @example
    * 1681833600

package/src/models/DescribeApisecApiResourcesResponseBody.ts

@@ -5,28 +5,31 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of API-related risks.
+   * The number of risks associated with the API.
    * 
    * @example
    * 2
    */
   abnormalNum?: number;
   /**
+   * @remarks
+   * The number of account security events associated with the asset.
+   * 
    * @example
    * 1
    */
   accountEventNum?: number;
   /**
    * @remarks
-   * The total number of calls to this API in the previous 30 days.
+   * The total access volume in the last 30 days.
    * 
    * @example
-   * 10
+   * 1683388800
    */
   allCnt?: number;
   /**
    * @remarks
-   * The API.
+   * The API operation.
    * 
    * @example
    * /v1/etl/finddatabyvid
@@ -37,35 +40,34 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
    * The ID of the API.
    * 
    * @example
-   * 867ade***24ee6e205b8da82b8f84
+   * 197b52abcd81d6a8bd4***e477
    */
   apiId?: string;
   /**
    * @remarks
-   * 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
+   * The API information, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:
+   * - **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 field is returned only when the **ApiId** parameter is specified.
    */
   apiInfo?: string;
   /**
    * @remarks
    * The request method of the API. Valid values:
-   * 
-   * * **GET**
-   * * **POST**
-   * * **HEAD**
-   * * **PUT**
-   * * **DELETE**
-   * * **CONNECT**
-   * * **PATCH**
-   * * **OPTIONS**
+   * - **GET**: GET request.
+   * - **POST**: POST request.
+   * - **HEAD**: HEAD request.
+   * - **PUT**: PUT request.
+   * - **DELETE**: DELETE request.
+   * - **CONNECT**: CONNECT request.
+   * - **PATCH**: PATCH request.
+   * - **OPTIONS**: OPTIONS request.
    * 
    * @example
    * POST
@@ -73,12 +75,11 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiMethod?: string;
   /**
    * @remarks
-   * The API-related sensitive information. The value of this parameter is a JSON string that contains multiple parameters. The value includes the following parameters:
-   * 
-   * * **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
+   * The sensitive information involved in the API, which is a string converted from a JSON object constructed with a series of parameters. The parameters include:
+   * - **request_sensitive_list**: the list of sensitive data types in the request.
+   * - **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.
    * 
    * @example
    * {
@@ -91,7 +92,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitive?: string;
   /**
    * @remarks
-   * The sensitive data type in the request.
+   * The sensitive data in the API request.
    * 
    * @example
    * ["1002","1005"]
@@ -99,7 +100,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitiveRequest?: string;
   /**
    * @remarks
-   * The sensitive data type in the response.
+   * The sensitive data in the API response.
    * 
    * @example
    * ["1002","1005"]
@@ -107,11 +108,10 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiSensitiveResponse?: string;
   /**
    * @remarks
-   * The API status. Valid values:
-   * 
-   * *   **NewbornInterface**: The API is newly added.
-   * *   **OfflineInterface**: The API is inactive.
-   * *   **normal**: The API is normal.
+   * The status of the API. Valid values:
+   * - **NewbornInterface**: newly added.
+   * - **OfflineInterface**: inactive.
+   * - **normal**: normal.
    * 
    * @example
    * NewbornInterface
@@ -120,8 +120,7 @@ export class DescribeApisecApiResourcesResponseBodyData 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.
+   * > You can call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported business purposes.
    * 
    * @example
    * SendMail
@@ -130,10 +129,9 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The service object. Valid values:
-   * 
-   * *   **PublicAPI**: public services
-   * *   **ThirdpartAPI**: cooperation with third-party partners
-   * *   **InternalAPI**: internal office
+   * - **PublicAPI**: public service.
+   * - **ThirdpartAPI**: third-party collaboration.
+   * - **InternalAPI**: internal office.
    * 
    * @example
    * PublicAPI
@@ -141,10 +139,9 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   apiType?: string;
   /**
    * @remarks
-   * Indicates whether authentication is required. Valid values:
-   * 
-   * * **0**: Authentication is required.
-   * * **1**: Authentication is not required.
+   * Specifies whether the API has an authentication field. Valid values:
+   * - **0**: has authentication.
+   * - **1**: does not have authentication.
    * 
    * @example
    * 1
@@ -152,7 +149,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   authFlag?: string;
   /**
    * @remarks
-   * The number of bot-initiated requests in the previous 30 days.
+   * The bot access volume in the last 30 days.
    * 
    * @example
    * 2
@@ -160,7 +157,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   botCnt?: number;
   /**
    * @remarks
-   * The number of the cross-border requests in the previous 30 days.
+   * The cross-border access volume in the last 30 days.
    * 
    * @example
    * 2
@@ -168,7 +165,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   crossBorderCnt?: number;
   /**
    * @remarks
-   * The number of API-related security events.
+   * The number of security events associated with the API.
    * 
    * @example
    * 2
@@ -176,14 +173,14 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   eventNum?: number;
   /**
    * @remarks
-   * The sample APIs.
+   * The list of API samples.
    * 
    * @deprecated
    */
   examples?: string[];
   /**
    * @remarks
-   * The time when the API asset was first detected. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The time when the API asset was first discovered, in UNIX timestamp (UTC) format. Unit: seconds.
    * 
    * @example
    * 1683388800
@@ -191,10 +188,9 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   farthestTs?: number;
   /**
    * @remarks
-   * Specifies whether to follow the API. Valid values:
-   * 
-   * *   **1**: follows the API.
-   * *   **0**: does not follow the API.
+   * Specifies whether the API is followed. Valid values:
+   * - **1**: followed.
+   * - **0**: not followed.
    * 
    * @example
    * 1
@@ -202,7 +198,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   follow?: number;
   /**
    * @remarks
-   * The time at which the API was last accessed. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The most recent access time of the API asset, in UNIX timestamp (UTC) format. Unit: seconds.
    * 
    * @example
    * 1683388800
@@ -210,7 +206,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
   lastestTs?: number;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address to which the API operation belongs.
    * 
    * @example
    * a.aliyun.com
@@ -221,12 +217,12 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
    * The remarks.
    * 
    * @example
-   * Password changed
+   * loginApi
    */
   note?: string;
   /**
    * @remarks
-   * The list of protection objects corresponding to this asset.
+   * The list of protected objects corresponding to the asset.
    */
   resources?: string[];
   static names(): { [key: string]: string } {
@@ -305,7 +301,7 @@ export class DescribeApisecApiResourcesResponseBodyData extends $dara.Model {
 export class DescribeApisecApiResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The API assets.
+   * The list of API assets.
    */
   data?: DescribeApisecApiResourcesResponseBodyData[];
   /**

package/src/models/DescribeApisecAssetTrendRequest.ts

@@ -6,6 +6,7 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   /**
    * @remarks
    * The ID of the hybrid cloud cluster.
+   * > This parameter is available only in hybrid cloud scenarios. You can call [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) to obtain hybrid cloud cluster information.
    * 
    * @example
    * 590
@@ -13,17 +14,17 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.
+   * The end of the time range to query. The value is a UNIX timestamp (UTC). Unit: milliseconds.
    * 
    * @example
-   * 1683183599
+   * 1668496310000
    */
   endTime?: number;
   /**
    * @remarks
-   * The ID of the 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query instance ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -33,10 +34,11 @@ export class DescribeApisecAssetTrendRequest 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**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -52,10 +54,10 @@ export class DescribeApisecAssetTrendRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.
+   * The beginning of the time range to query. The value is a UNIX timestamp (UTC). Unit: milliseconds.
    * 
    * @example
-   * 1668496310
+   * 1668496310000
    */
   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 assets.
+   * The number of active APIs.
    * 
    * @example
    * 60
@@ -13,7 +13,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetActive?: number;
   /**
    * @remarks
-   * The total number of assets.
+   * The total number of API assets.
    * 
    * @example
    * 80
@@ -21,7 +21,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetCount?: number;
   /**
    * @remarks
-   * The number of deactivated assets.
+   * The number of inactive APIs.
    * 
    * @example
    * 20
@@ -29,7 +29,7 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
   assetOffline?: number;
   /**
    * @remarks
-   * The time for statistics. Specify a UNIX timestamp in UTC. Unit: seconds.
+   * The time of the statistics. The value is a UNIX timestamp (UTC). Unit: seconds.
    * 
    * @example
    * 1683600042
@@ -65,12 +65,12 @@ export class DescribeApisecAssetTrendResponseBodyData extends $dara.Model {
 export class DescribeApisecAssetTrendResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The data returned.
+   * The list of API asset information.
    */
   data?: DescribeApisecAssetTrendResponseBodyData[];
   /**
    * @remarks
-   * Id of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0