@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/GetWafQuotaResponseBody.ts

@@ -6,7 +6,15 @@ import { QuotaListItemsValue } from "./QuotaListItemsValue";
 
 
 export class GetWafQuotaResponseBodyQuotaCaptcha extends $dara.Model {
+  /**
+   * @remarks
+   * Whether captcha rules are enabled.
+   */
   enable?: boolean;
+  /**
+   * @remarks
+   * The maximum number of captcha rules allowed.
+   */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
     return {
@@ -37,27 +45,27 @@ export class GetWafQuotaResponseBodyQuotaCaptcha extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaList extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the custom list is enabled.
+   * Whether the custom list feature is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * An object containing quota information for each type of item in the custom list.
+   * The quota for each item type in a custom list.
    */
   items?: { [key: string]: QuotaListItemsValue };
   /**
    * @remarks
-   * The number quota allowed per custom list.
+   * The maximum number of items allowed per custom list.
    */
   numberItemsPerList?: WafQuotaInteger;
   /**
    * @remarks
-   * The total number quota allowed for items in all custom lists.
+   * The maximum number of items allowed across all custom lists.
    */
   numberItemsTotal?: WafQuotaInteger;
   /**
    * @remarks
-   * The total number quota allowed for custom lists.
+   * The maximum number of custom lists allowed.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -104,12 +112,12 @@ export class GetWafQuotaResponseBodyQuotaList extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaManagedRulesGroup extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the WAF managed rules group is enabled.
+   * Whether the WAF managed rule group feature is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The total number quota allowed for the WAF managed rules group.
+   * The maximum number of WAF managed rule groups allowed.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -141,17 +149,17 @@ export class GetWafQuotaResponseBodyQuotaManagedRulesGroup extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaPage extends $dara.Model {
   /**
    * @remarks
-   * An object containing quota information for each Content-Type in custom response pages.
+   * The quota for each Content-Type in a custom response page.
    */
   contentTypes?: { [key: string]: QuotaPageContentTypesValue };
   /**
    * @remarks
-   * Indicates whether the custom response page is enabled.
+   * Whether the custom response page feature is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The total number quota allowed for custom response pages.
+   * The maximum number of custom response pages allowed.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -188,12 +196,12 @@ export class GetWafQuotaResponseBodyQuotaPage extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaScenePolicy extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the scene protection feature is enabled.
+   * Whether the scenario protection feature is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The total number quota for scene protection rules.
+   * The maximum number of scenario protection rules allowed.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -223,6 +231,10 @@ export class GetWafQuotaResponseBodyQuotaScenePolicy extends $dara.Model {
 }
 
 export class GetWafQuotaResponseBodyQuotaSliderCaptchaPage extends $dara.Model {
+  /**
+   * @remarks
+   * Whether slider captcha pages are enabled.
+   */
   enable?: boolean;
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -252,27 +264,35 @@ export class GetWafQuotaResponseBodyQuotaSliderCaptchaPage extends $dara.Model {
 }
 
 export class GetWafQuotaResponseBodyQuota extends $dara.Model {
+  /**
+   * @remarks
+   * The quota for captcha rules.
+   */
   captcha?: GetWafQuotaResponseBodyQuotaCaptcha;
   /**
    * @remarks
-   * Quota information related to custom lists.
+   * The quota for custom lists.
    */
   list?: GetWafQuotaResponseBodyQuotaList;
   /**
    * @remarks
-   * Quota information related to the WAF managed rules group.
+   * The quota for WAF managed rule groups.
    */
   managedRulesGroup?: GetWafQuotaResponseBodyQuotaManagedRulesGroup;
   /**
    * @remarks
-   * Quota information related to custom response pages.
+   * The quota for custom response pages.
    */
   page?: GetWafQuotaResponseBodyQuotaPage;
   /**
    * @remarks
-   * Quota information related to scene protection.
+   * The quota for scenario protection.
    */
   scenePolicy?: GetWafQuotaResponseBodyQuotaScenePolicy;
+  /**
+   * @remarks
+   * The quota for slider captcha pages.
+   */
   sliderCaptchaPage?: GetWafQuotaResponseBodyQuotaSliderCaptchaPage;
   static names(): { [key: string]: string } {
     return {
@@ -326,12 +346,12 @@ export class GetWafQuotaResponseBodyQuota extends $dara.Model {
 export class GetWafQuotaResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Returned quota information.
+   * The quota details.
    */
   quota?: GetWafQuotaResponseBodyQuota;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225

package/src/models/GetWafRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetWafRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF rule, which can be obtained by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) interface.
+   * The ID of the WAF rule. You can get this ID by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetWafRuleRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The ID of the site. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/GetWafRuleResponseBody.ts

@@ -6,12 +6,12 @@ import { WafRuleConfig } from "./WafRuleConfig";
 export class GetWafRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Rule configuration.
+   * The rule configuration.
    */
   config?: WafRuleConfig;
   /**
    * @remarks
-   * The ID of the WAF rule, which can be obtained by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) interface.
+   * The ID of the WAF rule. You can get this ID by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation.
    * 
    * @example
    * 2000001
@@ -19,7 +19,7 @@ export class GetWafRuleResponseBody extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Rule name.
+   * The name of the rule.
    * 
    * This parameter is required.
    * 
@@ -29,7 +29,23 @@ export class GetWafRuleResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * WAF operation phase.
+   * The execution phase of the WAF rule.
+   * 
+   * - `http_whitelist`: A whitelist rule
+   * 
+   * - `http_custom`: A custom rule
+   * 
+   * - `http_managed`: A managed rule
+   * 
+   * - `http_anti_scan`: A scan protection rule
+   * 
+   * - `http_ratelimit`: A rate limiting rule
+   * 
+   * - `ip_access_rule`: An IP access rule
+   * 
+   * - `http_bot`: A bot management rule
+   * 
+   * - `http_security_level_rule`: A security rule
    * 
    * This parameter is required.
    * 
@@ -39,7 +55,7 @@ export class GetWafRuleResponseBody extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The position of the rule in the rule set.
+   * The position of the rule in the ruleset.
    * 
    * @example
    * 1
@@ -47,16 +63,20 @@ export class GetWafRuleResponseBody extends $dara.Model {
   position?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The ID of the WAF ruleset. You can get this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   */
   rulesetId?: number;
   /**
    * @remarks
-   * Rule status.
+   * The status of the rule.
    * 
    * @example
    * on
@@ -64,7 +84,7 @@ export class GetWafRuleResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The last modified time of the rule.
+   * The time the rule was last updated.
    * 
    * @example
    * 2024-01-01T00:00:00Z

package/src/models/GetWafRulesetRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetWafRulesetRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF ruleset, which can be obtained by calling the ListWafRulesets interface.
+   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
    * 
    * @example
    * 10000001
@@ -13,7 +13,23 @@ export class GetWafRulesetRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The WAF operation phase, specifying the phase of the ruleset to query.
+   * The execution phase of the WAF ruleset. Valid values:
+   * 
+   * - `http_whitelist`: A whitelist rule
+   * 
+   * - `http_custom`: A custom rule
+   * 
+   * - `http_managed`: A managed rule
+   * 
+   * - `http_anti_scan`: A scan protection rule
+   * 
+   * - `http_ratelimit`: A rate limit rule
+   * 
+   * - `ip_access_rule`: An IP access rule
+   * 
+   * - `http_bot`: A bot rule
+   * 
+   * - `http_security_level_rule`: A security rule
    * 
    * @example
    * http_bot
@@ -21,7 +37,7 @@ export class GetWafRulesetRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * @example
    * 1

package/src/models/GetWafRulesetResponseBody.ts

@@ -7,7 +7,7 @@ import { WafBatchRuleShared } from "./WafBatchRuleShared";
 export class GetWafRulesetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Ruleset ID.
+   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
    * 
    * @example
    * 10000001
@@ -15,7 +15,7 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Ruleset name.
+   * The ruleset name.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,23 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The WAF operation phase applicable to the ruleset.
+   * The execution phase of the WAF ruleset. Valid values:
+   * 
+   * - `http_whitelist`: A whitelist rule
+   * 
+   * - `http_custom`: A custom rule
+   * 
+   * - `http_managed`: A managed rule
+   * 
+   * - `http_anti_scan`: A scan protection rule
+   * 
+   * - `http_ratelimit`: A rate limit rule
+   * 
+   * - `ip_access_rule`: An IP access rule
+   * 
+   * - `http_bot`: A bot rule
+   * 
+   * - `http_security_level_rule`: A security rule
    * 
    * This parameter is required.
    * 
@@ -35,7 +51,7 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
@@ -43,17 +59,17 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * List of rule configurations in the ruleset.
+   * The list of rule configurations in the ruleset.
    */
   rules?: WafRuleConfig[];
   /**
    * @remarks
-   * Shared configurations for the rules in the ruleset.
+   * The shared configuration for rules within the ruleset.
    */
   shared?: WafBatchRuleShared;
   /**
    * @remarks
-   * Ruleset status.
+   * The ruleset status.
    * 
    * @example
    * on
@@ -61,7 +77,7 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The last modified time of the ruleset.
+   * The time when the ruleset was last updated.
    * 
    * @example
    * 2024-01-01T00:00:00Z

package/src/models/HttpDeliveryHeaderParamValue.ts

@@ -6,9 +6,6 @@ export class HttpDeliveryHeaderParamValue extends $dara.Model {
   /**
    * @remarks
    * The static variable.
-   * 
-   * @example
-   * alicdn
    */
   staticValue?: string;
   static names(): { [key: string]: string } {

package/src/models/HttpDeliveryQueryParamValue.ts

@@ -6,9 +6,6 @@ export class HttpDeliveryQueryParamValue extends $dara.Model {
   /**
    * @remarks
    * The static variable.
-   * 
-   * @example
-   * alicdn
    */
   staticValue?: string;
   static names(): { [key: string]: string } {

package/src/models/ListCacheReserveInstancesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCacheReserveInstancesRequest extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -13,7 +13,7 @@ export class ListCacheReserveInstancesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Page number.
+   * The page number.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListCacheReserveInstancesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size. Range: **1~500**, default is **500**.
+   * The number of entries per page. Valid values: **1 to 500**. The default value is **500**.
    * 
    * @example
    * 20
@@ -29,10 +29,11 @@ export class ListCacheReserveInstancesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The criterion by which you want to sort the queried instances. Valid values:
+   * The field to sort the results by. Valid values:
    * 
-   * *   **ExpireTime**
-   * *   **CreateTime**
+   * - **ExpireTime**: Expiration time.
+   * 
+   * - **CreateTime**: Creation time.
    * 
    * @example
    * ExpireTime
@@ -40,10 +41,11 @@ export class ListCacheReserveInstancesRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The order by which you want to sort the queried instances. Valid values:
+   * The sort order. Valid values:
+   * 
+   * - **asc**: Ascending order.
    * 
-   * *   **asc**
-   * *   **desc**
+   * - **desc**: Descending order.
    * 
    * @example
    * desc
@@ -53,10 +55,13 @@ export class ListCacheReserveInstancesRequest extends $dara.Model {
    * @remarks
    * The status of the cache reserve instance. Valid values:
    * 
-   * *   **online**: The instance is in service.
-   * *   **offline**: The instance has expired within an allowable period. In this state, it is unavailable.
-   * *   **disable**: The instance has been released.
-   * *   **overdue**: The instance has been stopped due to overdue payments.
+   * - **online**: The instance is running normally.
+   * 
+   * - **offline**: The instance has expired and is unavailable but remains within the grace period.
+   * 
+   * - **disable**: The instance is disabled.
+   * 
+   * - **overdue**: The instance is suspended due to an overdue payment.
    * 
    * @example
    * online

package/src/models/ListCacheReserveInstancesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Model {
   /**
    * @remarks
-   * Cache reserve capacity. Unit: GB.
+   * The cache reserve capacity, in GB.
    * 
    * @example
    * 512000
@@ -13,7 +13,7 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   cacheReserveCapacity?: number;
   /**
    * @remarks
-   * Cache reserve usage region.
+   * The region where the cache reserve instance is used.
    * 
    * @example
    * HK
@@ -22,7 +22,7 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   chargeType?: string;
   /**
    * @remarks
-   * Instance purchase time.
+   * The time when the instance was created.
    * 
    * @example
    * 2024-04-12T05:41:51Z
@@ -30,7 +30,7 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   createTime?: string;
   /**
    * @remarks
-   * Duration of the instance purchase, unit: months.
+   * The purchase duration of the instance, in months.
    * 
    * @example
    * 3
@@ -38,7 +38,7 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   duration?: number;
   /**
    * @remarks
-   * Instance expiration time.
+   * The expiration time of the instance.
    * 
    * @example
    * 2024-10-05T16:00:00Z
@@ -46,7 +46,7 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   expireTime?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -54,12 +54,15 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
   instanceId?: string;
   /**
    * @remarks
-   * The status of the cache reserve instance. Valid values:
+   * The status of the instance. Valid values:
    * 
-   * *   **online**: The instance is in service.
-   * *   **offline**: The instance has expired within an allowable period. In this state, it is unavailable.
-   * *   **disable**: The instance has been released.
-   * *   **overdue**: The instance has been stopped due to overdue payments.
+   * - **online**: The instance is running normally.
+   * 
+   * - **offline**: The instance has expired and is unavailable but remains within the grace period.
+   * 
+   * - **disable**: The instance is disabled.
+   * 
+   * - **overdue**: The instance is suspended due to an overdue payment.
    * 
    * @example
    * online
@@ -103,12 +106,12 @@ export class ListCacheReserveInstancesResponseBodyInstanceInfo extends $dara.Mod
 export class ListCacheReserveInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The cache reserve instances.
+   * A list of cache reserve instances.
    */
   instanceInfo?: ListCacheReserveInstancesResponseBodyInstanceInfo[];
   /**
    * @remarks
-   * Page number. Default value: **1**.
+   * The page number of the returned data.
    * 
    * @example
    * 1
@@ -116,7 +119,7 @@ export class ListCacheReserveInstancesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size, default **500**, range: **1~500**.
+   * The number of entries returned per page.
    * 
    * @example
    * 500
@@ -124,7 +127,7 @@ export class ListCacheReserveInstancesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 65C66B7B-671A-8297-9187-2R5477247B76
@@ -132,7 +135,7 @@ export class ListCacheReserveInstancesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total count.
+   * The total number of entries.
    * 
    * @example
    * 16
@@ -140,7 +143,7 @@ export class ListCacheReserveInstancesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * Total pages.
+   * The total number of pages.
    * 
    * @example
    * 1

package/src/models/ListCacheRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCacheRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,11 +13,13 @@ export class ListCacheRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule-based configurations. Possible values:
-   * - global: Query global configuration.
-   * - rule: Query rule-based configuration.
+   * The configuration type. You can use this parameter to retrieve the global configuration or rule configurations. Valid values:
    * 
-   * This parameter is optional; if not provided, it will not distinguish between global and rule-based configurations.
+   * - `global`: Returns the global configuration.
+   * 
+   * - `rule`: Returns rule configurations.
+   * 
+   * This parameter is optional. If you omit this parameter, both global and rule configurations are returned.
    * 
    * @example
    * global
@@ -25,7 +27,7 @@ export class ListCacheRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number, defaulting to 1 if not provided.
+   * The page number. The default value is 1.
    * 
    * @example
    * 1
@@ -33,7 +35,7 @@ export class ListCacheRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page, with a maximum of 500. Defaults to 500 if not provided.
+   * The number of entries per page. The maximum value is 500. The default value is 500.
    * 
    * @example
    * 20
@@ -41,7 +43,7 @@ export class ListCacheRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required for a global configuration.
    * 
    * @example
    * test
@@ -49,7 +51,7 @@ export class ListCacheRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can get this ID by calling the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 
@@ -59,7 +61,7 @@ export class ListCacheRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Site version number. For sites with version management enabled, this parameter can specify the site version for which the configuration takes effect, defaulting to version 0.
+   * The site version. For a site with version management enabled, this parameter specifies the version to which the configuration applies. The default value is 0.
    * 
    * @example
    * 1