@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeAbnormalCloudResourcesResponseBody.ts

@@ -4,41 +4,83 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResourcesDetails extends $dara.Model {
   /**
+   * @remarks
+   * The type of the certificate for the HTTPS protocol. Valid values:
+   * 
+   * - **default**: default certificate.
+   * 
+   * - **extension**: additional certificate.
+   * 
    * @example
    * default
    */
   appliedType?: string;
   /**
+   * @remarks
+   * The name of the certificate in SSL Certificate Service.
+   * 
    * @example
    * test-name
    */
   certName?: string;
   /**
+   * @remarks
+   * The cause of the exception. Valid values:
+   * 
+   * InvalidCert: The certificate is invalid.
+   * 
+   * ClientCertOpend: Mutual authentication is enabled.
+   * 
+   * NetworkConfigLost: A network error occurred.
+   * 
+   * UserUploadCert: A custom certificate is uploaded.
+   * 
+   * CertNotExistInCertCenter: The certificate ID does not exist in SSL Certificate Service.
+   * 
+   * CertExpired: The certificate has expired.
+   * 
+   * EmptyCertCN: The common name (CN) is empty.
+   * 
    * @example
    * CertExpired
    */
   code?: string;
   /**
+   * @remarks
+   * The common name (CN) of the certificate.
+   * 
    * @example
    * www.test.com
    */
   commonName?: string;
   /**
+   * @remarks
+   * The time when the certificate expires. This value is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1735009193
    */
   expireTime?: number;
   /**
+   * @remarks
+   * The ID of the certificate that is configured in the cloud service console.
+   * 
    * @example
    * 123-cn-hangzhou
    */
   productCertId?: string;
   /**
+   * @remarks
+   * The name of the certificate that is configured in the cloud service console.
+   * 
    * @example
-   * test-name
+   * test-cert-name
    */
   productCertName?: string;
   /**
+   * @remarks
+   * The additional domain name that is configured in the cloud service console.
+   * 
    * @example
    * www.test.com
    */
@@ -79,29 +121,87 @@ export class DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResourcesDet
 }
 
 export class DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResources extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the cloud resource. This ID is automatically generated by WAF when the resource is added.
+   * 
+   * @example
+   * lb-***-80-clb7
+   */
   cloudResourceId?: string;
+  /**
+   * @remarks
+   * The details of the exception.
+   */
   details?: DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResourcesDetails[];
   /**
+   * @remarks
+   * The cause of the exception. Valid values:
+   * 
+   * - **InvalidCert**: The certificate is invalid.
+   * 
+   * - **ClientCertOpend**: Mutual authentication is enabled.
+   * 
+   * - **NetworkConfigLost**: A network error occurred.
+   * 
+   * - **UserUploadCert**: A custom certificate is uploaded.
+   * 
+   * - **CertNotExistInCertCenter**: The certificate ID does not exist in SSL Certificate Service.
+   * 
+   * - **CertExpired**: The certificate has expired.
+   * 
+   * - **EmptyCertCN**: The common name (CN) is empty.
+   * 
    * @example
    * CertExpired
    */
   reason?: string;
   /**
+   * @remarks
+   * The ID of the instance that is added to WAF.
+   * 
    * @example
    * lb-***
    */
   resourceInstanceId?: string;
   /**
+   * @remarks
+   * The name of the instance that is added to WAF.
+   * 
    * @example
    * test-name
    */
   resourceInstanceName?: string;
   /**
+   * @remarks
+   * The port of the instance that is added to WAF.
+   * 
    * @example
    * 80
    */
   resourceInstancePort?: number;
   /**
+   * @remarks
+   * The cloud service to which the resource belongs. By default, instances of Application Load Balancer (ALB), MSE, FC, and SAE are returned. Valid values:
+   * 
+   * - **alb**: ALB.
+   * 
+   * - **mse**: MSE.
+   * 
+   * - **fc**: FC.
+   * 
+   * - **sae**: SAE.
+   * 
+   * - **ecs**: ECS.
+   * 
+   * - **clb4**: Classic Load Balancer (CLB) that uses TCP.
+   * 
+   * - **clb7**: CLB that uses HTTP or HTTPS.
+   * 
+   * - **nlb**: Network Load Balancer (NLB).
+   * 
+   * > Each cloud service is supported in different regions. If you specify this parameter, make sure that the specified cloud service is supported in the selected region. Otherwise, the request may fail.
+   * 
    * @example
    * clb7
    */
@@ -143,10 +243,14 @@ export class DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResources ex
 }
 
 export class DescribeAbnormalCloudResourcesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The abnormal cloud resources that are added in cloud native mode.
+   */
   abnormalCloudResources?: DescribeAbnormalCloudResourcesResponseBodyAbnormalCloudResources[];
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 66A98669-CC6E-4F3E-80A6-***

package/src/models/DescribeAccountDelegatedStatusRequest.ts

@@ -6,8 +6,7 @@ export class DescribeAccountDelegatedStatusRequest 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 [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 DescribeAccountDelegatedStatusRequest 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

package/src/models/DescribeAccountDelegatedStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountDelegatedStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account.
+   * The Alibaba Cloud account ID.
    * 
    * @example
    * 10***********34
@@ -13,7 +13,7 @@ export class DescribeAccountDelegatedStatusResponseBody extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The name of the Alibaba Cloud account. This parameter is returned only if the account is the delegated administrator account.
+   * The Alibaba Cloud account name. This parameter is returned only when the account is a delegated administrator.
    * 
    * @example
    * account_test
@@ -21,10 +21,11 @@ export class DescribeAccountDelegatedStatusResponseBody extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * Indicates whether the Alibaba Cloud account is the delegated administrator account of the WAF instance.
+   * Indicates whether the user is a delegated administrator of WAF. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: The user is a delegated administrator of WAF.
+   * 
+   * - **false**: The user is not a delegated administrator of WAF.
    * 
    * @example
    * true
@@ -35,7 +36,7 @@ export class DescribeAccountDelegatedStatusResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 8161375D-5958-5627-BFDE-DF14****3E87
+   * 8161375D-5958-5627-BFDE-DF1458A73E87
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribeAddressesRequest.ts

@@ -4,12 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAddressesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The address to query. You can set this parameter to perform a fuzzy match on added addresses.
+   * 
    * @example
    * 1.2.3.3
    */
   addressLike?: 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
@@ -17,26 +24,45 @@ export class DescribeAddressesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number of entries per page for paging. Valid values: 1 to 500. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token for the next page. Set this parameter to the value of **NextToken** returned in the previous API call. Leave this parameter empty for the first page.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The region where the WAF instance is deployed. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud resource group ID.
+   * 
    * @example
    * rg-acfm4gh****wela
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The ID of the address book to query.
+   * 
    * @example
    * 12345678
    */

package/src/models/DescribeAddressesResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAddressesResponseBodyAddressList extends $dara.Model {
   /**
+   * @remarks
+   * The address.
+   * 
    * @example
    * 1.1.1.1
    */
   address?: string;
   /**
+   * @remarks
+   * The most recent modification time of the address. The value is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1760408233000
    */
   gmtModified?: number;
   /**
+   * @remarks
+   * The address book ID.
+   * 
    * @example
    * 12345678
    */
@@ -44,23 +53,40 @@ export class DescribeAddressesResponseBodyAddressList extends $dara.Model {
 }
 
 export class DescribeAddressesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of addresses.
+   */
   addressList?: DescribeAddressesResponseBodyAddressList[];
   /**
+   * @remarks
+   * The number of entries per page for paging. Valid values: 1 to 500. Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token for the next page. If a next page exists, this field contains a value.
+   * > If this parameter has a return value, a next page exists. You can pass the returned **NextToken** as a request parameter to retrieve the next page of data. Repeat this process until no value is returned, which indicates that all data has been retrieved.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8D8EBFB7-E1EB-5236-952A-092EDC72***
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 10
    */

package/src/models/DescribeAlarmBannerRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlarmBannerRequest 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,11 +16,21 @@ export class DescribeAlarmBannerRequest 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-aek2zerdgm****
    */

package/src/models/DescribeAlarmBannerResponseBody.ts

@@ -4,21 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAlarmBannerResponseBodyBannerStatus extends $dara.Model {
   /**
+   * @remarks
+   * The cause of the alert. If **Type** is set to **sandbox**, valid values:
+   * 
+   * - **fivefold**: The queries per second (QPS) of your service exceeds five times the upper limit of your plan.
+   * 
+   * - **4count**: The QPS of your service has exceeded the upper limit of your plan for four or more days.
+   * 
+   * - **exceed10w**: The peak QPS of your service exceeds 100,000.
+   * 
+   * - **costProtection**: Billing protection is triggered.
+   * 
    * @example
    * 4count
    */
   cause?: string;
   /**
+   * @remarks
+   * The count associated with the alert at the time it was triggered.
+   * 
+   * - If **Type** is set to **sandbox**, this parameter indicates the number of days that the QPS has exceeded the upper limit of your plan.
+   * 
    * @example
    * 9008
    */
   count?: number;
   /**
+   * @remarks
+   * Indicates whether an alert is triggered. Valid values:
+   * 
+   * - **true**: An alert is triggered. If **Type** is set to **sandbox**, the instance is in the sandbox.
+   * 
+   * - **false**: No alert is triggered. If **Type** is set to **sandbox**, the instance is not in the sandbox.
+   * 
    * @example
    * true
    */
   status?: boolean;
   /**
+   * @remarks
+   * The alert type. Valid value:
+   * 
+   * - **sandbox**: a sandbox alert.
+   * 
    * @example
    * sandbox
    */
@@ -51,8 +79,15 @@ export class DescribeAlarmBannerResponseBodyBannerStatus extends $dara.Model {
 }
 
 export class DescribeAlarmBannerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The status information of the alert banner.
+   */
   bannerStatus?: DescribeAlarmBannerResponseBodyBannerStatus;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5555DC36-0CF2-5AA3-B1C7-D6BD8****
    */

package/src/models/DescribeAlarmListRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlarmListRequest 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
@@ -12,11 +16,21 @@ export class DescribeAlarmListRequest 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-aek2ipnu***
    */

package/src/models/DescribeAlarmListResponseBody.ts

@@ -4,36 +4,75 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAlarmListResponseBodyAlarms extends $dara.Model {
   /**
+   * @remarks
+   * The cause of the alert. Valid values:
+   * 
+   * - **fivefold**: The QPS exceeds the limit of the current WAF instance specifications.
+   * 
+   * - **4count**: The actual QPS has cumulatively exceeded the limit of the current WAF instance specifications.
+   * 
+   * - **exceed10w**: The peak QPS exceeds 100,000.
+   * 
+   * - **costProtection**: Billing protection is triggered.
+   * 
    * @example
    * 4count
    */
   cause?: string;
   /**
+   * @remarks
+   * The end time of the alert. This is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1605600798
    */
   endTime?: number;
   /**
+   * @remarks
+   * The peak QPS during the alert period.
+   * 
    * @example
    * 12000
    */
   maxQps?: number;
   /**
+   * @remarks
+   * The QPS limit of the current WAF instance specifications.
+   * 
    * @example
    * 10000
    */
   spec?: number;
   /**
+   * @remarks
+   * The start time of the alert. This is a UNIX timestamp. Unit: milliseconds.
+   * 
    * @example
    * 1605600767
    */
   startTime?: number;
   /**
+   * @remarks
+   * The current status of the alert. Valid values:
+   * 
+   * - **1**: The queries per second (QPS) limit is exceeded.
+   * 
+   * - **2**: The WAF instance enters the sandbox.
+   * 
+   * - **3**: The WAF instance is removed from the sandbox.
+   * 
+   * - **4**: The QPS no longer exceeds the limit.
+   * 
    * @example
    * 1
    */
   status?: number;
   /**
+   * @remarks
+   * The type of the alert. Valid value:
+   * 
+   * - **qps**: a QPS alert.
+   * 
    * @example
    * qps
    */
@@ -72,8 +111,15 @@ export class DescribeAlarmListResponseBodyAlarms extends $dara.Model {
 }
 
 export class DescribeAlarmListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The alerts.
+   */
   alarms?: DescribeAlarmListResponseBodyAlarms[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8D8EBFB7-E1EB-5236-952A-092EDC72***
    */

package/src/models/DescribeApiExportsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApiExportsRequest extends $dara.Model {
   /**
    * @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 [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,9 +17,9 @@ export class DescribeApiExportsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Language type. Valid values:
+   * The language type. Valid values:
    * 
-   * - **cn**: Chinese.
+   * - **zh**: Chinese.
    * - **en**: English.
    * 
    * @example
@@ -30,7 +30,7 @@ export class DescribeApiExportsRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number to return in a paging query. Default value: **1**, which indicates the first page.
    * 
    * @example
    * 1
@@ -38,7 +38,7 @@ export class DescribeApiExportsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: **10**.
+   * The number of entries per page in a paging query. Default value: **10**, which indicates 10 entries per page.
    * 
    * @example
    * 10
@@ -46,10 +46,11 @@ export class DescribeApiExportsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the Web Application Firewall (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**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou