@alicloud/waf-openapi20211001 6.6.1 → 6.7.1

package/src/models/DescribeCloudResourcesRequest.ts

@@ -7,7 +7,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The UID of the account to which the resource belongs.
+   * The ID of the Alibaba Cloud account to which the resource belongs.
    * 
    * @example
    * 11769793******
@@ -41,11 +41,10 @@ export class DescribeCloudResourcesRequest 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.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -53,7 +52,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The domain name of the resource. This parameter is available when you query FC or SAE resources.
+   * The domain name. You can use this parameter if you set ResourceProduct to fc or sae.
    * 
    * @example
    * fc-domain-test
@@ -61,7 +60,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceDomain?: string;
   /**
    * @remarks
-   * The name of the function. This parameter is available when you query FC resources.
+   * The function name. You can use this parameter if you set ResourceProduct to fc.
    * 
    * @example
    * fc-test
@@ -69,7 +68,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceFunction?: string;
   /**
    * @remarks
-   * The ID of the resource instance.
+   * The ID of the resource.
    * 
    * @example
    * alb-43glijk0fr****gths
@@ -85,7 +84,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceInstanceName?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm4gh****wela
@@ -93,7 +92,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The name of the resource instance.
+   * The name of the resource.
    * 
    * @example
    * alb-name
@@ -103,25 +102,18 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceName?: string;
   /**
    * @remarks
-   * The cloud service to which the resource belongs. By default, instances of Application Load Balancer (ALB), Microservices Engine (MSE), Function Compute (FC), and Serverless App Engine (SAE) are returned. Valid values:
-   * 
-   * - **alb**: ALB
-   * 
-   * - **mse**: MSE
-   * 
-   * - **fc**: FC
-   * 
-   * - **sae**: SAE
-   * 
-   * - **ecs**: Elastic Compute Service (ECS)
-   * 
-   * - **clb4**: Classic Load Balancer (CLB) that uses TCP
-   * 
-   * - **clb7**: CLB that uses HTTP or HTTPS
+   * The cloud service to which the resource belongs. If you do not specify this parameter, the system automatically returns the Application Load Balancer (ALB), Microservices Engine (MSE), Function Compute, and Serverless App Engine (SAE) resources that are added to WAF. Valid values:
    * 
-   * - **nlb**: Network Load Balancer (NLB)
+   * *   **alb**: ALB.
+   * *   **mse**: MSE.
+   * *   **fc**: Function Compute.
+   * *   **sae**: SAE.
+   * *   **ecs**: Elastic Compute Service (ECS).
+   * *   **clb4**: Layer 4 Classic Load Balancer (CLB).
+   * *   **clb7**: Layer 7 CLB.
+   * *   **nlb**: Network Load Balancer (NLB).
    * 
-   * > Each cloud service supports different regions. If you specify this parameter, make sure the region you specify for the ResourceRegionId parameter supports this service. Otherwise, the query may fail.
+   * >  Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
    * 
    * @example
    * alb
@@ -129,9 +121,9 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceProduct?: string;
   /**
    * @remarks
-   * The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic.
+   * The region ID of the resource. For information about region IDs, see the following table.
    * 
-   * > Each cloud service supports different regions. If you specify the ResourceProduct parameter, make sure the region you specify for this parameter supports that service. Otherwise, the query may fail.
+   * >  Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
    * 
    * @example
    * cn-beijing
@@ -139,7 +131,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceRegionId?: string;
   /**
    * @remarks
-   * The name of the route. This parameter is available when you query MSE resources.
+   * The route name. You can use this parameter if you set ResourceProduct to mse.
    * 
    * @example
    * mse-default-traffic

package/src/models/DescribeCloudResourcesResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Model {
   /**
    * @remarks
-   * The number of HTTP ports that are added to WAF.
+   * The number of the HTTP ports that are added to WAF.
    * 
-   * > This parameter is returned only for ECS and CLB instances.
+   * >  This parameter is returned only if the cloud service is ECS or CLB.
    * 
    * @example
    * 1
@@ -15,9 +15,9 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   httpPortCount?: number;
   /**
    * @remarks
-   * The number of HTTPS ports that are added to WAF.
+   * The number of the HTTPS ports that are added to WAF.
    * 
-   * > This parameter is returned only for ECS and CLB instances.
+   * >  This parameter is returned only if the cloud service is ECS or CLB.
    * 
    * @example
    * 1
@@ -25,7 +25,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   httpsPortCount?: number;
   /**
    * @remarks
-   * The UID of the account to which the resource belongs.
+   * The ID of the Alibaba Cloud account to which the resource belongs.
    * 
    * @example
    * 11769793******
@@ -33,7 +33,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   ownerUserId?: string;
   /**
    * @remarks
-   * The domain name of the resource. This parameter is returned for FC or SAE instances.
+   * The domain name. This parameter has a value only if the value of ResourceProduct is fc or sae.
    * 
    * @example
    * test-resource-domain
@@ -41,7 +41,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceDomain?: string;
   /**
    * @remarks
-   * The name of the function. This parameter is returned for FC instances.
+   * The function name. This parameter has a value only if the value of ResourceProduct is fc.
    * 
    * @example
    * test-resource-function
@@ -49,7 +49,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceFunction?: string;
   /**
    * @remarks
-   * The ID of the resource instance.
+   * The ID of the resource.
    * 
    * @example
    * alb-ffff****
@@ -83,7 +83,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceInstanceName?: string;
   /**
    * @remarks
-   * The name of the instance.
+   * The name of the resource.
    * 
    * @example
    * test-resource-name
@@ -95,21 +95,13 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
    * @remarks
    * The cloud service to which the resource belongs. Valid values:
    * 
-   * - **alb**: ALB
-   * 
-   * - **mse**: MSE
-   * 
-   * - **fc**: FC
-   * 
-   * - **sae**: SAE
-   * 
-   * - **ecs**: ECS
-   * 
-   * - **clb4**: CLB that uses TCP
-   * 
-   * - **clb7**: CLB that uses HTTP or HTTPS
-   * 
-   * - **nlb**: NLB
+   * *   **alb**: ALB.
+   * *   **mse**: MSE.
+   * *   **fc**: Function Compute.
+   * *   **sae**: SAE.
+   * *   **ecs**: ECS.
+   * *   **clb4**: Layer 4 CLB.
+   * *   **clb7**: Layer 7 CLB.
    * 
    * @example
    * alb
@@ -117,7 +109,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceProduct?: string;
   /**
    * @remarks
-   * The region where the resource resides.
+   * The region ID of the resource.
    * 
    * @example
    * cn-hangzhou
@@ -125,7 +117,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceRegionId?: string;
   /**
    * @remarks
-   * The name of the route. This parameter is returned for MSE instances.
+   * The route name. This parameter has a value only if the value of ResourceProduct is mse.
    * 
    * @example
    * test-route-name
@@ -133,7 +125,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceRouteName?: string;
   /**
    * @remarks
-   * The name of the service. This parameter is returned for FC instances.
+   * The service name. This parameter has a value only if the value of ResourceProduct is fc.
    * 
    * @example
    * test-resource-service
@@ -189,7 +181,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
 export class DescribeCloudResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of cloud services.
+   * The cloud service resources that are added to WAF.
    */
   cloudResources?: DescribeCloudResourcesResponseBodyCloudResources[];
   /**
@@ -202,7 +194,7 @@ export class DescribeCloudResourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of cloud services found.
+   * The total number of cloud service resources returned.
    * 
    * @example
    * 121

package/src/models/DescribeCnameCountRequest.ts

@@ -7,7 +7,7 @@ export class DescribeCnameCountRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,11 +17,10 @@ export class DescribeCnameCountRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @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.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: the Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -29,7 +28,7 @@ export class DescribeCnameCountRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * 阿里云资源组ID。
    * 
    * @example
    * rg-acfm***q

package/src/models/DescribeCnameCountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
   /**
    * @remarks
-   * The number of domain names that are added in CNAME mode.
+   * The number of domain names that are added to WAF in CNAME record mode.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
   cname?: number;
   /**
    * @remarks
-   * The number of domain names that are added in hybrid cloud mode.
+   * The number of domain names that are added to WAF in hybrid cloud reverse proxy mode.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
   hybridCloudCname?: number;
   /**
    * @remarks
-   * The total number of domain names.
+   * The total number of domain names that are added to WAF in CNAME record mode and hybrid cloud reverse proxy mode.
    * 
    * @example
    * 1
@@ -55,7 +55,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
 export class DescribeCnameCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of CNAME records that are added.
+   * The information about the number of domain names that are added to WAF in CNAME record mode and hybrid cloud reverse proxy mode.
    */
   cnameCount?: DescribeCnameCountResponseBodyCnameCount;
   /**

package/src/models/DescribeCommonLogFieldsRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCommonLogFieldsRequest extends $dara.Model {
   /**
    * @remarks
-   * 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.
    * 
    * @example
@@ -16,50 +12,22 @@ export class DescribeCommonLogFieldsRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
-   * @remarks
-   * Specifies whether to query for default log fields.
-   * 
-   * - **true**: Queries for default log fields.
-   * 
-   * - **false**: Queries for non-default log fields.
-   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
-   * @remarks
-   * Specifies whether to query for required log fields.
-   * 
-   * - **true**: Queries for required log fields.
-   * 
-   * - **false**: Queries for non-required log fields.
-   * 
    * @example
    * false
    */
   isRequired?: boolean;
-  /**
-   * @remarks
-   * The list of log fields to query.
-   */
   logKeyList?: string[];
   /**
-   * @remarks
-   * The region where the WAF instance resides. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
-   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
-   * @remarks
-   * The ID of the Alibaba Cloud resource group.
-   * 
    * @example
    * rg-aek2sxgs*****
    */

package/src/models/DescribeCommonLogFieldsResponseBody.ts

@@ -4,51 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCommonLogFieldsResponseBodyLogFieldList extends $dara.Model {
   /**
-   * @remarks
-   * Indicates whether the log field is a default field.
-   * 
-   * - **true**: The log field is a default field.
-   * 
-   * - **false**: The log field is not a default field.
-   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
-   * @remarks
-   * Indicates whether the log field is required.
-   * 
-   * - **true**: The log field is required.
-   * 
-   * - **false**: The log field is not required.
-   * 
    * @example
    * true
    */
   isRequired?: boolean;
   /**
-   * @remarks
-   * The name of the log field.
-   * 
-   * > For more information about the log fields, see [**Log field descriptions**](https://help.aliyun.com/zh/waf/web-application-firewall-3-0/user-guide/fields-in-logs?spm=openapi-amp.newDocPublishment.0.0.ccef281fNAb0XR).
-   * 
    * @example
    * final_action
    */
   logKey?: string;
   /**
-   * @remarks
-   * The status of the log field. Valid values:
-   * 
-   * - **0**: offline.
-   * 
-   * - **1**: online or in use.
-   * 
-   * - **2**: about to be unpublished.
-   * 
-   * - **3**: about to be published.
-   * 
    * @example
    * 1
    */
@@ -81,23 +51,13 @@ export class DescribeCommonLogFieldsResponseBodyLogFieldList extends $dara.Model
 }
 
 export class DescribeCommonLogFieldsResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The list of log fields returned.
-   */
   logFieldList?: DescribeCommonLogFieldsResponseBodyLogFieldList[];
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * AB0775EB-2594-598A-97E1-51B1*******
    */
   requestId?: string;
   /**
-   * @remarks
-   * The total number of log fields returned.
-   * 
    * @example
    * 6
    */

package/src/models/DescribeCommonLogFieldsShrinkRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCommonLogFieldsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * 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.
    * 
    * @example
@@ -16,50 +12,22 @@ export class DescribeCommonLogFieldsShrinkRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
-   * @remarks
-   * Specifies whether to query for default log fields.
-   * 
-   * - **true**: Queries for default log fields.
-   * 
-   * - **false**: Queries for non-default log fields.
-   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
-   * @remarks
-   * Specifies whether to query for required log fields.
-   * 
-   * - **true**: Queries for required log fields.
-   * 
-   * - **false**: Queries for non-required log fields.
-   * 
    * @example
    * false
    */
   isRequired?: boolean;
-  /**
-   * @remarks
-   * The list of log fields to query.
-   */
   logKeyListShrink?: string;
   /**
-   * @remarks
-   * The region where the WAF instance resides. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
-   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
-   * @remarks
-   * The ID of the Alibaba Cloud resource group.
-   * 
    * @example
    * rg-aek2sxgs*****
    */

package/src/models/DescribeCustomBaseRuleCompileResultRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomBaseRuleCompileResultRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF instance.
-   * 
-   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to obtain the ID of the WAF instance.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -16,21 +12,11 @@ export class DescribeCustomBaseRuleCompileResultRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
-   * @remarks
-   * The region of the WAF instance. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
-   * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
-   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
-   * @remarks
-   * The ID of the Alibaba Cloud resource group.
-   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeCustomBaseRuleCompileResultResponseBody.ts

@@ -4,23 +4,11 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCustomBaseRuleCompileResultResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * 58FDF266-3D56-5DE8-91E0-96A26BAB****
    */
   requestId?: string;
   /**
-   * @remarks
-   * The compilation result. Valid values:
-   * 
-   * - **success**: The rule is successfully compiled.
-   * 
-   * - **compiling**: The rule is being compiled.
-   * 
-   * - **failed**: The rule failed to be compiled.
-   * 
    * @example
    * success
    */

package/src/models/DescribeDdoSstatusRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDDoSStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF instance.
+   * The ID of the WAF instance that you want to query.
    * 
-   * > Call [](t2223479.xdita#)to query the ID of the current WAF instance.
+   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,11 +17,10 @@ export class DescribeDDoSStatusRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region ID of WAF instance. Valid values:
+   * The region in which the WAF instance is deployed. Valid values:
    * 
-   * - **cn-hangzhou**: The Chinese mainland.
-   * 
-   * - **ap-southeast-1**: Outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -29,7 +28,7 @@ export class DescribeDDoSStatusRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/DescribeDdoSstatusResponseBody.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
   /**
    * @remarks
-   * The name of the event type. Valid values:
+   * The type of events that are triggered by DDoS attacks. Valid values:
    * 
-   * - defense: DDoS traffic scrubbing event.
-   * 
-   * - blackhole: DDoS blackhole filtering event.
+   * *   defense: traffic scrubbing events.
+   * *   blackhole: blackhole filtering events.
    * 
    * @example
    * blackhole
@@ -17,9 +16,9 @@ export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
   eventType?: string;
   /**
    * @remarks
-   * The DDoS status:
+   * Indicates whether DDoS attacks occur on specific domain names. Valid value:
    * 
-   * **doing**: Under DDoS attack.
+   * *   **doing**: DDoS attacks occur on specific domain names.
    * 
    * @example
    * doing
@@ -51,7 +50,7 @@ export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
 export class DescribeDDoSStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The current DDoS status.
+   * Indicates whether DDoS attacks occur on specific domain names.
    */
   DDoSStatus?: DescribeDDoSStatusResponseBodyDDoSStatus[];
   /**