@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/ModifyUserLogFieldConfigRequest.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyUserLogFieldConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The delivery type. Valid value:
+   * 
+   * - **sls**: Simple Log Service.
+   * 
    * @example
    * sls
    */
   deliveryType?: string;
   /**
+   * @remarks
+   * The extended configuration for log delivery, in JSON format.
+   * 
+   * > For more information, see the description of the **ExtendConfig** parameter.
+   * 
    * @example
    * {\\"request_header\\":\\"App-Id,channelCode\\"}
    */
   extendConfig?: string;
   /**
    * @remarks
+   * The list of log fields to deliver. Use the \\`a,b,c,...\\` format.
+   * 
+   * > - You must include all required log fields. Call the [DescribeCommonLogFields](~~DescribeCommonLogFields~~) operation to view the log fields that WAF supports.
+   * >
+   * > - If the log fields include **request_header**, use the **ExtendConfig** parameter to specify the request headers to deliver.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -23,6 +39,10 @@ export class ModifyUserLogFieldConfigRequest extends $dara.Model {
   fieldList?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to view the ID of your WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,16 +50,31 @@ export class ModifyUserLogFieldConfigRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The log delivery strategy, in JSON array format. You can specify multiple strategies.
+   * 
+   * > For more information, see the description of the **LogDeliveryStrategy** parameter.
+   * 
    * @example
    * [{\\"logType\\":\\"blockLog\\",\\"rate\\":100},{\\"logType\\":\\"normalRequestLog\\",\\"rate\\":100},{\\"logType\\":\\"checkLog\\",\\"rate\\":100}]
    */
   logDeliveryStrategy?: string;
   /**
+   * @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-acfm***q
    */

package/src/models/ModifyUserLogFieldConfigResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyUserLogFieldConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * E2D63742-9BAA-*****
    */

package/src/models/ModifyUserWafLogStatusRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyUserWafLogStatusRequest 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,12 +16,27 @@ export class ModifyUserWafLogStatusRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The ID of the log storage region. If this parameter is not specified, Simple Log Service is enabled in the region where the WAF instance resides.
+   * 
+   * - **cn-hangzhou**: the default region where Simple Log Service is enabled for a WAF instance in the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: the default region where Simple Log Service is enabled for a WAF instance outside the Chinese mainland.
+   * 
+   * > Call [DescribeUserSlsLogRegions](https://help.aliyun.com/document_detail/2712598.html) to query the available log storage regions.
+   * 
    * @example
    * cn-beijing
    */
   logRegionId?: string;
   /**
    * @remarks
+   * Indicates whether Simple Log Service is enabled. Valid values:
+   * 
+   * - **0**: Simple Log Service is disabled.
+   * 
+   * - **1**: Simple Log Service is enabled.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,11 +44,21 @@ export class ModifyUserWafLogStatusRequest extends $dara.Model {
    */
   logStatus?: number;
   /**
+   * @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 resource group.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/ModifyUserWafLogStatusResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyUserWafLogStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The name of the Logstore in Simple Log Service (SLS).
+   * 
    * @example
    * wafng-logstore
    */
   logStoreName?: string;
   /**
+   * @remarks
+   * Indicates whether the Simple Log Service project is created.
+   * 
    * @example
    * wafng-project-14316572********-cn-hangzhou
    */
   projectName?: boolean;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * D7861F61-5B61-****-A47C-6B19160*****
    */

package/src/models/ReCreateCloudResourceRequest.ts

@@ -3,9 +3,22 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ReCreateCloudResourceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the connected resource, which is automatically generated by WAF during cloud native mode registration.
+   * 
+   * > You can call [CreateCloudResource](https://help.aliyun.com/document_detail/2839876.html) to connect a resource and then view the resource ID in the response.
+   * 
+   * @example
+   * lb-bp*********k5uj2p-443-clb7
+   */
   cloudResourceId?: string;
   /**
    * @remarks
+   * 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.
    * 
    * @example
@@ -13,6 +26,9 @@ export class ReCreateCloudResourceRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The port of the cloud service that is connected to WAF.
+   * 
    * @example
    * 443
    * 
@@ -20,23 +36,46 @@ export class ReCreateCloudResourceRequest extends $dara.Model {
    */
   port?: number;
   /**
+   * @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 cloud service instance.
+   * 
    * @example
-   * lb-bp1*****jqnnqk5uj2p
+   * lb-bp*********k5uj2p
    * 
    * @deprecated
    */
   resourceInstanceId?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud resource group ID.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The type of the cloud service. Valid values:
+   * 
+   * - **clb4**: Layer 4 CLB.
+   * 
+   * - **clb7**: Layer 7 CLB.
+   * 
+   * - **ecs**: ECS.
+   * - **nlb**: NLB.
+   * 
    * @example
    * clb7
    * 

package/src/models/ReleaseInstanceRequest.ts

@@ -7,7 +7,7 @@ export class ReleaseInstanceRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  Obtain the ID of the WAF instance by calling the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation.
+   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to view the current WAF instance ID.
    * 
    * This parameter is required.
    * 
@@ -17,10 +17,11 @@ export class ReleaseInstanceRequest 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.
    * 
    * This parameter is required.
    * 
@@ -30,7 +31,7 @@ export class ReleaseInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/ReleaseInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ReleaseInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 65626467-8002-5022-9F5F-***

package/src/models/SyncProductInstanceRequest.ts

@@ -7,7 +7,7 @@ export class SyncProductInstanceRequest 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.
+   * > You can 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.
    * 
@@ -17,10 +17,11 @@ export class SyncProductInstanceRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region ID of the WAF instance. Valid values:
+   * The region where 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**: regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -28,7 +29,7 @@ export class SyncProductInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm4co****f5qa

package/src/models/SyncProductInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SyncProductInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request, which is used to locate and troubleshoot issues.
    * 
    * @example
    * 45BA2382-7C3F-5B29-9A83-C3BCE586****

package/src/models/TagResourcesRequest.ts

@@ -47,8 +47,9 @@ export class TagResourcesRequest extends $dara.Model {
    * @remarks
    * The region in which the Web Application Firewall (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.
    * 
    * This parameter is required.
    * 

package/src/models/UntagResourcesRequest.ts

@@ -7,8 +7,9 @@ export class UntagResourcesRequest extends $dara.Model {
    * @remarks
    * Specifies whether to remove all tags from the specified resource groups or members. Valid values:
    * 
-   * *   false (default)
-   * *   true
+   * - false (default)
+   * 
+   * - true
    * 
    * @example
    * false
@@ -18,8 +19,9 @@ export class UntagResourcesRequest extends $dara.Model {
    * @remarks
    * The region in which the Web Application Firewall (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.
    * 
    * This parameter is required.
    * 

package/src/models/VerifyDomainOwnerRequest.ts

@@ -5,9 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class VerifyDomainOwnerRequest extends $dara.Model {
   /**
    * @remarks
-   * The domain name of which you want to verify the ownership.
-   * 
-   * You can specify this parameter to check whether a domain name is added to WAF. Fuzzy match is supported.
+   * The domain name whose ownership you want to verify.
    * 
    * This parameter is required.
    * 
@@ -19,7 +17,7 @@ export class VerifyDomainOwnerRequest 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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to obtain the WAF instance ID.
    * 
    * This parameter is required.
    * 
@@ -29,10 +27,11 @@ export class VerifyDomainOwnerRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The protocol type that is used for file verification. Specify this parameter when you set VerifyType to fileCheck. Valid values:
+   * The protocol type used for file verification. This parameter is required only when you set VerifyType to fileCheck. Valid values:
+   * 
+   * - **HTTP**: the HTTP protocol.
    * 
-   * *   **HTTP**
-   * *   **HTTPS**
+   * - **HTTPS**: the HTTPS protocol.
    * 
    * @example
    * HTTP
@@ -42,8 +41,9 @@ export class VerifyDomainOwnerRequest extends $dara.Model {
    * @remarks
    * The verification method. Valid values:
    * 
-   * *   **dnsCheck**: DNS verification
-   * *   **fileCheck**: file verification
+   * - **dnsCheck**: DNS verification.
+   * 
+   * - **fileCheck**: File verification.
    * 
    * This parameter is required.
    * 

package/src/models/VerifyDomainOwnerResponseBody.ts

@@ -5,13 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class VerifyDomainOwnerResponseBodyVerifyResult extends $dara.Model {
   /**
    * @remarks
-   * The reasons why the verification fails. Valid values:
+   * The reason why the verification failed.
    * 
-   * *   DnsTxtVerifyFailed: The DNS TXT record and the domain name do not match.
-   * *   DnsServerError: The DNS server is abnormal.
-   * *   VerifyFileNotExist: The verification file does not exist.
-   * *   VerifyDomainNotAccess: The access to the domain name failed.
-   * *   FileContentVerifyFailed: The content of the verification file and the domain name do not match.
+   * - DnsTxtVerifyFailed: The DNS TXT record does not match.
+   * 
+   * - DnsServerError: The DNS server is abnormal.
+   * 
+   * - VerifyFileNotExist: The verification file does not exist.
+   * 
+   * - VerifyDomainNotAccess: Failed to access the domain name.
+   * 
+   * - FileContentVerifyFailed: The file content does not match.
    * 
    * @example
    * DnsTxtVerifyFailed
@@ -21,8 +25,9 @@ export class VerifyDomainOwnerResponseBodyVerifyResult extends $dara.Model {
    * @remarks
    * The verification result. Valid values:
    * 
-   * *   **true**: The verification succeeds.
-   * *   **false**: The verification fails.
+   * - **true**: The verification is successful.
+   * 
+   * - **false**: The verification failed.
    * 
    * @example
    * true
@@ -54,7 +59,7 @@ export class VerifyDomainOwnerResponseBodyVerifyResult extends $dara.Model {
 export class VerifyDomainOwnerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F35F45B0-5D6B-4238-BE02-A62D****E840