@alicloud/waf-openapi20211001 6.6.1 → 6.7.1

package/src/models/DescribeProductInstancesResponseBody.ts

@@ -3,30 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeProductInstancesResponseBodyProductInstancesAccessPortAndProtocols extends $dara.Model {
-  /**
-   * @remarks
-   * The certificates.
-   */
   certificateIds?: string[];
-  /**
-   * @remarks
-   * The port of the cloud service added to WAF.
-   * 
-   * @example
-   * 443
-   */
   port?: number;
-  /**
-   * @remarks
-   * The protocol type. Valid values:
-   * 
-   * - **http**: HTTP protocol.
-   * 
-   * - **https**: HTTPS protocol.
-   * 
-   * @example
-   * http
-   */
   protocol?: string;
   static names(): { [key: string]: string } {
     return {
@@ -57,24 +35,13 @@ export class DescribeProductInstancesResponseBodyProductInstancesAccessPortAndPr
 }
 
 export class DescribeProductInstancesResponseBodyProductInstancesResourcePortsCertificates extends $dara.Model {
-  /**
-   * @remarks
-   * The type of the HTTPS certificate. Valid values:
-   * 
-   * - **default**: Default certificate.
-   * 
-   * - **extension**: Extension certificate.
-   * 
-   * @example
-   * default
-   */
   appliedType?: string;
   /**
    * @remarks
-   * The certificate ID.
+   * The ID of the certificate.
    * 
    * @example
-   * 1234567
+   * 10106183
    */
   certificateId?: string;
   /**
@@ -82,16 +49,9 @@ export class DescribeProductInstancesResponseBodyProductInstancesResourcePortsCe
    * The name of the certificate.
    * 
    * @example
-   * demoCertName
+   * trafficxxxx.cn
    */
   certificateName?: string;
-  /**
-   * @remarks
-   * The domain name bound to the certificate.
-   * 
-   * @example
-   * www.test.com
-   */
   domain?: string;
   static names(): { [key: string]: string } {
     return {
@@ -128,7 +88,7 @@ export class DescribeProductInstancesResponseBodyProductInstancesResourcePorts e
   certificates?: DescribeProductInstancesResponseBodyProductInstancesResourcePortsCertificates[];
   /**
    * @remarks
-   * The port.
+   * The port number.
    * 
    * @example
    * 443
@@ -138,9 +98,8 @@ export class DescribeProductInstancesResponseBodyProductInstancesResourcePorts e
    * @remarks
    * The protocol type. Valid values:
    * 
-   * - **http**: HTTP protocol.
-   * 
-   * - **https**: HTTPS protocol.
+   * *   **http**
+   * *   **https**
    * 
    * @example
    * https
@@ -175,59 +134,22 @@ export class DescribeProductInstancesResponseBodyProductInstancesResourcePorts e
 }
 
 export class DescribeProductInstancesResponseBodyProductInstances extends $dara.Model {
-  /**
-   * @remarks
-   * The ID of the instance added to WAF.
-   * 
-   * @example
-   * i-2ze1tm4pvghp****cluv
-   */
   accessInstanceId?: string;
-  /**
-   * @remarks
-   * The port and protocol information of the cloud service added to WAF.
-   */
   accessPortAndProtocols?: DescribeProductInstancesResponseBodyProductInstancesAccessPortAndProtocols[];
-  /**
-   * @remarks
-   * The list of ports added to WAF.
-   */
   accessPorts?: number[];
   /**
    * @remarks
-   * The user ID (UID) of the Alibaba Cloud account to which the instance belongs.
+   * The ID of the Alibaba Cloud account to which the resource belongs.
    * 
    * @example
    * 1704********9107
    */
   ownerUserId?: string;
-  /**
-   * @remarks
-   * The protection status of WAF. Valid values:
-   * 
-   * - **all**: All protected.
-   * 
-   * - **any**: Protected.
-   * 
-   * - **part**: Partially protected.
-   * 
-   * - **non**: Not protected.
-   * 
-   * @example
-   * all
-   */
   resourceInstanceAccessStatus?: string;
-  /**
-   * @remarks
-   * The edition of the instance.
-   * 
-   * @example
-   * ecs.e-c1m1.large
-   */
   resourceInstanceEdition?: string;
   /**
    * @remarks
-   * The instance ID.
+   * The ID of the instance.
    * 
    * @example
    * i-2ze1tm4pvghp****cluv
@@ -235,7 +157,7 @@ export class DescribeProductInstancesResponseBodyProductInstances extends $dara.
   resourceInstanceId?: string;
   /**
    * @remarks
-   * The IP address of the instance.
+   * The IP address of the instance that is added to WAF.
    * 
    * @example
    * 1.X.X.1
@@ -243,7 +165,7 @@ export class DescribeProductInstancesResponseBodyProductInstances extends $dara.
   resourceInstanceIp?: string;
   /**
    * @remarks
-   * The name of the instance.
+   * The name of the instance that is added to WAF.
    * 
    * @example
    * demoInstanceName
@@ -276,15 +198,11 @@ export class DescribeProductInstancesResponseBodyProductInstances extends $dara.
   resourcePorts?: DescribeProductInstancesResponseBodyProductInstancesResourcePorts[];
   /**
    * @remarks
-   * The type of the cloud service. Valid values:
+   * The cloud service to which the instance belongs. Valid values:
    * 
-   * - **clb4**: Layer 4 CLB.
-   * 
-   * - **clb7**: Layer 7 CLB.
-   * 
-   * - **ecs**: ECS.
-   * 
-   * - **nlb**: NLB.
+   * *   **clb4**: Layer 4 CLB.
+   * *   **clb7**: Layer 7 CLB.
+   * *   **ecs**: ECS.
    * 
    * @example
    * clb4
@@ -294,25 +212,16 @@ export class DescribeProductInstancesResponseBodyProductInstances extends $dara.
    * @remarks
    * The region ID of the instance. Valid values:
    * 
-   * - **cn-chengdu**: China (Chengdu).
-   * 
-   * - **cn-beijing**: China (Beijing).
-   * 
-   * - **cn-zhangjiakou**: China (Zhangjiakou).
-   * 
-   * - **cn-hangzhou**: China (Hangzhou).
-   * 
-   * - **cn-shanghai**: China (Shanghai).
-   * 
-   * - **cn-shenzhen**: China (Shenzhen).
-   * 
-   * - **cn-qingdao**: China (Qingdao).
-   * 
-   * - **cn-hongkong**: China (Hong Kong).
-   * 
-   * - **ap-southeast-3**: Malaysia (Kuala Lumpur).
-   * 
-   * - **ap-southeast-5**: Indonesia (Jakarta).
+   * *   **cn-chengdu**: China (Chengdu).
+   * *   **cn-beijing**: China (Beijing).
+   * *   **cn-zhangjiakou**: China (Zhangjiakou).
+   * *   **cn-hangzhou**: China (Hangzhou).
+   * *   **cn-shanghai**: China (Shanghai).
+   * *   **cn-shenzhen**: China (Shenzhen).
+   * *   **cn-qingdao**: China (Qingdao).
+   * *   **cn-hongkong**: China (Hong Kong).
+   * *   **ap-southeast-3**: Malaysia (Kuala Lumpur).
+   * *   **ap-southeast-5**: Indonesia (Jakarta).
    * 
    * @example
    * cn-beijing

package/src/models/DescribePunishedDomainsRequest.ts

@@ -5,14 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePunishedDomainsRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of domain names added to WAF.
+   * The domain names that are added to WAF.
    */
   domains?: string[];
   /**
    * @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.
+   * >  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.
    * 
@@ -22,11 +22,10 @@ export class DescribePunishedDomainsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The penalty type. Valid values:
+   * The type of punishment. Valid values:
    * 
-   * - **beian** (default): ICP filing center.
-   * 
-   * - **punishCenter**: penalty center.
+   * *   **beian** (default): the filing center.
+   * *   **punishCenter**: the punishment center.
    * 
    * @example
    * beian
@@ -34,11 +33,10 @@ export class DescribePunishedDomainsRequest extends $dara.Model {
   punishType?: string;
   /**
    * @remarks
-   * The region of the WAF instance. Valid values:
-   * 
-   * - **cn-hangzhou**: the Chinese mainland.
+   * The region in which the WAF instance is deployed. Valid values:
    * 
-   * - **ap-southeast-1**: outside the Chinese mainland.
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribePunishedDomainsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePunishedDomainsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of domain names penalized for not having an ICP filing.
+   * The domain names that are penalized for failing to obtain an ICP filing.
    */
   punishedDomains?: string[];
   /**

package/src/models/DescribeRelatedDefenseRulesRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeRelatedDefenseRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The WAF protection scenario. Only the following value is supported:
-   * 
-   * - **address_book**: address book.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -17,10 +13,6 @@ export class DescribeRelatedDefenseRulesRequest extends $dara.Model {
   defenseScene?: string;
   /**
    * @remarks
-   * The type of the protection rule. Only the following value is supported:
-   * 
-   * - **global**: a global rule.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -29,10 +21,6 @@ export class DescribeRelatedDefenseRulesRequest extends $dara.Model {
   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 query the ID of your WAF instance.
-   * 
    * This parameter is required.
    * 
    * @example
@@ -40,47 +28,27 @@ export class DescribeRelatedDefenseRulesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
-   * @remarks
-   * The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.
-   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
-   * @remarks
-   * The token that is used to query the next page of results. If more results are available, this parameter is returned.
-   * 
-   * > If this parameter is returned, more results are available. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat this process until the **NextToken** parameter is not returned. This indicates that all data has been retrieved.
-   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0*****
    */
   nextToken?: 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
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the protection rule.
-   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeRelatedDefenseRulesResponseBody.ts

@@ -4,47 +4,26 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeRelatedDefenseRulesResponseBodyRules extends $dara.Model {
   /**
-   * @remarks
-   * The protection scenario of the rule. For more information, see the description of the **DefenseScene** parameter in [DescribeDefenseRules](https://help.aliyun.com/document_detail/461426.html).
-   * 
    * @example
    * custom_acl
    */
   defenseScene?: string;
   /**
-   * @remarks
-   * The type of the protection rule. Valid values:
-   * 
-   * - **template** (default): a template rule.
-   * 
-   * - **resource**: a rule for a protected object.
-   * 
-   * - **global**: a global rule.
-   * 
    * @example
    * template
    */
   defenseType?: string;
   /**
-   * @remarks
-   * The ID of the protection rule.
-   * 
    * @example
    * 2456789
    */
   ruleId?: number;
   /**
-   * @remarks
-   * The name of the protection rule.
-   * 
    * @example
    * ruleTest
    */
   ruleName?: string;
   /**
-   * @remarks
-   * The ID of the protection template.
-   * 
    * @example
    * 81501
    */
@@ -80,40 +59,22 @@ export class DescribeRelatedDefenseRulesResponseBodyRules extends $dara.Model {
 
 export class DescribeRelatedDefenseRulesResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.
-   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
-   * @remarks
-   * The token that is used to query the next page of results. If more results are available, this parameter is returned.
-   * 
-   * > If this parameter is returned, more results are available. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat this process until the **NextToken** parameter is not returned. This indicates that all data has been retrieved.
-   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
-   * @remarks
-   * The ID of the request.
-   * 
    * @example
    * F35F45B0-5D6B-4238-BE02-A62D****E840
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The list of associated rules.
-   */
   rules?: DescribeRelatedDefenseRulesResponseBodyRules[];
   /**
-   * @remarks
-   * The total number of entries returned.
-   * 
    * @example
    * 10
    */

package/src/models/DescribeResourceInstanceCertsRequest.ts

@@ -7,7 +7,7 @@ export class DescribeResourceInstanceCertsRequest 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.
    * 
@@ -33,11 +33,10 @@ export class DescribeResourceInstanceCertsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region of the Web Application Firewall (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
@@ -45,7 +44,7 @@ export class DescribeResourceInstanceCertsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the cloud resource.
+   * The ID of the instance.
    * 
    * @example
    * lb-bp1*****jqnnqk5uj2p
@@ -53,7 +52,7 @@ export class DescribeResourceInstanceCertsRequest extends $dara.Model {
   resourceInstanceId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The ID of the Alibaba Cloud resource group.
    * 
    * @example
    * rg-acfm***q

package/src/models/DescribeResourceInstanceCertsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceInstanceCertsResponseBodyCerts extends $dara.Model {
   /**
    * @remarks
-   * The time when the certificate expires. This is a UNIX timestamp. Unit: milliseconds.
+   * The time when the certificate expires.
    * 
    * @example
    * 1708415521211
@@ -13,7 +13,7 @@ export class DescribeResourceInstanceCertsResponseBodyCerts extends $dara.Model
   afterDate?: number;
   /**
    * @remarks
-   * The time when the certificate was issued. This is a UNIX timestamp. Unit: milliseconds.
+   * The time when the certificate was issued.
    * 
    * @example
    * 1708415521211
@@ -21,7 +21,7 @@ export class DescribeResourceInstanceCertsResponseBodyCerts extends $dara.Model
   beforeDate?: number;
   /**
    * @remarks
-   * The global ID of the certificate. The ID is generated by appending -cn-hangzhou to the certificate ID. For example, if the certificate ID is 123, the value of CertIdentifier is 123-cn-hangzhou.
+   * The globally unique ID of the certificate. The value is in the "Certificate ID-cn-hangzhou" format. For example, if the ID of the certificate is 123, the value of CertIdentifier is 123-cn-hangzhou.
    * 
    * @example
    * 123-cn-hangzhou
@@ -32,20 +32,20 @@ export class DescribeResourceInstanceCertsResponseBodyCerts extends $dara.Model
    * The name of the certificate.
    * 
    * @example
-   * waf-cert-name
+   * demoCertName
    */
   certName?: string;
   /**
    * @remarks
-   * The common name (CN).
+   * The common name.
    * 
    * @example
-   * www.aliyundemo.com
+   * *.aliyundemo.com
    */
   commonName?: string;
   /**
    * @remarks
-   * The domain name associated with the certificate.
+   * The domain name for which the certificate is issued.
    * 
    * @example
    * waf.aliyundemo.com
@@ -95,12 +95,12 @@ export class DescribeResourceInstanceCertsResponseBodyCerts extends $dara.Model
 export class DescribeResourceInstanceCertsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the certificates.
+   * The certificates.
    */
   certs?: DescribeResourceInstanceCertsResponseBodyCerts[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D7861F61-***-6B19160D5EB0

package/src/models/DescribeResourceLogDeliveryStatusRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceLogDeliveryStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Web Application Firewall (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,29 +12,17 @@ export class DescribeResourceLogDeliveryStatusRequest 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 resource group to which the WAF instance belongs.
-   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The protected objects that you want to query. Separate multiple protected objects with commas (,).
-   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeResourceLogDeliveryStatusResponseBody.ts

@@ -4,41 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeResourceLogDeliveryStatusResponseBodyLogConfigs extends $dara.Model {
   /**
-   * @remarks
-   * The name of the log delivery configuration.
-   * 
    * @example
    * export-kafka
    */
   deliveryName?: string;
   /**
-   * @remarks
-   * The type of log delivery for the protected object. Valid values:
-   * 
-   * - **syslog**: Logs are delivered to a syslog service.
-   * 
-   * - **kafka**: Logs are delivered to a Kafka service.
-   * 
    * @example
    * kafka
    */
   deliveryType?: string;
   /**
-   * @remarks
-   * The name of the protected object, such as a domain name or Application Load Balancer (ALB) instance.
-   * 
    * @example
    * test.waf.com-waf
    */
   resource?: string;
   /**
-   * @remarks
-   * Indicates whether log delivery is enabled for the protected object. Valid values:
-   * 
-   * - **true**: Log delivery is enabled.
-   * 
-   * - **false**: Log delivery is disabled.
-   * 
    * @example
    * true
    */
@@ -71,15 +51,8 @@ export class DescribeResourceLogDeliveryStatusResponseBodyLogConfigs extends $da
 }
 
 export class DescribeResourceLogDeliveryStatusResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * A list of log delivery configurations for the protected objects.
-   */
   logConfigs?: DescribeResourceLogDeliveryStatusResponseBodyLogConfigs[];
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19****5EB0
    */