@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeIpAbroadCountryInfosRequest.ts

@@ -4,17 +4,27 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeIpAbroadCountryInfosRequest extends $dara.Model {
   /**
+   * @remarks
+   * The region outside China to query. Supports fuzzy query by region ID or region name in Chinese or English.
+   * 
    * @example
    * US-CA
    */
   abroadRegion?: string;
   /**
+   * @remarks
+   * The country outside China to query. Supports fuzzy query by country ID or country name in Chinese or English.
+   * 
    * @example
    * US
    */
   country?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the current WAF instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,26 +32,49 @@ export class DescribeIpAbroadCountryInfosRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The language used for country and region names in the response. Valid values:
+   * 
+   * - **en** (**default**): English.
+   * 
+   * - **cn**: Simplified Chinese.
+   * 
    * @example
    * en
    */
   language?: string;
   /**
+   * @remarks
+   * The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next page. Set this parameter to the value of the **NextToken** parameter returned from the previous API call. You do not need to specify this parameter for the first page query.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0*****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The region in which the WAF instance is deployed. 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-aekzwwk****cv5i
    */

package/src/models/DescribeIpAbroadCountryInfosResponseBody.ts

@@ -4,13 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeIpAbroadCountryInfosResponseBodyAbroadInfosRegions extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the region.
+   * 
    * @example
    * US-CA
    */
   abroadRegionId?: string;
   /**
+   * @remarks
+   * The name of the region.
+   * 
    * @example
-   * 加利福尼亚州
+   * California
    */
   abroadRegionName?: string;
   static names(): { [key: string]: string } {
@@ -38,20 +44,33 @@ export class DescribeIpAbroadCountryInfosResponseBodyAbroadInfosRegions extends
 
 export class DescribeIpAbroadCountryInfosResponseBodyAbroadInfos extends $dara.Model {
   /**
+   * @remarks
+   * The continent to which the country belongs.
+   * 
    * @example
-   * 北美洲
+   * North America
    */
   continent?: string;
   /**
+   * @remarks
+   * The ID of the country.
+   * 
    * @example
    * US
    */
   country?: string;
   /**
+   * @remarks
+   * The name of the country.
+   * 
    * @example
-   * 美国
+   * United States
    */
   countryName?: string;
+  /**
+   * @remarks
+   * The list of region information outside China.
+   */
   regions?: DescribeIpAbroadCountryInfosResponseBodyAbroadInfosRegions[];
   static names(): { [key: string]: string } {
     return {
@@ -84,23 +103,39 @@ export class DescribeIpAbroadCountryInfosResponseBodyAbroadInfos extends $dara.M
 }
 
 export class DescribeIpAbroadCountryInfosResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of country information outside China.
+   */
   abroadInfos?: DescribeIpAbroadCountryInfosResponseBodyAbroadInfos[];
   /**
+   * @remarks
+   * The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next page.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0*****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID
+   * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-3014697B11AE
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 2
    */

package/src/models/DescribeLogDeliveryConfigRequest.ts

@@ -17,7 +17,7 @@ export class DescribeLogDeliveryConfigRequest 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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -27,10 +27,11 @@ export class DescribeLogDeliveryConfigRequest 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**: 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/DescribeLogDeliveryConfigResponseBody.ts

@@ -5,9 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogDeliveryConfigResponseBodyDeliveryConfig extends $dara.Model {
   /**
    * @remarks
-   * The content of the log delivery configuration. The value is a JSON string that contains multiple parameters.
+   * The details of the log delivery configuration, in JSON format.
    * 
-   * >  This parameter is the same as the **DeliveryDetail** parameter of the **CreateLogDeliveryConfig** operation. For more information, see **Parameter description for log delivery configuration** of the [CreateLogDeliveryConfig](~~CreateLogDeliveryConfig~~) operation.
+   * > This parameter is the same as the **DeliveryDetail** parameter of the **CreateLogDeliveryConfig** operation. For more information, see [CreateLogDeliveryConfig](~~CreateLogDeliveryConfig~~).
+   * 
+   * @example
+   * {
+   *   "rfcVersion": "rfc3164",
+   *   "protocol": "tcp",
+   *   "servers": [
+   *     {
+   *       "address": "1.1.1.1",
+   *       "port": 20
+   *     }
+   *   ]
+   * }
    */
   deliveryDetail?: string;
   /**
@@ -22,8 +34,9 @@ export class DescribeLogDeliveryConfigResponseBodyDeliveryConfig extends $dara.M
    * @remarks
    * The type of the log delivery configuration. Valid values:
    * 
-   * *   **syslog**: Logs are delivered to a syslog service.
-   * *   **kafka**: Logs are delivered to a Kafka service.
+   * - **syslog**: The logs are delivered to a syslog service.
+   * 
+   * - **kafka**: The logs are delivered to a Kafka service.
    * 
    * @example
    * syslog
@@ -57,12 +70,12 @@ export class DescribeLogDeliveryConfigResponseBodyDeliveryConfig extends $dara.M
 export class DescribeLogDeliveryConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the log delivery configuration.
+   * The log delivery configuration.
    */
   deliveryConfig?: DescribeLogDeliveryConfigResponseBodyDeliveryConfig;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-******

package/src/models/DescribeLogDeliveryConfigsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogDeliveryConfigsRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the log delivery configuration. Fuzzy queries are supported.
+   * The name of the log delivery configuration that you want to query. Fuzzy match is supported.
    * 
    * @example
    * test
@@ -15,8 +15,9 @@ export class DescribeLogDeliveryConfigsRequest extends $dara.Model {
    * @remarks
    * The type of the log delivery configuration that you want to query. Valid values:
    * 
-   * *   **syslog**: Logs are delivered to a syslog service.
-   * *   **kafka**: Logs are delivered to a Kafka service.
+   * - **syslog**: Log delivery to a syslog server.
+   * 
+   * - **kafka**: Log delivery to a Kafka cluster.
    * 
    * @example
    * kafka
@@ -24,9 +25,9 @@ export class DescribeLogDeliveryConfigsRequest extends $dara.Model {
   deliveryType?: string;
   /**
    * @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 the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -34,14 +35,29 @@ export class DescribeLogDeliveryConfigsRequest extends $dara.Model {
    * waf-cn-zz11sr5****
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The maximum number of entries per page. Valid values: 1 to 50. Default value: 20.
+   * 
+   * @example
+   * 20
+   */
   maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results. Set this parameter to the value of **NextToken** returned in the previous call. You do not need to specify this parameter for the first request.
+   * 
+   * @example
+   * AAAAAINZ+8pH1oQnusEu1tGAc8is
+   */
   nextToken?: string;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * The region where the WAF instance resides. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou**: the Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -49,7 +65,7 @@ export class DescribeLogDeliveryConfigsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the Alibaba Cloud resource group to which the WAF instance belongs.
    * 
    * @example
    * rg-acfm***q

package/src/models/DescribeLogDeliveryConfigsResponseBody.ts

@@ -5,9 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogDeliveryConfigsResponseBodyDeliveryConfigs extends $dara.Model {
   /**
    * @remarks
-   * The content of the log delivery configuration. The value is a JSON string that contains multiple parameters.
+   * The details of the log delivery configuration, returned as a JSON string.
    * 
-   * >  This parameter is the same as the **DeliveryDetail** parameter of the **CreateLogDeliveryConfig** operation. For more information, see **Parameter description for log delivery configuration** of the [CreateLogDeliveryConfig](~~CreateLogDeliveryConfig~~) operation.
+   * > The structure of this parameter is the same as the **DeliveryDetail** request parameter of the [CreateLogDeliveryConfig](~~CreateLogDeliveryConfig~~) operation.
+   * 
+   * @example
+   * {
+   *   "rfcVersion": "rfc3164",
+   *   "protocol": "tcp",
+   *   "servers": [
+   *     {
+   *       "address": "1.1.1.1",
+   *       "port": 20
+   *     }
+   *   ]
+   * }
    */
   deliveryDetail?: string;
   /**
@@ -22,11 +34,12 @@ export class DescribeLogDeliveryConfigsResponseBodyDeliveryConfigs extends $dara
    * @remarks
    * The type of the log delivery configuration. Valid values:
    * 
-   * *   **syslog**: Logs are delivered to a syslog service.
-   * *   **kafka**: Logs are delivered to a Kafka service.
+   * - **syslog**: Log delivery to a syslog server.
+   * 
+   * - **kafka**: Log delivery to a Kafka cluster.
    * 
    * @example
-   * kafka
+   * syslog
    */
   deliveryType?: string;
   static names(): { [key: string]: string } {
@@ -57,19 +70,42 @@ export class DescribeLogDeliveryConfigsResponseBodyDeliveryConfigs extends $dara
 export class DescribeLogDeliveryConfigsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the log delivery configuration.
+   * The log delivery configurations.
    */
   deliveryConfigs?: DescribeLogDeliveryConfigsResponseBodyDeliveryConfigs[];
+  /**
+   * @remarks
+   * The maximum number of entries returned per page.
+   * 
+   * @example
+   * 20
+   */
   maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results.
+   * 
+   * > If this parameter is not empty, more results are available. Use the value of **NextToken** in the next request to retrieve the next page of results. If the value is empty, all results have been returned.
+   * 
+   * @example
+   * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
+   */
   nextToken?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 2EFCFE18-78F8-5079-B312-07***48B
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The total number of log delivery configurations returned.
+   * 
+   * @example
+   * 5
+   */
   totalCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeMajorProtectionBlackIpsRequest.ts

@@ -7,7 +7,7 @@ export class DescribeMajorProtectionBlackIpsRequest 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 obtain the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The IP address that you want to query. You can specify this parameter to query an IP address in the IP address blacklist for major event protection by using fuzzy matching.
+   * The IP address to query. You can set this parameter to perform a fuzzy query on the added IP address blacklist.
    * 
    * @example
    * 192.0.XX.XX
@@ -25,12 +25,15 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   ipLike?: string;
   /**
    * @remarks
-   * The method that you want to use to sort the IP addresses **in descending order**. Valid values:
+   * The property by which to sort the results in **descending order**. Valid values:
    * 
-   * *   **gmtModified:** sorts the IP addresses by most recent modification time.
-   * *   **ip:** sorts the IP addresses by IP address.
-   * *   **templateId:** sorts the IP addresses by template ID.
-   * *   **id:** sorts the IP addresses by primary key.
+   * - **gmtModified**: sorts by modification time.
+   * 
+   * - **ip**: sorts by IP address.
+   * 
+   * - **templateId**: sorts by template ID.
+   * 
+   * - **id**: sorts by primary key.
    * 
    * @example
    * gmtModified
@@ -38,7 +41,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The number of the page to return. Default value: **1**.
+   * The page number. Default value: **1**, which indicates the first page.
    * 
    * @example
    * 1
@@ -46,7 +49,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: **10**.
+   * The number of entries per page. Default value: **10**, which indicates 10 entries per page.
    * 
    * @example
    * 10
@@ -54,10 +57,11 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region in which the WAF instance is deployed. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou:** the Chinese mainland.
-   * *   **ap-southeast-1:** outside the Chinese mainland.
+   * - **ap-southeast-1**: regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -65,7 +69,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -73,7 +77,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the IP address blacklist rule for major event protection.
+   * The ID of the IP address blacklist rule for critical event protection.
    * 
    * @example
    * 20013199
@@ -81,7 +85,7 @@ export class DescribeMajorProtectionBlackIpsRequest extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * The ID of the rule template for major event protection.
+   * The ID of the critical event protection template.
    * 
    * @example
    * 5673

package/src/models/DescribeMajorProtectionBlackIpsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Model {
   /**
    * @remarks
-   * The description of the IP address in the blacklist.
+   * The description of the template.
    * 
    * @example
    * test0003asdffas
@@ -13,9 +13,9 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
   description?: string;
   /**
    * @remarks
-   * The time after which the IP address blacklist becomes invalid. Unit: seconds.
+   * The timestamp after which the IP address blacklist becomes invalid. Unit: seconds.
    * 
-   * >  If the value of this parameter is **0**, the blacklist is permanently valid.
+   * > If the value is **0**, the IP address blacklist is permanently valid.
    * 
    * @example
    * 1662603328
@@ -23,7 +23,7 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
   expiredTime?: number;
   /**
    * @remarks
-   * The most recent time when the IP address blacklist was modified.
+   * The time when the IP address in the blacklist was modified.
    * 
    * @example
    * 1665456202000
@@ -31,7 +31,7 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
   gmtModified?: number;
   /**
    * @remarks
-   * The IP address in the IP address blacklist.
+   * The IP address.
    * 
    * @example
    * 192.0.XX.XX
@@ -39,7 +39,7 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
   ip?: string;
   /**
    * @remarks
-   * The ID of the IP address blacklist rule for major event protection.
+   * The ID of the IP address blacklist rule for critical event protection.
    * 
    * @example
    * 8508970
@@ -47,7 +47,7 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
   ruleId?: number;
   /**
    * @remarks
-   * The ID of the rule template for major event protection.
+   * The ID of the critical event protection template.
    * 
    * @example
    * 9684
@@ -87,7 +87,7 @@ export class DescribeMajorProtectionBlackIpsResponseBodyIpList extends $dara.Mod
 export class DescribeMajorProtectionBlackIpsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * An array of IP addresses in the IP address blacklist.
+   * The list of IP addresses in the blacklist.
    */
   ipList?: DescribeMajorProtectionBlackIpsResponseBodyIpList[];
   /**

package/src/models/DescribeMemberAccountsRequest.ts

@@ -5,11 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMemberAccountsRequest extends $dara.Model {
   /**
    * @remarks
-   * The status of the member that you want to query.
+   * The status of the member accounts that you want to query. Valid values:
    * 
-   * *   **enabled**: managed.
-   * *   **disabled**: not managed.
-   * *   **disabling**: being deleted.
+   * - **enabled**: The member account is being managed.
+   * 
+   * - **disabled**: The member account is not being managed.
+   * 
+   * - **disabling**: The member account is being removed from management.
    * 
    * @example
    * enabled
@@ -17,9 +19,9 @@ export class DescribeMemberAccountsRequest extends $dara.Model {
   accountStatus?: string;
   /**
    * @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 the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class DescribeMemberAccountsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region where the WAF instance resides. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: a region outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -48,7 +51,7 @@ export class DescribeMemberAccountsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The source IP address of the request. The system specifies this parameter.
+   * The source IP address. You do not need to specify this parameter. It is automatically obtained by the system.
    * 
    * @example
    * 0.0.XX.XX