@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/ModifyDefenseResourceXffRequest.ts

@@ -47,8 +47,9 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * @remarks
    * The status of the tracking cookie.
    * 
-   * *   **0**: disabled
-   * *   **1**: enabled. This is the default value.
+   * - **0**: Disabled.
+   * 
+   * - **1 (default)**: Enabled.
    * 
    * @example
    * 0
@@ -58,8 +59,9 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * @remarks
    * The status of the secure attribute of the tracking cookie.
    * 
-   * *   **0**: disabled. This is the default value.
-   * *   **1**: enabled.
+   * - **0 (default)**: Disabled.
+   * 
+   * - **1**: Enabled.
    * 
    * @example
    * 0
@@ -69,8 +71,9 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * @remarks
    * The status of the secure attribute of the slider CAPTCHA cookie.
    * 
-   * *   **0**: disabled. This is the default value.
-   * *   **1**: enabled.
+   * - **0 (default)**: Disabled.
+   * 
+   * - **1**: Enabled.
    * 
    * @example
    * 0
@@ -80,27 +83,28 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * @remarks
    * The custom header fields.
    * 
-   * >  The first IP address in the specified custom header field is used as the originating IP address of the client to prevent X-Forwarded-For forgery. If you specify multiple header fields, WAF reads the values of the header fields in sequence until the originating IP address is obtained. If the originating IP address cannot be obtained, the first IP address in the X-Forwarded-For header is used as the originating IP address of the client.
+   * > The first IP address in the specified header field is used as the client source IP address to prevent X-Forwarded-For (XFF) spoofing. If multiple headers are specified, they are tried in sequence to obtain the source IP address. If the first header does not contain an IP address, the system tries the second header, and so on. If no IP address is found in any of the specified headers, the system uses the first IP address in the X-Forwarded-For header.
    */
   customHeaders?: 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.
+   * > 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.
    * 
    * @example
-   * waf_v2_public_cn-wwo3c****07
+   * waf_v2_public_cn-wwo****ek07
    */
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region of the WAF instance. 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
@@ -113,7 +117,7 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * alb-4pxu81fgagx3****mz-alb
+   * alb-4pxu81fgagx3h6y****-alb
    */
   resource?: string;
   /**
@@ -121,20 +125,21 @@ export class ModifyDefenseResourceXffRequest extends $dara.Model {
    * The ID of the Alibaba Cloud resource group.
    * 
    * @example
-   * rg-acfm2kie2****wq
+   * rg-acfm2ki****miwq
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The response header.
+   * The response header parameters.
    */
   responseHeaders?: ModifyDefenseResourceXffRequestResponseHeaders[];
   /**
    * @remarks
    * Specifies whether a Layer 7 proxy is deployed in front of WAF. Layer 7 proxies include Anti-DDoS Proxy and Alibaba Cloud CDN. Valid values:
    * 
-   * *   **0**: No Layer 7 proxies are deployed. This is the default value.
-   * *   **1**: A Layer 7 proxy is deployed.
+   * - **0 (default)**: No.
+   * 
+   * - **1**: Yes.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDefenseResourceXffResponseBody.ts

@@ -8,7 +8,7 @@ export class ModifyDefenseResourceXffResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 6C094583-9B3F-5BD8-8748-DC638E****BF
+   * 6C094583-9B3F-5BD8-8748-DC638E48****
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDefenseRuleCacheRequest.ts

@@ -7,7 +7,7 @@ export class ModifyDefenseRuleCacheRequest 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 obtain the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,10 +17,11 @@ export class ModifyDefenseRuleCacheRequest 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**: 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 ModifyDefenseRuleCacheRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -51,7 +52,7 @@ export class ModifyDefenseRuleCacheRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * 12345
+   * 123
    */
   templateId?: number;
   static names(): { [key: string]: string } {

package/src/models/ModifyDefenseRuleCacheResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseRuleCacheResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
-   * A0F2B994-8645-5270-A05D-9DAD8C****B6
+   * A0F2B994-8645-5270-A05D-9DAD8C35****
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDefenseRuleRequest.ts

@@ -5,18 +5,31 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The scenario in which you want to use the protection rule. For more information, see the description of the **DefenseScene** parameter in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * The protection scenario to modify. For more information, see the **DefenseScene** parameter in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
    * 
    * @example
    * waf_group
    */
   defenseScene?: string;
+  /**
+   * @remarks
+   * The type of the protection rule. Valid values:
+   * 
+   * - **template** (default): a template protection rule.
+   * 
+   * - **resource**: a rule for a specific protected object.
+   * 
+   * - **global**: a global rule.
+   * 
+   * @example
+   * template
+   */
   defenseType?: string;
   /**
    * @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 obtain the ID of the WAF instance.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of your WAF instance.
    * 
    * This parameter is required.
    * 
@@ -26,19 +39,29 @@ export class ModifyDefenseRuleRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region of the WAF instance. 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
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The protected object for which you want to modify the rule.
+   * 
+   * > This parameter is required only when **DefenseType** is set to **resource**.
+   * 
+   * @example
+   * rencs***-waf
+   */
   resource?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -46,20 +69,29 @@ export class ModifyDefenseRuleRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The details of the protection rule. Specify a string that contains multiple parameters in the JSON format. You must specify the ID and the new configurations of the protection rule.
+   * The details of the protection rule, in a JSON string format. Specify the rule ID and the configuration of the protection rule to modify. The details include the following:
    * 
-   * *   **id:** The ID of the protection rule. Data type: long. You must specify this parameter.
-   * *   The protection rule configurations: The role of this parameter is the same as that of the **Rules** parameter in the **CreateDefenseRule** topic. For more information, see the "**Protection rule parameters**" section in the [CreateDefenseRule](~~CreateDefenseRule~~) topic.
+   * - **id**: The ID of the rule. This parameter is required. Data type: Long.
+   * 
+   * - Configuration of the protection rule: The parameters are the same as the **Rules** parameter of the [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html) operation. For more information, see the description of the protection rule parameters in [CreateDefenseRule](https://help.aliyun.com/document_detail/461421.html).
    * 
    * This parameter is required.
    * 
    * @example
-   * [{"id":2344,"policyId":1012,"action":"block"}]
+   * [
+   *       {
+   *             "id": 2344,
+   *             "policyId": 1012,
+   *             "action": "block"
+   *       }
+   * ]
    */
   rules?: string;
   /**
    * @remarks
-   * The ID of the protection rule template to which the protection rule whose configurations you want to modify belongs.
+   * The ID of the protection template.
+   * 
+   * > This parameter is required only when **DefenseType** is set to **template**.
    * 
    * @example
    * 5325

package/src/models/ModifyDefenseRuleStatusRequest.ts

@@ -3,12 +3,23 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyDefenseRuleStatusRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the protection rule. Valid values:
+   * 
+   * - **template** (default): a template protection rule.
+   * 
+   * - **resource**: a rule that is configured for a protected object.
+   * 
+   * @example
+   * template
+   */
   defenseType?: 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 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.
    * 
@@ -18,10 +29,11 @@ export class ModifyDefenseRuleStatusRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 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
@@ -37,7 +49,7 @@ export class ModifyDefenseRuleStatusRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule whose status you want to change.
+   * The ID of the protection rule to modify.
    * 
    * This parameter is required.
    * 
@@ -49,8 +61,9 @@ export class ModifyDefenseRuleStatusRequest extends $dara.Model {
    * @remarks
    * The new status of the protection rule. Valid values:
    * 
-   * *   **0:** disabled.
-   * *   **1:** enabled.
+   * - **0**: disabled
+   * 
+   * - **1**: enabled
    * 
    * This parameter is required.
    * 
@@ -60,7 +73,7 @@ export class ModifyDefenseRuleStatusRequest extends $dara.Model {
   ruleStatus?: number;
   /**
    * @remarks
-   * The ID of the protection rule template to which the protection rule whose status you want to change belongs.
+   * The ID of the protection template.
    * 
    * @example
    * 7239

package/src/models/ModifyDefenseRuleStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseRuleStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * BB305BF3-3C71-57A9-9704-E22F567689B0

package/src/models/ModifyDefenseSceneConfigRequest.ts

@@ -5,6 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the configuration item to modify.
+   * 
+   * If **DefenseScene** is set to **apisec**, the valid value is:
+   * 
+   * - **autoEnabled**: indicates whether core API security detection is automatically enabled for new resources.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +19,10 @@ export class ModifyDefenseSceneConfigRequest extends $dara.Model {
   configKey?: string;
   /**
    * @remarks
+   * The value to set for the configuration item.
+   * 
+   * > The value of this parameter depends on the value of **ConfigKey**. For more information, see **Description of mitigation setting parameters**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +31,10 @@ export class ModifyDefenseSceneConfigRequest extends $dara.Model {
   configValue?: string;
   /**
    * @remarks
+   * The protection scenario for which you want to modify the mitigation settings. Valid values:
+   * 
+   * - **apisec**: API security.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +43,10 @@ export class ModifyDefenseSceneConfigRequest extends $dara.Model {
   defenseScene?: 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
@@ -36,11 +54,21 @@ export class ModifyDefenseSceneConfigRequest 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 ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/ModifyDefenseSceneConfigResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDefenseSceneConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */

package/src/models/ModifyDefenseTemplateRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseTemplateRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the protection rule template whose configurations you want to modify.
+   * The description of the protection template.
    * 
    * @example
    * test
@@ -15,7 +15,7 @@ export class ModifyDefenseTemplateRequest 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,10 +25,11 @@ export class ModifyDefenseTemplateRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 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
@@ -36,7 +37,7 @@ export class ModifyDefenseTemplateRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q
@@ -44,7 +45,7 @@ export class ModifyDefenseTemplateRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule template whose configurations you want to modify.
+   * The ID of the protection template to modify.
    * 
    * This parameter is required.
    * 
@@ -54,7 +55,9 @@ export class ModifyDefenseTemplateRequest extends $dara.Model {
   templateId?: number;
   /**
    * @remarks
-   * The name of the protection rule template whose configurations you want to modify.
+   * The name of the protection template. The name must be 1 to 255 characters long and can contain Chinese characters, letters, digits, underscores (_), periods (.), and hyphens (-).
+   * 
+   * > Template names must be unique for the same protection scenario (**DefenseScene**).
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDefenseTemplateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDefenseTemplateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 1A68C85D-7467-5BB1-9A7E-2E8A5D96D88A

package/src/models/ModifyDefenseTemplateStatusRequest.ts

@@ -7,7 +7,7 @@ export class ModifyDefenseTemplateStatusRequest 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 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 ModifyDefenseTemplateStatusRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region where the WAF instance resides. Valid values:
+   * The region ID 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
@@ -28,7 +29,7 @@ export class ModifyDefenseTemplateStatusRequest 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 ModifyDefenseTemplateStatusRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule template whose status you want to change.
+   * The ID of the protection template.
    * 
    * This parameter is required.
    * 
@@ -48,8 +49,9 @@ export class ModifyDefenseTemplateStatusRequest extends $dara.Model {
    * @remarks
    * The new status of the protection rule template. Valid values:
    * 
-   * *   **0:** disabled.
-   * *   **1:** enabled.
+   * - **0**: Disabled.
+   * 
+   * - **1**: Enabled.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDomainCertRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDomainCertRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the certificate.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,13 +14,28 @@ export class ModifyDomainCertRequest extends $dara.Model {
    */
   certId?: string;
   /**
+   * @remarks
+   * The type of the cipher suite. Valid values:
+   * 
+   * - **1**: all cipher suites.
+   * 
+   * - **2**: strong cipher suites.
+   * 
+   * - **99**: custom cipher suites.
+   * 
    * @example
    * 1
    */
   cipherSuite?: string;
+  /**
+   * @remarks
+   * The custom cipher suites. This parameter is available only when you set **CipherSuite** to **99**.
+   */
   customCiphers?: string[];
   /**
    * @remarks
+   * The domain name that is added to WAF in CNAME record mode.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,12 +43,23 @@ export class ModifyDomainCertRequest extends $dara.Model {
    */
   domain?: string;
   /**
+   * @remarks
+   * Indicates whether to enable TLS 1.3. Valid values:
+   * 
+   * - **true**: TLS 1.3 is enabled.
+   * 
+   * - **false**: TLS 1.3 is disabled.
+   * 
    * @example
    * false
    */
   enableTLSv3?: boolean;
   /**
    * @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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,6 +68,12 @@ export class ModifyDomainCertRequest 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -47,6 +81,15 @@ export class ModifyDomainCertRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The Transport Layer Security (TLS) version. Valid values:
+   * 
+   * - **tlsv1**
+   * 
+   * - **tlsv1.1**
+   * 
+   * - **tlsv1.2**
+   * 
    * @example
    * tlsv1
    */

package/src/models/ModifyDomainCertResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDomainCertResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 03E3B4DD-2BE7-5D9D-80E8-***