@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/DescribeResourceLogFieldConfigRequest.ts

@@ -5,6 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceLogFieldConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The log delivery type. Valid values:
+   * 
+   * - **sls**: Simple Log Service.
+   * 
+   * - **kafka**: Kafka.
+   * 
+   * - **syslog**: Syslog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +21,10 @@ export class DescribeResourceLogFieldConfigRequest extends $dara.Model {
   deliveryType?: string;
   /**
    * @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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,12 +32,21 @@ export class DescribeResourceLogFieldConfigRequest 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 protected object whose log field configuration you want to query.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +54,9 @@ export class DescribeResourceLogFieldConfigRequest extends $dara.Model {
    */
   resource?: string;
   /**
+   * @remarks
+   * The ID of the resource group to which the WAF instance belongs.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeResourceLogFieldConfigResponseBody.ts

@@ -4,36 +4,67 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeResourceLogFieldConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The extra log fields that are configured in addition to the default log fields. The fields are specified as a string of comma-separated values.
+   * 
    * @example
    * acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type
    */
   addList?: string;
   /**
+   * @remarks
+   * The log fields that are removed from the default log fields. The fields are specified as a string of comma-separated values.
+   * 
    * @example
    * waf_rule_id,waf_rule_type
    */
   delList?: string;
   /**
+   * @remarks
+   * The log delivery type. Valid values:
+   * 
+   * - **sls**: Simple Log Service.
+   * 
+   * - **kafka**: Kafka.
+   * 
+   * - **syslog**: Syslog.
+   * 
    * @example
    * sls
    */
   deliveryType?: string;
   /**
+   * @remarks
+   * The extended configuration for log delivery. The value is a string that is converted from a JSON object of parameters.
+   * 
+   * > For more information about the parameters, see the description of the **ExtendConfig** parameter in [ModifyResourceLogFieldConfig](~~ModifyResourceLogFieldConfig~~).
+   * 
    * @example
    * {\\"request_header\\":\\"Ali-Cdn-Real-Ip\\"}
    */
   extendConfig?: string;
   /**
+   * @remarks
+   * The list of delivered log fields. The fields are specified as a string of comma-separated values.
+   * 
    * @example
    * account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids
    */
   fieldList?: string;
   /**
+   * @remarks
+   * The log delivery policies. Multiple policies are supported. The value is a string that is converted from a JSON array of parameters.
+   * 
+   * > For more information about the parameters, see the description of the **LogDeliveryStrategy** parameter in [ModifyResourceLogFieldConfig](~~ModifyResourceLogFieldConfig~~).
+   * 
    * @example
    * [{\\"logType\\":\\"blockLog\\",\\"rate\\":100},{\\"logType\\":\\"normalRequestLog\\",\\"rate\\":100},{\\"logType\\":\\"checkLog\\",\\"rate\\":100}]
    */
   logDeliveryStrategy?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 7B53B47C-D368-5344-BB5E-79******
    */

package/src/models/DescribeResourceLogStatusRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceLogStatusRequest 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 obtain 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.
    * 
@@ -19,8 +19,9 @@ export class DescribeResourceLogStatusRequest extends $dara.Model {
    * @remarks
    * The region where the WAF instance resides. Valid values:
    * 
-   * *   **cn-hangzhou:** the Chinese mainland
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -28,7 +29,7 @@ export class DescribeResourceLogStatusRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -36,7 +37,7 @@ export class DescribeResourceLogStatusRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The protected object that you want to query. You can specify multiple protected objects. Separate the protected objects with commas (,).
+   * The protected objects whose log collection status you want to query. Separate multiple protected objects with commas (,).
    * 
    * This parameter is required.
    * 

package/src/models/DescribeResourceLogStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceLogStatusResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The protected object.
+   * The name of the protected object.
    * 
    * @example
    * alb-wewbb23dfsetetcic****
@@ -13,10 +13,11 @@ export class DescribeResourceLogStatusResponseBodyResult extends $dara.Model {
   resource?: string;
   /**
    * @remarks
-   * Indicates whether the log collection feature is enabled for the protected object. Valid values:
+   * Indicates whether log collection is enabled for the protected object. Valid values:
    * 
-   * *   **true:** The log collection feature is enabled.
-   * *   **false:** The log collection feature is disabled.
+   * - **true**: Log collection is enabled.
+   * 
+   * - **false**: Log collection is disabled.
    * 
    * @example
    * true
@@ -56,7 +57,7 @@ export class DescribeResourceLogStatusResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned result.
+   * The log status information of protected objects.
    */
   result?: DescribeResourceLogStatusResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/DescribeResourcePortRequest.ts

@@ -7,7 +7,7 @@ export class DescribeResourcePortRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain 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.
    * 
@@ -17,10 +17,11 @@ export class DescribeResourcePortRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region ID of WAF instance. Valid values:
    * 
-   * *   **cn-hangzhou:** the 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/DescribeResourcePortResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourcePortResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-3014697B11AE
@@ -13,7 +13,7 @@ export class DescribeResourcePortResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * An array of HTTP and HTTPS listener ports that are added to the WAF instance.
+   * All HTTP and HTTPS listener ports that are added to WAF.
    */
   resourcePorts?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeResourceRegionIdRequest.ts

@@ -7,7 +7,7 @@ export class DescribeResourceRegionIdRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain 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.
    * 
@@ -17,10 +17,11 @@ export class DescribeResourceRegionIdRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region ID of the WAF instance. 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

package/src/models/DescribeResourceRegionIdResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeResourceRegionIdResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The region IDs of the resources that are added to Web Application Firewall (WAF) by using the SDK integration mode.
+   * The region IDs of cloud service resources that can be added to WAF by using the SDK.
    */
   resourceRegionIds?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeResourceSupportRegionsRequest.ts

@@ -7,7 +7,7 @@ export class DescribeResourceSupportRegionsRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
+   * > You can call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to view the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,10 +17,11 @@ export class DescribeResourceSupportRegionsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region to which the WAF instance belongs. Valid values:
    * 
-   * *   **cn-hangzhou**: the Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: indicates the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: indicates regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -28,7 +29,7 @@ export class DescribeResourceSupportRegionsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-aekzpks****kdjq
@@ -36,11 +37,27 @@ export class DescribeResourceSupportRegionsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The cloud service. Valid values:
+   * The cloud product to which the resource belongs. By default, instances of ALB, MSE, FC, and SAE products are returned. Valid values:
+   * 
+   * - **alb**: indicates the ALB product.
+   * 
+   * - **mse**: indicates the MSE product.
+   * 
+   * - **fc**: indicates the FC product.
+   * 
+   * - **sae**: indicates the SAE product.
+   * 
+   * - **ecs**: indicates the ECS product.
+   * 
+   * - **clb4**: indicates the CLB(TCP) product.
+   * 
+   * - **clb7**: indicates the CLB(HTTP/HTTPS) product.
+   * 
+   * - **apig**: indicates the APIG product.
+   * 
+   * - **nlb**: indicates the NLB product.
    * 
-   * *   **clb4**: Layer 4 CLB.
-   * *   **clb7**: Layer 7 CLB.
-   * *   **ecs**: ECS.
+   * > Each product supports different regions. When the product filter field has a value, you need to refer to the regions supported by the product. Otherwise, the filtering may fail.
    * 
    * @example
    * clb7

package/src/models/DescribeResourceSupportRegionsResponseBody.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceSupportRegionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * Indicates the request ID.
    * 
    * @example
-   * 58FD****-3D56-5DE8-91E0-96A26BABFFDD
+   * 58FDF266-3D56-5DE8-91E0-96A26BAB****
    */
   requestId?: string;
   /**
    * @remarks
-   * An array of region IDs of the CLB and ECS instances that are added to WAF in cloud native mode.
+   * The list of region IDs supported by transparent proxy mode.
    */
   supportRegions?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeResponseCodeTrendGraphRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. Unit: seconds. If you do not specify this parameter, the current time is used.
+   * The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the current time is used as the end time.
    * 
    * @example
    * 1665386280
@@ -15,7 +15,7 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The time interval. Unit: seconds. The value must be an integral multiple of 60.
+   * The time interval. Unit: seconds. The value must be a multiple of 60.
    * 
    * This parameter is required.
    * 
@@ -35,10 +35,11 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   interval?: string;
   /**
    * @remarks
-   * The ID of the region where the WAF instance resides. Valid values:
+   * The region of the WAF instance. Valid values:
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -54,7 +55,7 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   resource?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -62,7 +63,7 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: seconds.
+   * The start of the time range to query. The value is a UNIX timestamp. Unit: seconds.
    * 
    * This parameter is required.
    * 
@@ -72,10 +73,11 @@ export class DescribeResponseCodeTrendGraphRequest extends $dara.Model {
   startTimestamp?: string;
   /**
    * @remarks
-   * The type of the error codes. Valid values:
+   * The type of response code. Valid values:
+   * 
+   * - **waf**: a response code that WAF returns to a client.
    * 
-   * *   **waf:** error codes that are returned to clients from WAF.
-   * *   **upstream:** error codes that are returned to WAF from the origin server.
+   * - **upstream**: a response code that an origin server returns to WAF.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeResponseCodeTrendGraphResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $dara.Model {
   /**
    * @remarks
-   * The number of 302 error codes that are returned.
+   * The number of 302 response codes.
    * 
    * @example
    * 0
@@ -13,7 +13,7 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
   code302Pv?: number;
   /**
    * @remarks
-   * The number of 405 error codes that are returned.
+   * The number of 405 response codes.
    * 
    * @example
    * 121645464
@@ -21,7 +21,7 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
   code405Pv?: number;
   /**
    * @remarks
-   * The number of 444 error codes that are returned.
+   * The number of 444 response codes.
    * 
    * @example
    * 0
@@ -29,7 +29,7 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
   code444Pv?: number;
   /**
    * @remarks
-   * The number of 499 error codes that are returned.
+   * The number of 499 response codes.
    * 
    * @example
    * 0
@@ -37,7 +37,7 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
   code499Pv?: number;
   /**
    * @remarks
-   * The number of 5xx error codes that are returned.
+   * The number of 5xx response codes.
    * 
    * @example
    * 2932
@@ -45,7 +45,7 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
   code5xxPv?: number;
   /**
    * @remarks
-   * The serial number of the time interval. The serial numbers are arranged in chronological order.
+   * The serial number of the time interval, sorted in chronological order.
    * 
    * @example
    * 10
@@ -85,15 +85,15 @@ export class DescribeResponseCodeTrendGraphResponseBodyResponseCodes extends $da
 export class DescribeResponseCodeTrendGraphResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
-   * 7D46493E-84DD-58CE-80A7-8643****9ECC
+   * 7D46493E-84DD-58CE-80A7-8643F2B09ECC
    */
   requestId?: string;
   /**
    * @remarks
-   * The array of the statistics of the error codes.
+   * The statistics of response codes.
    */
   responseCodes?: DescribeResponseCodeTrendGraphResponseBodyResponseCodes[];
   static names(): { [key: string]: string } {

package/src/models/DescribeRoleAuthStatusRequest.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeRoleAuthStatusRequest extends $dara.Model {
   /**
+   * @remarks
+   * The region in which 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-aekzhalsanv***
    */

package/src/models/DescribeRoleAuthStatusResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeRoleAuthStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the service-linked role for WAF is authorized.
+   * 
+   * - **true**: The service-linked role is authorized.
+   * 
+   * - **false**: The service-linked role is not authorized.
+   * 
    * @example
    * true
    */
   authStatus?: boolean;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 79ECBB08-079C-57C5-A676-***
    */

package/src/models/DescribeRuleGroupsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeRuleGroupsRequest 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 obtain 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.
    * 
@@ -17,7 +17,7 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The number of the page to return. Default value: **1**.
+   * The page number of the results to return. The default value is **1**, which returns the first page of results.
    * 
    * @example
    * 1
@@ -25,7 +25,7 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: **10**.
+   * The number of entries to return on each page. The default value is **10**.
    * 
    * @example
    * 10
@@ -33,10 +33,11 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region where the WAF instance is deployed. Valid values:
    * 
-   * *   **cn-hangzhou:** the Chinese mainland
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -44,7 +45,7 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -52,10 +53,11 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The type of the query condition. Valid values:
+   * The query type. Valid values:
+   * 
+   * - **id**: Queries by rule group ID.
    * 
-   * *   **id:** queries regular expression rule groups by ID.
-   * *   **name:** queries regular expression rule groups by name.
+   * - **name**: Queries by rule group name. Both Chinese and English names are supported.
    * 
    * @example
    * name
@@ -63,7 +65,7 @@ export class DescribeRuleGroupsRequest extends $dara.Model {
   searchType?: string;
   /**
    * @remarks
-   * The query condition.
+   * The content to query.
    * 
    * @example
    * test