@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeCloudResourcesRequest.ts

@@ -7,7 +7,7 @@ export class DescribeCloudResourcesRequest 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 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.
    * 
@@ -17,7 +17,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * The UID of the account to which the resource belongs.
    * 
    * @example
    * 11769793******
@@ -41,10 +41,11 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the 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 DescribeCloudResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The domain name. You can use this parameter if you set ResourceProduct to fc or sae.
+   * The domain name of the resource. This parameter is available when you query FC or SAE resources.
    * 
    * @example
    * fc-domain-test
@@ -60,7 +61,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceDomain?: string;
   /**
    * @remarks
-   * The function name. You can use this parameter if you set ResourceProduct to fc.
+   * The name of the function. This parameter is available when you query FC resources.
    * 
    * @example
    * fc-test
@@ -68,7 +69,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceFunction?: string;
   /**
    * @remarks
-   * The ID of the resource.
+   * The ID of the resource instance.
    * 
    * @example
    * alb-43glijk0fr****gths
@@ -84,7 +85,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceInstanceName?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm4gh****wela
@@ -92,7 +93,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The name of the resource.
+   * The name of the resource instance.
    * 
    * @example
    * alb-name
@@ -102,18 +103,25 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceName?: string;
   /**
    * @remarks
-   * 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:
+   * 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
    * 
-   * *   **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).
+   * - **nlb**: Network Load Balancer (NLB)
    * 
-   * >  Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
+   * > 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.
    * 
    * @example
    * alb
@@ -121,9 +129,9 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceProduct?: string;
   /**
    * @remarks
-   * The region ID of the resource. For information about region IDs, see the following table.
+   * The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic.
    * 
-   * >  Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
+   * > 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.
    * 
    * @example
    * cn-beijing
@@ -131,7 +139,7 @@ export class DescribeCloudResourcesRequest extends $dara.Model {
   resourceRegionId?: string;
   /**
    * @remarks
-   * The route name. You can use this parameter if you set ResourceProduct to mse.
+   * The name of the route. This parameter is available when you query MSE resources.
    * 
    * @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 the HTTP ports that are added to WAF.
+   * The number of HTTP ports that are added to WAF.
    * 
-   * >  This parameter is returned only if the cloud service is ECS or CLB.
+   * > This parameter is returned only for ECS and CLB instances.
    * 
    * @example
    * 1
@@ -15,9 +15,9 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   httpPortCount?: number;
   /**
    * @remarks
-   * The number of the HTTPS ports that are added to WAF.
+   * The number of HTTPS ports that are added to WAF.
    * 
-   * >  This parameter is returned only if the cloud service is ECS or CLB.
+   * > This parameter is returned only for ECS and CLB instances.
    * 
    * @example
    * 1
@@ -25,7 +25,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   httpsPortCount?: number;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * The UID of the account to which the resource belongs.
    * 
    * @example
    * 11769793******
@@ -33,7 +33,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   ownerUserId?: string;
   /**
    * @remarks
-   * The domain name. This parameter has a value only if the value of ResourceProduct is fc or sae.
+   * The domain name of the resource. This parameter is returned for FC or SAE instances.
    * 
    * @example
    * test-resource-domain
@@ -41,7 +41,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceDomain?: string;
   /**
    * @remarks
-   * The function name. This parameter has a value only if the value of ResourceProduct is fc.
+   * The name of the function. This parameter is returned for FC instances.
    * 
    * @example
    * test-resource-function
@@ -49,7 +49,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceFunction?: string;
   /**
    * @remarks
-   * The ID of the resource.
+   * The ID of the resource instance.
    * 
    * @example
    * alb-ffff****
@@ -83,7 +83,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceInstanceName?: string;
   /**
    * @remarks
-   * The name of the resource.
+   * The name of the instance.
    * 
    * @example
    * test-resource-name
@@ -95,13 +95,21 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
    * @remarks
    * The cloud service to which the resource belongs. Valid values:
    * 
-   * *   **alb**: ALB.
-   * *   **mse**: MSE.
-   * *   **fc**: Function Compute.
-   * *   **sae**: SAE.
-   * *   **ecs**: ECS.
-   * *   **clb4**: Layer 4 CLB.
-   * *   **clb7**: Layer 7 CLB.
+   * - **alb**: ALB
+   * 
+   * - **mse**: MSE
+   * 
+   * - **fc**: FC
+   * 
+   * - **sae**: SAE
+   * 
+   * - **ecs**: ECS
+   * 
+   * - **clb4**: CLB that uses TCP
+   * 
+   * - **clb7**: CLB that uses HTTP or HTTPS
+   * 
+   * - **nlb**: NLB
    * 
    * @example
    * alb
@@ -109,7 +117,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceProduct?: string;
   /**
    * @remarks
-   * The region ID of the resource.
+   * The region where the resource resides.
    * 
    * @example
    * cn-hangzhou
@@ -117,7 +125,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceRegionId?: string;
   /**
    * @remarks
-   * The route name. This parameter has a value only if the value of ResourceProduct is mse.
+   * The name of the route. This parameter is returned for MSE instances.
    * 
    * @example
    * test-route-name
@@ -125,7 +133,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
   resourceRouteName?: string;
   /**
    * @remarks
-   * The service name. This parameter has a value only if the value of ResourceProduct is fc.
+   * The name of the service. This parameter is returned for FC instances.
    * 
    * @example
    * test-resource-service
@@ -181,7 +189,7 @@ export class DescribeCloudResourcesResponseBodyCloudResources extends $dara.Mode
 export class DescribeCloudResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The cloud service resources that are added to WAF.
+   * A list of cloud services.
    */
   cloudResources?: DescribeCloudResourcesResponseBodyCloudResources[];
   /**
@@ -194,7 +202,7 @@ export class DescribeCloudResourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of cloud service resources returned.
+   * The total number of cloud services found.
    * 
    * @example
    * 121

package/src/models/DescribeCnameCountRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCnameCountRequest extends $dara.Model {
   /**
    * @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.
    * 
@@ -17,10 +17,11 @@ export class DescribeCnameCountRequest 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**: 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 DescribeCnameCountRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * 阿里云资源组ID。
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @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 to WAF in CNAME record mode.
+   * The number of domain names added through public cloud CNAME access.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
   cname?: number;
   /**
    * @remarks
-   * The number of domain names that are added to WAF in hybrid cloud reverse proxy mode.
+   * The number of domain names added through hybrid cloud access.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
   hybridCloudCname?: number;
   /**
    * @remarks
-   * The total number of domain names that are added to WAF in CNAME record mode and hybrid cloud reverse proxy mode.
+   * The total number of results returned.
    * 
    * @example
    * 1
@@ -55,7 +55,7 @@ export class DescribeCnameCountResponseBodyCnameCount extends $dara.Model {
 export class DescribeCnameCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the number of domain names that are added to WAF in CNAME record mode and hybrid cloud reverse proxy mode.
+   * The number of CNAME access entries.
    */
   cnameCount?: DescribeCnameCountResponseBodyCnameCount;
   /**

package/src/models/DescribeCommonLogFieldsRequest.ts

@@ -5,6 +5,10 @@ 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
@@ -12,22 +16,50 @@ 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,21 +4,51 @@ 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
    */
@@ -51,13 +81,23 @@ 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,6 +5,10 @@ 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
@@ -12,22 +16,50 @@ 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,6 +5,10 @@ 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
@@ -12,11 +16,21 @@ 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,11 +4,23 @@ 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,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDDoSStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF instance that you want to query.
-   * 
-   * >  You can call the [DescribeInstanceInfo](https://help.aliyun.com/document_detail/140857.html) operation to query the ID of the WAF instance.
+   * 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 +16,11 @@ export class DescribeDDoSStatusRequest 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**: the Chinese mainland.
    * 
-   * *   **cn-hangzhou**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -28,7 +28,7 @@ export class DescribeDDoSStatusRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The Alibaba Cloud resource group ID.
    * 
    * @example
    * rg-acfm***q

package/src/models/DescribeDdoSstatusResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
   /**
    * @remarks
-   * The type of events that are triggered by DDoS attacks. Valid values:
-   * 
-   * *   defense: traffic scrubbing events.
-   * *   blackhole: blackhole filtering events.
+   * The event type. Valid values:
+   * - defense: DDoS scrubbing events.
+   * - blackhole: DDoS blackhole filtering events.
    * 
    * @example
    * blackhole
@@ -16,9 +15,8 @@ export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
   eventType?: string;
   /**
    * @remarks
-   * Indicates whether DDoS attacks occur on specific domain names. Valid value:
-   * 
-   * *   **doing**: DDoS attacks occur on specific domain names.
+   * The DDoS status. Valid values:
+   * - **doing**: under DDoS attack.
    * 
    * @example
    * doing
@@ -50,12 +48,12 @@ export class DescribeDDoSStatusResponseBodyDDoSStatus extends $dara.Model {
 export class DescribeDDoSStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether DDoS attacks occur on specific domain names.
+   * The current DDoS status.
    */
   DDoSStatus?: DescribeDDoSStatusResponseBodyDDoSStatus[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-5B61-46CE-A47C-***