@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/DescribeApisecExamplesRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecExamplesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The type of API security threat.
+   * 
    * @example
    * LackOfSpeedLimit
    */
   abnormalTag?: string;
   /**
    * @remarks
+   * The ID of the API.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,17 +22,33 @@ export class DescribeApisecExamplesRequest extends $dara.Model {
    */
   apiId?: string;
   /**
+   * @remarks
+   * The ID of the Hybrid Cloud WAF cluster.
+   * 
+   * > This parameter is available only in hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query information about Hybrid Cloud WAF clusters.
+   * 
    * @example
    * 176
    */
   clusterId?: string;
   /**
+   * @remarks
+   * The type of the example. Valid values:
+   * 
+   * - **sensitive**: sensitive data.
+   * 
+   * - **risk**: threat.
+   * 
    * @example
    * sensitive
    */
   exampleType?: string;
   /**
    * @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
@@ -35,29 +56,49 @@ export class DescribeApisecExamplesRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Valid values: 1 to 5. Default value: 5.
+   * 
    * @example
    * 5
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   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 list of sensitive data types in requests.
+   */
   requestSensitiveTypeList?: string[];
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
-   * @example
-   * LackOfSpeedLimit
+   * @remarks
+   * The list of sensitive data types in responses.
    */
   responseSensitiveTypeList?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeApisecExamplesResponseBody.ts

@@ -4,10 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData extends $dara.Model {
   /**
+   * @remarks
+   * The code that indicates the type of sensitive data in the request.
+   * 
    * @example
    * 1000
    */
   sensitiveCode?: string;
+  /**
+   * @remarks
+   * The list of sensitive data.
+   */
   sensitiveDataList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -37,10 +44,17 @@ export class DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData exte
 
 export class DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData extends $dara.Model {
   /**
+   * @remarks
+   * The code that indicates the type of sensitive data in the response.
+   * 
    * @example
    * 1000
    */
   sensitiveCode?: string;
+  /**
+   * @remarks
+   * The list of sensitive data.
+   */
   sensitiveDataList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -70,19 +84,68 @@ export class DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData ext
 
 export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
   /**
+   * @remarks
+   * The complete URL of the API request.
+   * 
    * @example
    * http://www.test.com/api/v1/hello.php?token=TkJGQw
    */
   apiUrl?: string;
+  /**
+   * @remarks
+   * The proof-of-concept (PoC) request.
+   */
   pocPayload?: string;
   /**
+   * @remarks
+   * The protocol type of the API request. Valid values:
+   * 
+   * - **http**: HTTP
+   * 
+   * - **https**: HTTPS
+   * 
    * @example
    * http
    */
   protocol?: string;
+  /**
+   * @remarks
+   * The content of the sample request. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields:
+   * 
+   * - **method**: the request method.
+   * 
+   * - **host**: the requested domain name.
+   * 
+   * - **header**: the request header.
+   * 
+   * - **server_port**: the service port.
+   * 
+   * - **body**: the request body.
+   * 
+   * - **url**: the URI of the request.
+   * 
+   * - **server_protocol**: the server-side protocol.
+   * 
+   * > If the **body** content exceeds 16 KB, only a portion of the content is returned.
+   */
   request?: string;
+  /**
+   * @remarks
+   * The list of sensitive data in the request.
+   */
   requestSensitiveData?: DescribeApisecExamplesResponseBodyExamplesRequestSensitiveData[];
   /**
+   * @remarks
+   * The content of the sample response. This is a string converted from a JSON object that consists of a series of parameters. The JSON object contains the following fields:
+   * 
+   * - **status**: the status code.
+   * 
+   * - **header**: the response header.
+   * 
+   * - **body**: the response body.
+   * 
+   * > If the **body** content exceeds 16 KB, only a portion of the content is returned.
+   * 
    * @example
    * {
    *   "header": {
@@ -95,6 +158,10 @@ export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
    * }
    */
   response?: string;
+  /**
+   * @remarks
+   * The list of sensitive data in the response.
+   */
   responseSensitiveData?: DescribeApisecExamplesResponseBodyExamplesResponseSensitiveData[];
   static names(): { [key: string]: string } {
     return {
@@ -136,23 +203,39 @@ export class DescribeApisecExamplesResponseBodyExamples extends $dara.Model {
 }
 
 export class DescribeApisecExamplesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API security examples.
+   */
   examples?: DescribeApisecExamplesResponseBodyExamples[];
   /**
+   * @remarks
+   * The number of entries returned on each page. Valid values: 1 to 5. Default value: 5.
+   * 
    * @example
    * 5
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * D7861F61-5B61-46CE-A47C-6B19160D5EB0
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 5
    */

package/src/models/DescribeApisecLogDeliveriesRequest.ts

@@ -7,7 +7,7 @@ export class DescribeApisecLogDeliveriesRequest 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.
+   * > 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.
    * 
@@ -19,8 +19,9 @@ export class DescribeApisecLogDeliveriesRequest extends $dara.Model {
    * @remarks
    * The region where the 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.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeApisecLogDeliveriesResponseBody.ts

@@ -7,9 +7,11 @@ export class DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs extends $dar
    * @remarks
    * The type of the log subscription. Valid values:
    * 
-   * *   **risk**: risk information.
-   * *   **event**: attack event information.
-   * *   **asset**: asset information.
+   * - **risk**: risk information.
+   * 
+   * - **event**: attack event information.
+   * 
+   * - **asset**: asset information.
    * 
    * @example
    * risk
@@ -43,8 +45,9 @@ export class DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs extends $dar
    * @remarks
    * The status of API security log subscription. Valid values:
    * 
-   * *   **true**: enabled.
-   * *   **false**: disabled.
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
    * 
    * @example
    * true
@@ -87,7 +90,7 @@ export class DescribeApisecLogDeliveriesResponseBody extends $dara.Model {
   deliveryConfigs?: DescribeApisecLogDeliveriesResponseBodyDeliveryConfigs[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 2EFCFE18-78F8-5079-B312-07***48B

package/src/models/DescribeApisecMatchedHostsRequest.ts

@@ -6,7 +6,8 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   /**
    * @remarks
    * The ID of the hybrid cloud cluster.
-   * >For hybrid cloud scenarios only, you can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the hybrid cloud clusters.
+   * 
+   * > This parameter is used only in hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to obtain information about hybrid cloud clusters.
    * 
    * @example
    * 433
@@ -14,9 +15,9 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   clusterId?: 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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to view the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -34,7 +35,7 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return for a paged query. Default value: **1**.
    * 
    * @example
    * 1
@@ -42,7 +43,7 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries to return on each page for a paged query. Default value: **10**.
    * 
    * @example
    * 8
@@ -50,10 +51,11 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @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
    * cn-hangzhou
@@ -71,9 +73,11 @@ export class DescribeApisecMatchedHostsRequest extends $dara.Model {
    * @remarks
    * The detection type. Valid values:
    * 
-   * *   **api**: API-related domain names
-   * *   **abnormal**: risk-related domain names
-   * *   **event**: security event-related domain names
+   * - **api**: the list of domain names for API assets.
+   * 
+   * - **abnormal**: the list of domain names that have threats.
+   * 
+   * - **event**: the list of domain names that have management events.
    * 
    * @example
    * event

package/src/models/DescribeApisecMatchedHostsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecMatchedHostsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of APIs related to the domain name.
+   * The number of queries.
    * 
    * @example
    * 31
@@ -45,12 +45,12 @@ export class DescribeApisecMatchedHostsResponseBodyData extends $dara.Model {
 export class DescribeApisecMatchedHostsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The domain names.
+   * The list of domain names.
    */
   data?: DescribeApisecMatchedHostsResponseBodyData[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 8D4CA088-F72B-5658-BD5B-ECE8B8F0C7BB

package/src/models/DescribeApisecProtectionGroupsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The API security detection switch.
    * 
    * @example
    * 1
@@ -13,9 +13,9 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   apisecStatus?: number;
   /**
    * @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.
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -41,10 +41,11 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (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
@@ -52,7 +53,7 @@ export class DescribeApisecProtectionGroupsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the protected object group to which the protected object belongs.
+   * The name of the protected object group.
    * 
    * @example
    * group1

package/src/models/DescribeApisecProtectionGroupsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * The master switch for API security.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
   apisecStatus?: number;
   /**
    * @remarks
-   * The switch of the compliance check feature.
+   * The compliance check switch.
    * 
    * @example
    * 0
@@ -29,7 +29,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
   resourceGroup?: string;
   /**
    * @remarks
-   * The switch of the tracing and auditing feature.
+   * The traceability audit switch.
    * 
    * @example
    * 0
@@ -65,7 +65,7 @@ export class DescribeApisecProtectionGroupsResponseBodyData extends $dara.Model
 export class DescribeApisecProtectionGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The protected object groups.
+   * The list of protected object groups.
    */
   data?: DescribeApisecProtectionGroupsResponseBodyData[];
   /**

package/src/models/DescribeApisecProtectionResourcesRequest.ts

@@ -5,7 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * Indicates whether the API security feature is enabled for the protected object. Valid values:
+   * 
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -15,7 +19,7 @@ export class DescribeApisecProtectionResourcesRequest 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 current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -25,7 +29,7 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number of the page to return. Default value: **1**.
    * 
    * @example
    * 1
@@ -33,7 +37,7 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **10**.
+   * The number of entries to return on each page. Default value: **10**.
    * 
    * @example
    * 10
@@ -41,10 +45,11 @@ export class DescribeApisecProtectionResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * The region where the WAF instance resides. 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/DescribeApisecProtectionResourcesResponseBody.ts

@@ -5,7 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The switch of the API security module.
+   * Indicates whether the API security feature is enabled for the protected object. Valid values:
+   * 
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -13,7 +17,11 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
   apisecStatus?: number;
   /**
    * @remarks
-   * The switch of the compliance check feature.
+   * Indicates whether the compliance check feature is enabled. Valid values:
+   * 
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -21,7 +29,7 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
   reportStatus?: number;
   /**
    * @remarks
-   * The protected object.
+   * The name of the protected object.
    * 
    * @example
    * cwaf-***-waf
@@ -29,7 +37,11 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
   resource?: string;
   /**
    * @remarks
-   * The switch of the tracing and auditing feature.
+   * Indicates whether the source tracing feature is enabled. Valid values:
+   * 
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
    * @example
    * 0
@@ -65,7 +77,7 @@ export class DescribeApisecProtectionResourcesResponseBodyData extends $dara.Mod
 export class DescribeApisecProtectionResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The protected objects.
+   * The list of protected objects.
    */
   data?: DescribeApisecProtectionResourcesResponseBodyData[];
   /**