@alicloud/waf-openapi20211001 6.8.0 → 6.8.2

package/src/models/DescribeCertDetailRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCertDetailRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the certificate.
+   * The certificate ID.
    * 
    * This parameter is required.
    * 
@@ -15,9 +15,9 @@ export class DescribeCertDetailRequest extends $dara.Model {
   certIdentifier?: string;
   /**
    * @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.
    * 
@@ -27,10 +27,11 @@ export class DescribeCertDetailRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. 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**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -38,7 +39,7 @@ export class DescribeCertDetailRequest 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/DescribeCertDetailResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   /**
    * @remarks
-   * The time when the certificate expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * The expiration date of the CA certificate. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1976256736582
@@ -13,7 +13,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   afterDate?: number;
   /**
    * @remarks
-   * The time when the certificate was issued. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * The issuance time of the certificate. Unit: milliseconds.
    * 
    * @example
    * 1976256736582
@@ -21,7 +21,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   beforeDate?: number;
   /**
    * @remarks
-   * The ID of the certificate.
+   * The certificate ID.
    * 
    * @example
    * 123-cn-hangzhou
@@ -29,7 +29,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   certIdentifier?: string;
   /**
    * @remarks
-   * The name of the certificate.
+   * The certificate name.
    * 
    * @example
    * testCertName
@@ -37,7 +37,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   certName?: string;
   /**
    * @remarks
-   * The primary domain name, which is a common name.
+   * The common name of the certificate.
    * 
    * @example
    * *.xxxaliyun.com
@@ -45,7 +45,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   commonName?: string;
   /**
    * @remarks
-   * The domain name that is associated with the certificate.
+   * The domain name associated with the certificate.
    * 
    * @example
    * demo.xxxaliyun.com
@@ -53,7 +53,7 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The other domain names that are associated with the certificate.
+   * The list of other domain names associated with the certificate.
    */
   sans?: string[];
   static names(): { [key: string]: string } {
@@ -95,12 +95,12 @@ export class DescribeCertDetailResponseBodyCertDetail extends $dara.Model {
 export class DescribeCertDetailResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the certificate.
+   * The SSL certificate details.
    */
   certDetail?: DescribeCertDetailResponseBodyCertDetail;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 3C115DBE-8E53-5A12-9CAF-FD3F****CDF6

package/src/models/DescribeCertsRequest.ts

@@ -7,8 +7,9 @@ export class DescribeCertsRequest extends $dara.Model {
    * @remarks
    * The type of the encryption algorithm. Valid values:
    * 
-   * *   **NotSM2**: The encryption algorithm is not the SM2 algorithm. This is the default value.
-   * *   **SM2**: The encryption algorithm is the SM2 algorithm.
+   * - **NotSM2 (default)**: Specifies a non-ShangMi (SM) cryptographic algorithm.
+   * 
+   * - **SM2**: Specifies an SM cryptographic algorithm.
    * 
    * @example
    * SM2
@@ -26,7 +27,7 @@ export class DescribeCertsRequest 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 your current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -36,7 +37,7 @@ export class DescribeCertsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -44,7 +45,7 @@ export class DescribeCertsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values: 1 to 100. Default value: **10**.
+   * The number of entries per page. Default value: **10**. Maximum value: 100.
    * 
    * @example
    * 10
@@ -52,13 +53,14 @@ export class DescribeCertsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region of the WAF instance. 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
-   * ap-southeast-1
+   * cn-hangzhou
    */
   regionId?: string;
   /**

package/src/models/DescribeCertsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCertsResponseBodyCerts extends $dara.Model {
   /**
    * @remarks
-   * The expiration time.
+   * The time when the certificate expires.
    * 
    * @example
    * 1976256736582
@@ -13,7 +13,7 @@ export class DescribeCertsResponseBodyCerts extends $dara.Model {
   afterDate?: number;
   /**
    * @remarks
-   * The effective time.
+   * The time when the certificate takes effect.
    * 
    * @example
    * 1976256836582
@@ -21,10 +21,10 @@ export class DescribeCertsResponseBodyCerts extends $dara.Model {
   beforeDate?: number;
   /**
    * @remarks
-   * The globally unique ID of the certificate. The value follows a "\\<Certificate ID>-ap-southeast-1" format. For example, if the ID of the certificate is 123, the value of the CertIdentifier parameter is 123-ap-southeast-1.
+   * The globally unique ID of the certificate. The value follows a "\\<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-ap-southeast-1
+   * 12345-cn-hangzhou
    */
   certIdentifier?: string;
   /**
@@ -45,7 +45,7 @@ export class DescribeCertsResponseBodyCerts extends $dara.Model {
   commonName?: string;
   /**
    * @remarks
-   * The domain that is supported by the certificate.
+   * The domain name for which the certificate is issued.
    * 
    * @example
    * www.example.com
@@ -55,8 +55,9 @@ export class DescribeCertsResponseBodyCerts extends $dara.Model {
    * @remarks
    * Indicates whether the certificate chain is complete. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: The certificate chain is complete.
+   * 
+   * - **false**: The certificate chain is incomplete.
    * 
    * @example
    * true
@@ -98,12 +99,12 @@ export class DescribeCertsResponseBodyCerts extends $dara.Model {
 export class DescribeCertsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The certificates.
+   * The list of certificates.
    */
   certs?: DescribeCertsResponseBodyCerts[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 19511B0D-5AE0-5600-BB8A-DC2C8345****

package/src/models/DescribeChargeModuleRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeChargeModuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The billing method of the instance. Valid values:
+   * 
+   * - **POSTPAY**: a pay-as-you-go WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,11 +16,21 @@ export class DescribeChargeModuleRequest extends $dara.Model {
    */
   payType?: 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.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeChargeModuleResponseBody.ts

@@ -4,27 +4,132 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeChargeModuleResponseBodyChargeModules extends $dara.Model {
   /**
+   * @remarks
+   * The pricing model of the billing module. Valid values:
+   * 
+   * - **NORMAL_PRICE**: tiered pricing.
+   * 
+   * - **STEP_ACCUMULATION**: tiered pricing.
+   * 
    * @example
    * NORMAL_PRICE
    */
   chargeMode?: string;
+  /**
+   * @remarks
+   * The detailed pricing information for the billing module.
+   */
   chargeModeDetails?: string[];
   /**
+   * @remarks
+   * The code of the billing module. Valid values:
+   * 
+   * - **domainCount**: the number of domain names added to WAF in CNAME record mode.
+   * 
+   * - **qps**: the peak queries per second (QPS).
+   * 
+   * - **request**: the basic traffic fee.
+   * 
+   * - **ipBlacklistRuleCount**: the number of IP blacklist rules.
+   * 
+   * - **customAclBaseRuleCount**: the number of basic rules in custom protection rules.
+   * 
+   * - **customAclAdvanceRuleCount**: the number of advanced rules in custom protection rules.
+   * 
+   * - **antiScanRuleCount**: the number of scan protection rules.
+   * 
+   * - **customResponseRuleCount**: the number of custom response rules.
+   * 
+   * - **ipv6**: IPv6 protection.
+   * 
+   * - **gslb**: intelligent load balancing.
+   * 
+   * - **exclusiveIpCount**: the number of exclusive IP addresses.
+   * 
+   * - **ccRuleCount**: the number of HTTP flood protection rules.
+   * 
+   * - **regionBlockRuleCount**: the number of rules in the region blacklist.
+   * 
+   * - **tamperproofRuleCount**: the number of web tamper-proofing rules.
+   * 
+   * - **dlpRuleCount**: the number of data leakage prevention rules.
+   * 
+   * - **botTraffic**: the traffic fee for bot management.
+   * 
+   * - **aiWhiteListTemplateCount**: the number of intelligent whitelist templates.
+   * 
+   * - **apisecResourceCount**: the number of protected objects for which API security is enabled.
+   * 
+   * - **apisecTraffic**: the traffic fee for API security.
+   * 
+   * - **compliance**: the number of protocol compliance templates.
+   * 
+   * - **riskTraffic**: the number of times that risk identification in bot management is matched.
+   * 
+   * - **assetStatus**: asset center.
+   * 
+   * - **nonPort**: custom ports protection.
+   * 
+   * - **customAclCaptcha**: the number of times that sliders are used for custom protection rules.
+   * 
+   * - **wafBaseTemplateCount**: the number of core web protection rules.
+   * 
+   * - **instanceFee**: the WAF instance fee.
+   * 
+   * - **spikeThrottleRuleCount**: the number of peak traffic throttling rules.
+   * 
+   * - **botWebTemplateCount**: the number of web protection templates in bot management.
+   * 
+   * - **botAppTemplateCount**: the number of app protection templates in bot management.
+   * 
+   * - **customAclBotRuleCount**: the number of advanced custom rules in bot management.
+   * 
    * @example
    * domainCount
    */
   moduleCode?: string;
   /**
+   * @remarks
+   * The billing cycle of the billing module. Valid values:
+   * 
+   * - **Hour**: hourly billing.
+   * 
    * @example
    * Hour
    */
   periodType?: string;
   /**
+   * @remarks
+   * The usage type of the billing module. Valid values:
+   * 
+   * - **template**: template.
+   * 
+   * - **qps**: QPS.
+   * 
+   * - **domain**: domain name.
+   * 
+   * - **rule**: rule.
+   * 
+   * - **ip**: IP address.
+   * 
+   * - **resource**: protected object.
+   * 
+   * - **request**: request.
+   * 
+   * - **function**: feature enablement.
+   * 
+   * - **time**: number of times.
+   * 
    * @example
    * domain
    */
   usageType?: string;
   /**
+   * @remarks
+   * The billing unit coefficient of the billing module.
+   * 
+   * > The usage unit for the module is determined by multiplying the **UsageUnitFactor** by the **UsageType**.
+   * 
    * @example
    * 1
    */
@@ -64,8 +169,15 @@ export class DescribeChargeModuleResponseBodyChargeModules extends $dara.Model {
 }
 
 export class DescribeChargeModuleResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of billing modules for WAF.
+   */
   chargeModules?: DescribeChargeModuleResponseBodyChargeModules[];
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */

package/src/models/DescribeChargeResultRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeChargeResultRequestChargeModules extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the billing module.
+   * 
    * @example
    * domainCount
    */
   moduleCode?: string;
   /**
+   * @remarks
+   * The usage amount of the billing module.
+   * 
    * @example
    * 10
    */
@@ -38,17 +44,32 @@ export class DescribeChargeResultRequestChargeModules extends $dara.Model {
 
 export class DescribeChargeResultRequest extends $dara.Model {
   /**
+   * @remarks
+   * The billing cycle for the WAF instance. Valid values:
+   * 
+   * - **Year**: yearly billing cycle.
+   * 
+   * - **Month**: monthly billing cycle.
+   * 
+   * - **Day**: daily billing cycle.
+   * 
    * @example
    * Day
    */
   chargeCycle?: string;
   /**
    * @remarks
+   * The billing modules to calculate.
+   * 
    * This parameter is required.
    */
   chargeModules?: DescribeChargeResultRequestChargeModules[];
   /**
    * @remarks
+   * The billing method of the WAF instance. Valid value:
+   * 
+   * - **POSTPAY**: pay-as-you-go.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -56,11 +77,21 @@ export class DescribeChargeResultRequest extends $dara.Model {
    */
   payType?: 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/DescribeChargeResultResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeChargeResultResponseBodyModuleDetails extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the billing module.
+   * 
    * @example
    * domainCount
    */
   moduleCode?: string;
   /**
+   * @remarks
+   * The number of SeCUs for the billing module.
+   * 
    * @example
    * 1080
    */
@@ -37,13 +43,23 @@ export class DescribeChargeResultResponseBodyModuleDetails extends $dara.Model {
 }
 
 export class DescribeChargeResultResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The billing calculation results for each module.
+   */
   moduleDetails?: DescribeChargeResultResponseBodyModuleDetails[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of calculated Security Capacity Units (SeCUs).
+   * 
    * @example
    * 1080
    */

package/src/models/DescribeCloudResourceAccessPortDetailsRequest.ts

@@ -7,7 +7,7 @@ export class DescribeCloudResourceAccessPortDetailsRequest 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.
    * 
@@ -41,10 +41,11 @@ export class DescribeCloudResourceAccessPortDetailsRequest extends $dara.Model {
   port?: string;
   /**
    * @remarks
-   * The type of the protocol. Valid values:
+   * The protocol. Valid values:
    * 
-   * *   **http**
-   * *   **https**
+   * - **http**: HTTP.
+   * 
+   * - **https**: HTTPS.
    * 
    * @example
    * https
@@ -52,10 +53,11 @@ export class DescribeCloudResourceAccessPortDetailsRequest extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region where the WAF instance resides. 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
@@ -63,7 +65,7 @@ export class DescribeCloudResourceAccessPortDetailsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The instance ID of the resource.
+   * The ID of the resource instance.
    * 
    * This parameter is required.
    * 
@@ -73,7 +75,7 @@ export class DescribeCloudResourceAccessPortDetailsRequest extends $dara.Model {
   resourceInstanceId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfm***q
@@ -81,11 +83,15 @@ export class DescribeCloudResourceAccessPortDetailsRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The cloud service. Valid values:
+   * The type of the cloud service. Valid values:
+   * 
+   * - **clb4**: Layer 4 Classic Load Balancer (CLB).
+   * 
+   * - **clb7**: Layer 7 CLB.
+   * 
+   * - **ecs**: Elastic Compute Service (ECS).
    * 
-   * *   **clb4**: Layer 4 CLB.
-   * *   **clb7**: Layer 7 CLB.
-   * *   **ecs**: ECS.
+   * - **nlb**: Network Load Balancer (NLB).
    * 
    * @example
    * clb7