@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeApisecMatchedHostsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecMatchedHostsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of APIs related to the domain name.
+   * The number of queries.
    * 
    * @example
    * 31
@@ -45,7 +45,7 @@ export class DescribeApisecMatchedHostsResponseBodyData extends $dara.Model {
 export class DescribeApisecMatchedHostsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The domain names.
+   * The list of domain names.
    */
   data?: DescribeApisecMatchedHostsResponseBodyData[];
   /**

package/src/models/DescribeApisecProtectionGroupsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The API security detection switch.
    * 
    * @example
    * 1
@@ -13,9 +13,9 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   apisecStatus?: 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -41,10 +41,11 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * 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
@@ -52,7 +53,7 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the protected object group to which the protected object belongs.
+   * The name of the protected object group.
    * 
    * @example
    * group1

package/src/models/DescribeApisecProtectionGroupsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The master switch for API security.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
   apisecStatus?: number;
   /**
    * @remarks
-   * The switch of the compliance check feature.
+   * The compliance check switch.
    * 
    * @example
    * 0
@@ -29,7 +29,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
   resourceGroup?: string;
   /**
    * @remarks
-   * The switch of the tracing and auditing feature.
+   * The traceability audit switch.
    * 
    * @example
    * 0
@@ -65,7 +65,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
 export class DescribeApisecProtectionGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The protected object groups.
+   * The list of protected object groups.
    */
   data?: DescribeApisecProtectionGroupsResponseBodyData[];
   /**

package/src/models/DescribeApisecProtectionResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The global switch for API security.
    * 
    * @example
    * 1
@@ -13,9 +13,9 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   apisecStatus?: 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 the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query instance ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return when you perform a paged query. Default value: **1**, which indicates the first page. For more information about paging, see the API reference.
    * 
    * @example
    * 1
@@ -33,7 +33,7 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries per page when you perform a paged query. Default value: **10**, which indicates 10 entries per page. For more information about paging, see the API reference.
    * 
    * @example
    * 10
@@ -41,10 +41,11 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * The region in which 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

package/src/models/DescribeApisecProtectionResourcesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The global switch for API security.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
   apisecStatus?: number;
   /**
    * @remarks
-   * The switch of the compliance check feature.
+   * The status of the compliance review switch.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
   resource?: string;
   /**
    * @remarks
-   * The switch of the tracing and auditing feature.
+   * The status of the tracing audit switch.
    * 
    * @example
    * 0
@@ -65,7 +65,7 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
 export class DescribeApisecProtectionResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The protected objects.
+   * The list of protected objects.
    */
   data?: DescribeApisecProtectionResourcesResponseBodyData[];
   /**

package/src/models/DescribeApisecRulesRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecRulesRequest extends $dara.Model {
   /**
    * @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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -15,23 +15,39 @@ export class DescribeApisecRulesRequest extends $dara.Model {
    * waf_elasticity-cn-0x***
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The language of the response. Valid values:
+   * 
+   * - **zh** (default): Chinese
+   * 
+   * - **en**: English
+   * 
+   * @example
+   * zh
+   */
   lang?: string;
   /**
    * @remarks
-   * The level of the policy.
+   * The level of the rule.
+   * 
+   * For threat detection (risk) and security events (event), valid values are:
+   * 
+   * - **high**: important
+   * 
+   * - **medium**: medium
+   * 
+   * - **low**: low
+   * 
+   * For sensitive data (sensitive_word), valid values are:
    * 
-   * If Type is set to risk or event, you can set this parameter to one of the following values:
+   * - **S1**: S1
    * 
-   * *   **high**
-   * *   **medium**
-   * *   **low**
+   * - **S2**: S2
    * 
-   * If Type is set to sensitive_word, you can set this parameter to one of the following values:
+   * - **S3**: S3
    * 
-   * *   **S1**
-   * *   **S2**
-   * *   **S3**
-   * *   **S4**
+   * - **S4**: S4
    * 
    * @example
    * high
@@ -39,18 +55,19 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   level?: string;
   /**
    * @remarks
-   * The name of the policy.
+   * The name of the rule.
    * 
    * @example
-   * Information Leak
+   * information leakage
    */
   name?: string;
   /**
    * @remarks
-   * The source of the policy. Valid values:
+   * The source of the rule. Valid values:
    * 
-   * *   **custom**
-   * *   **default**
+   * - **custom**: custom
+   * 
+   * - **default**: built-in
    * 
    * @example
    * custom
@@ -58,7 +75,7 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   origin?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -66,7 +83,7 @@ export class DescribeApisecRulesRequest 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
@@ -74,10 +91,11 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region of the WAF instance. 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
@@ -85,7 +103,7 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -93,10 +111,11 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The status of the policy. Valid values:
+   * The enabling status of the rule. Valid values:
+   * 
+   * - **1**: enabled
    * 
-   * *   **1**: enabled
-   * *   **0**: disabled
+   * - **0**: disabled
    * 
    * @example
    * 1
@@ -104,17 +123,25 @@ export class DescribeApisecRulesRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The type of the policy. Valid values:
-   * 
-   * *   **risk**: risk detection
-   * *   **event**: security event
-   * *   **sensitive_word**: sensitive data
-   * *   **auth_flag**: authentication credential
-   * *   **api_tag**: business purpose
-   * *   **desensitization**: masking
-   * *   **whitelist**: whitelist
-   * *   **recognition**: API recognition
-   * *   **offline_api**: lifecycle management
+   * The type of the rule. Valid values:
+   * 
+   * - **risk**: threat detection
+   * 
+   * - **event**: security event
+   * 
+   * - **sensitive_word**: sensitive data
+   * 
+   * - **auth_flag**: authentication credential
+   * 
+   * - **api_tag**: business purpose
+   * 
+   * - **desensitization**: data masking
+   * 
+   * - **whitelist**: whitelist
+   * 
+   * - **recognition**: API
+   * 
+   * - **offline_api**: lifecycle management
    * 
    * This parameter is required.
    * 

package/src/models/DescribeApisecRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecRulesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the policy.
+   * The ID of the rule.
    * 
    * @example
    * 34933
@@ -13,7 +13,7 @@ export class DescribeApisecRulesResponseBodyData extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The details of the policy. The value is a string that consists of multiple parameters in the JSON format.
+   * The details of the rule. The value is a string that is converted from a JSON object.
    * 
    * @example
    * {
@@ -28,10 +28,11 @@ export class DescribeApisecRulesResponseBodyData extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The status of the policy. Valid values:
+   * The status of the rule. Valid values:
    * 
-   * *   **1**: enabled
-   * *   **0**: disabled
+   * - **1**: enabled
+   * 
+   * - **0**: disabled
    * 
    * @example
    * 1
@@ -39,17 +40,25 @@ export class DescribeApisecRulesResponseBodyData extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The type of the policy. Valid values:
-   * 
-   * *   **risk**: risk detection
-   * *   **event**: security event
-   * *   **sensitive_word**: sensitive data
-   * *   **auth_flag**: authentication credential
-   * *   **api_tag**: business purpose
-   * *   **desensitization**: data masking
-   * *   **whitelist**: whitelist
-   * *   **recognition**: API recognition
-   * *   **offline_api**: lifecycle management
+   * The type of the rule. Valid values:
+   * 
+   * - **risk**: threat detection
+   * 
+   * - **event**: security event
+   * 
+   * - **sensitive_word**: sensitive data
+   * 
+   * - **auth_flag**: authentication credential
+   * 
+   * - **api_tag**: business purpose
+   * 
+   * - **desensitization**: data masking
+   * 
+   * - **whitelist**: whitelist
+   * 
+   * - **recognition**: API.
+   * 
+   * - **offline_api**: lifecycle management
    * 
    * @example
    * risk
@@ -57,7 +66,7 @@ export class DescribeApisecRulesResponseBodyData extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The time when the policy was updated. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The time when the rule was updated. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1721095301
@@ -95,12 +104,12 @@ export class DescribeApisecRulesResponseBodyData extends $dara.Model {
 export class DescribeApisecRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The policies.
+   * The list of rules.
    */
   data?: DescribeApisecRulesResponseBodyData[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0

package/src/models/DescribeApisecSensitiveDomainStatisticRequest.ts

@@ -6,6 +6,7 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   /**
    * @remarks
    * The ID of the hybrid cloud cluster.
+   * > 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
    * 428
@@ -13,7 +14,7 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify a UNIX timestamp in UTC. Unit: milliseconds.
+   * The end time. This value is a UNIX timestamp (UTC) in milliseconds.
    * 
    * @example
    * 1686895256
@@ -21,9 +22,9 @@ export class DescribeApisecSensitiveDomainStatisticRequest 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 [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -33,10 +34,11 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The sorting order. Valid values:
+   * The sort order of the list. Valid values:
    * 
-   * -  **asc**: ascending order.
-   * - **desc**: descending order.
+   * - asc: ascending order.
+   * 
+   * - desc: descending order.
    * 
    * @example
    * desc
@@ -44,7 +46,7 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   orderWay?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number of the page to return in a paged query. Default value: **1**, which indicates the first page. For more information about paging, see the paging parameters.
    * 
    * @example
    * 1
@@ -52,18 +54,19 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **5**.
+   * The number of entries per page in a paged query. Default value: **5**, which indicates 5 entries per page. For more information about paging, see the paging parameters.
    * 
    * @example
-   * 5
+   * 10
    */
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * 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
@@ -79,7 +82,7 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify a UNIX timestamp in UTC. Unit: milliseconds.
+   * The start time. This value is a UNIX timestamp (UTC) in milliseconds.
    * 
    * @example
    * 1668496310
@@ -87,10 +90,11 @@ export class DescribeApisecSensitiveDomainStatisticRequest extends $dara.Model {
   startTime?: number;
   /**
    * @remarks
-   * The sensitive data type. Valid values:
+   * The type of sensitive data. Valid values:
+   * 
+   * - request: request sensitive data.
    * 
-   * - **request**: sensitive data in requests.
-   * - **response**: sensitive data in responses.
+   * - response: response sensitive data.
    * 
    * @example
    * request

package/src/models/DescribeApisecSensitiveDomainStatisticResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecSensitiveDomainStatisticResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of APIs that are involved.
+   * The number of involved APIs.
    * 
    * @example
    * 10
@@ -13,7 +13,7 @@ export class DescribeApisecSensitiveDomainStatisticResponseBodyData extends $dar
   apiCount?: number;
   /**
    * @remarks
-   * The number of sites that are involved.
+   * The number of involved domain names.
    * 
    * @example
    * 10
@@ -21,8 +21,8 @@ export class DescribeApisecSensitiveDomainStatisticResponseBodyData extends $dar
   domainCount?: number;
   /**
    * @remarks
-   * The code of the sensitive data.
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported sensitive data types.
+   * The code of the sensitive data type.
+   * > You can call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to obtain the supported sensitive data types.
    * 
    * @example
    * 10
@@ -30,22 +30,21 @@ export class DescribeApisecSensitiveDomainStatisticResponseBodyData extends $dar
   sensitiveCode?: string;
   /**
    * @remarks
-   * The sensitivity level of the sensitive data.Valid values:
-   * 
-   * * **S1**: low sensitivity.
-   * * **S2**: moderate sensitivity.
-   * * **S3**: high sensitivity.
+   * The sensitivity level of the API. Valid values:
+   * - **S1**: low sensitivity.
+   * - **S2**: medium sensitivity.
+   * - **S3**: high sensitivity.
    * 
    * @example
-   * L3
+   * S3
    */
   sensitiveLevel?: string;
   /**
    * @remarks
-   * The name of the sensitive data.
+   * The name of the sensitive data type.
    * 
    * @example
-   * 1002
+   * 自定义敏感类型。
    */
   sensitiveName?: string;
   static names(): { [key: string]: string } {
@@ -80,7 +79,7 @@ export class DescribeApisecSensitiveDomainStatisticResponseBodyData extends $dar
 export class DescribeApisecSensitiveDomainStatisticResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response parameters.
+   * The returned data.
    */
   data?: DescribeApisecSensitiveDomainStatisticResponseBodyData[];
   /**

package/src/models/DescribeApisecSlsLogStoresRequest.ts

@@ -7,7 +7,7 @@ export class DescribeApisecSlsLogStoresRequest 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,7 +19,7 @@ export class DescribeApisecSlsLogStoresRequest extends $dara.Model {
    * @remarks
    * The ID of the region where logs are stored.
    * 
-   * >  You can call the [DescribeUserSlsLogRegions](https://help.aliyun.com/document_detail/2712598.html) operation to query available log storage regions.
+   * > You can call the [DescribeUserSlsLogRegions](https://help.aliyun.com/document_detail/2712598.html) operation to query available log storage regions.
    * 
    * This parameter is required.
    * 
@@ -41,8 +41,9 @@ export class DescribeApisecSlsLogStoresRequest 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/DescribeApisecSlsLogStoresResponseBody.ts

@@ -10,7 +10,7 @@ export class DescribeApisecSlsLogStoresResponseBody extends $dara.Model {
   logStores?: string[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0