@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/GetUserWafRulesetResponseBody.ts

@@ -7,15 +7,11 @@ import { WafRuleConfig } from "./WafRuleConfig";
 export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   /**
    * @remarks
-   * The action for the rule. Valid values:
-   * 
-   * - `deny`: Blocks the request.
-   * 
-   * - `monitor`: Monitors the request.
-   * 
-   * - `js`: Triggers a JS challenge.
-   * 
-   * - `captcha`: Triggers a CAPTCHA challenge.
+   * The action of the rule. Valid values:
+   * - deny: Block.
+   * - monitor: Monitor.
+   * - js: JavaScript Challenge.
+   * - captcha: Slider challenge.
    * 
    * @example
    * deny
@@ -23,7 +19,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   action?: string;
   /**
    * @remarks
-   * A list of WAF rule statistics fields.
+   * The list of statistics fields for the WAF rule.
    * 
    * @example
    * ["http.host"]
@@ -31,7 +27,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   characteristicsFields?: string[];
   /**
    * @remarks
-   * The WAF rule configuration.
+   * The configuration of the WAF rule.
    * 
    * @example
    * {
@@ -44,7 +40,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   config?: WafRuleConfig;
   /**
    * @remarks
-   * A list of WAF rule match fields.
+   * The list of match fields for the WAF rule.
    * 
    * @example
    * ["ip.src"]
@@ -52,7 +48,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   fields?: string[];
   /**
    * @remarks
-   * The ID of the WAF rule.
+   * The WAF rule ID.
    * 
    * @example
    * 20000001
@@ -68,23 +64,12 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The evaluation phase of the WAF rule. 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 limiting rule.
-   * 
-   * - `ip_access_rule`: An IP access rule.
-   * 
-   * - `http_bot`: A bot management rule.
-   * 
-   * - `http_security_level_rule`: A security level rule.
+   * The phase in which the WAF rule runs. Valid values:
+   * - http_whitelist: whitelist rule
+   * - http_custom: custom rule
+   * - http_managed: managed rule
+   * - http_anti_scan: scan protection rule
+   * - http_ratelimit: frequency control rule
    * 
    * @example
    * http_custom
@@ -100,7 +85,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   position?: number;
   /**
    * @remarks
-   * The ID of the WAF rule set.
+   * The WAF ruleset ID.
    * 
    * @example
    * 10000001
@@ -108,7 +93,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The skip mode for the WAF rule.
+   * The skip mode of the WAF rule.
    * 
    * @example
    * all
@@ -124,7 +109,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The phases that the rule skips.
+   * The list of phases to skip for the WAF rule.
    * 
    * @example
    * ["http_custom"]
@@ -140,7 +125,11 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The time the WAF rule was last updated.
+   * The time when the WAF rule was last updated.
+   * 
+   * Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).
+   * 
+   * Example: 2025-07-07T15:00:00Z
    * 
    * @example
    * 2025-07-07T15:00:00Z
@@ -208,7 +197,7 @@ export class GetUserWafRulesetResponseBodyRulesetRules extends $dara.Model {
 export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   /**
    * @remarks
-   * The description of the WAF rule set.
+   * The description of the WAF ruleset.
    * 
    * @example
    * example
@@ -216,7 +205,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The expression of the WAF rule set.
+   * The expression of the WAF ruleset.
    * 
    * @example
    * ip.src == 1.1.1.1
@@ -224,7 +213,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   expression?: string;
   /**
    * @remarks
-   * The ID of the WAF rule set.
+   * The WAF ruleset ID.
    * 
    * @example
    * 10000001
@@ -232,7 +221,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the WAF rule set.
+   * The name of the WAF ruleset.
    * 
    * @example
    * example
@@ -240,23 +229,12 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The evaluation phase of the WAF rule set. 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 limiting rule.
-   * 
-   * - `ip_access_rule`: An IP access rule.
-   * 
-   * - `http_bot`: A bot management rule.
-   * 
-   * - `http_security_level_rule`: A security level rule.
+   * The phase in which the WAF rule runs. Valid values:
+   * - http_whitelist: whitelist rule
+   * - http_custom: custom rule
+   * - http_managed: managed rule
+   * - http_anti_scan: scan protection rule
+   * - http_ratelimit: frequency control rule
    * 
    * @example
    * http_custom
@@ -264,7 +242,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The position of the WAF rule set.
+   * The position of the WAF ruleset.
    * 
    * @example
    * 1
@@ -272,7 +250,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   position?: number;
   /**
    * @remarks
-   * A list of rules in the WAF rule set.
+   * The list of rule configurations in the WAF ruleset.
    * 
    * @example
    * [{}]
@@ -280,7 +258,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   rules?: GetUserWafRulesetResponseBodyRulesetRules[];
   /**
    * @remarks
-   * The shared configuration of the WAF rule set.
+   * The shared configuration of the WAF ruleset.
    * 
    * @example
    * {}
@@ -288,7 +266,7 @@ export class GetUserWafRulesetResponseBodyRuleset extends $dara.Model {
   shared?: WafBatchRuleShared;
   /**
    * @remarks
-   * The status of the WAF rule set.
+   * The status of the WAF ruleset.
    * 
    * @example
    * on
@@ -348,7 +326,7 @@ export class GetUserWafRulesetResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The WAF rule set.
+   * The WAF ruleset.
    * 
    * @example
    * {}

package/src/models/GetWafQuotaRequest.ts

@@ -5,15 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class GetWafQuotaRequest extends $dara.Model {
   /**
    * @remarks
-   * The path of the WAF quota. Valid values:
-   * 
-   * - managed_rules_group: The quota for managed rule groups.
-   * 
-   * - list: The quota for custom lists.
-   * 
-   * - page: The quota for custom response pages.
-   * 
-   * - scene_policy: The quota for scene-based protection.
+   * The paths of WAF quotas. Valid values:
+   * * managed_rules_group: the quota for WAF managed rule groups.
+   * * list: the quota for custom lists.
+   * * page: the quota for custom response pages.
+   * * scene_policy: the quota for scenario-specific protection rules.
    * 
    * @example
    * page

package/src/models/GetWafQuotaResponseBody.ts

@@ -8,12 +8,12 @@ import { QuotaListItemsValue } from "./QuotaListItemsValue";
 export class GetWafQuotaResponseBodyQuotaCaptcha extends $dara.Model {
   /**
    * @remarks
-   * Whether captcha rules are enabled.
+   * Indicates whether CAPTCHA rules are enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The maximum number of captcha rules allowed.
+   * The total quantity quota for CAPTCHA rules.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -45,27 +45,27 @@ export class GetWafQuotaResponseBodyQuotaCaptcha extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaList extends $dara.Model {
   /**
    * @remarks
-   * Whether the custom list feature is enabled.
+   * Indicates whether custom lists are enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The quota for each item type in a custom list.
+   * The object that contains quota information for each item type in custom lists.
    */
   items?: { [key: string]: QuotaListItemsValue };
   /**
    * @remarks
-   * The maximum number of items allowed per custom list.
+   * The quantity quota for items in each custom list.
    */
   numberItemsPerList?: WafQuotaInteger;
   /**
    * @remarks
-   * The maximum number of items allowed across all custom lists.
+   * The total quantity quota for items across all custom lists.
    */
   numberItemsTotal?: WafQuotaInteger;
   /**
    * @remarks
-   * The maximum number of custom lists allowed.
+   * The total quantity quota for custom lists.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -112,12 +112,12 @@ export class GetWafQuotaResponseBodyQuotaList extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaManagedRulesGroup extends $dara.Model {
   /**
    * @remarks
-   * Whether the WAF managed rule group feature is enabled.
+   * Indicates whether WAF managed rule groups are enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The maximum number of WAF managed rule groups allowed.
+   * The total quantity quota for WAF managed rule groups.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -149,17 +149,17 @@ export class GetWafQuotaResponseBodyQuotaManagedRulesGroup extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaPage extends $dara.Model {
   /**
    * @remarks
-   * The quota for each Content-Type in a custom response page.
+   * The object that contains quota information for each Content-Type in custom response pages.
    */
   contentTypes?: { [key: string]: QuotaPageContentTypesValue };
   /**
    * @remarks
-   * Whether the custom response page feature is enabled.
+   * Indicates whether custom response pages are enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The maximum number of custom response pages allowed.
+   * The total quantity quota for custom response pages.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -196,12 +196,12 @@ export class GetWafQuotaResponseBodyQuotaPage extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaScenePolicy extends $dara.Model {
   /**
    * @remarks
-   * Whether the scenario protection feature is enabled.
+   * Indicates whether the scenario-specific protection feature is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The maximum number of scenario protection rules allowed.
+   * The total quantity quota for scenario-specific protection rules.
    */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
@@ -233,9 +233,13 @@ export class GetWafQuotaResponseBodyQuotaScenePolicy extends $dara.Model {
 export class GetWafQuotaResponseBodyQuotaSliderCaptchaPage extends $dara.Model {
   /**
    * @remarks
-   * Whether slider captcha pages are enabled.
+   * Indicates whether slider CAPTCHA pages are enabled.
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The quantity quota for slider CAPTCHA pages.
+   */
   numberTotal?: WafQuotaInteger;
   static names(): { [key: string]: string } {
     return {
@@ -266,32 +270,32 @@ export class GetWafQuotaResponseBodyQuotaSliderCaptchaPage extends $dara.Model {
 export class GetWafQuotaResponseBodyQuota extends $dara.Model {
   /**
    * @remarks
-   * The quota for captcha rules.
+   * The quota information for CAPTCHA rules.
    */
   captcha?: GetWafQuotaResponseBodyQuotaCaptcha;
   /**
    * @remarks
-   * The quota for custom lists.
+   * The quota information for custom lists.
    */
   list?: GetWafQuotaResponseBodyQuotaList;
   /**
    * @remarks
-   * The quota for WAF managed rule groups.
+   * The quota information for WAF managed rule groups.
    */
   managedRulesGroup?: GetWafQuotaResponseBodyQuotaManagedRulesGroup;
   /**
    * @remarks
-   * The quota for custom response pages.
+   * The quota information for custom response pages.
    */
   page?: GetWafQuotaResponseBodyQuotaPage;
   /**
    * @remarks
-   * The quota for scenario protection.
+   * The quota information for scenario-specific protection rules.
    */
   scenePolicy?: GetWafQuotaResponseBodyQuotaScenePolicy;
   /**
    * @remarks
-   * The quota for slider captcha pages.
+   * The quota information for slider CAPTCHA pages.
    */
   sliderCaptchaPage?: GetWafQuotaResponseBodyQuotaSliderCaptchaPage;
   static names(): { [key: string]: string } {
@@ -346,7 +350,7 @@ export class GetWafQuotaResponseBodyQuota extends $dara.Model {
 export class GetWafQuotaResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The quota details.
+   * The returned quota information.
    */
   quota?: GetWafQuotaResponseBodyQuota;
   /**

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. You can get this ID by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation.
+   * The ID of the WAF rule. You can call the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetWafRuleRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The ID of the site. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetWafRuleResponseBody.ts

@@ -11,7 +11,7 @@ export class GetWafRuleResponseBody extends $dara.Model {
   config?: WafRuleConfig;
   /**
    * @remarks
-   * The ID of the WAF rule. You can get this ID by calling the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation.
+   * The ID of the WAF rule. You can call the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation to obtain the ID.
    * 
    * @example
    * 2000001
@@ -19,7 +19,7 @@ export class GetWafRuleResponseBody extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the rule.
+   * The rule name.
    * 
    * This parameter is required.
    * 
@@ -29,23 +29,15 @@ export class GetWafRuleResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * 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
+   * The phase in which the WAF rule runs. Valid values:
+   * - http_whitelist: whitelist rule
+   * - http_custom: custom rule
+   * - http_managed: managed rule
+   * - http_anti_scan: scan protection rule
+   * - http_ratelimit: frequency control rule
+   * - ip_access_rule: IP access rule
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rule
    * 
    * This parameter is required.
    * 
@@ -71,12 +63,12 @@ export class GetWafRuleResponseBody extends $dara.Model {
   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.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ID.
    */
   rulesetId?: number;
   /**
    * @remarks
-   * The status of the rule.
+   * The rule status.
    * 
    * @example
    * on
@@ -84,7 +76,11 @@ export class GetWafRuleResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time the rule was last updated.
+   * The time when the rule was last modified.
+   * 
+   * Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).
+   * 
+   * Example: 2026-06-10T14:23:45Z
    * 
    * @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. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ID.
    * 
    * @example
    * 10000001
@@ -13,23 +13,15 @@ export class GetWafRulesetRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * 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
+   * The WAF rule execution phase. Valid values:
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: rate limiting rules
+   * - ip_access_rule: IP access rules
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rules
    * 
    * @example
    * http_bot
@@ -37,7 +29,7 @@ export class GetWafRulesetRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The site ID. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the ID.
    * 
    * @example
    * 1

package/src/models/GetWafRulesetResponseBody.ts

@@ -7,7 +7,7 @@ import { WafBatchRuleShared } from "./WafBatchRuleShared";
 export class GetWafRulesetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ID.
    * 
    * @example
    * 10000001
@@ -25,23 +25,15 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * 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
+   * The WAF rule execution phase. Valid values:
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: rate limiting rules
+   * - ip_access_rule: IP access rules
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rules
    * 
    * This parameter is required.
    * 
@@ -64,7 +56,7 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   rules?: WafRuleConfig[];
   /**
    * @remarks
-   * The shared configuration for rules within the ruleset.
+   * The shared configuration of rules in the ruleset.
    */
   shared?: WafBatchRuleShared;
   /**
@@ -77,7 +69,11 @@ export class GetWafRulesetResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the ruleset was last updated.
+   * The last modification time of the ruleset.
+   * 
+   * Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).
+   * 
+   * Example: 2026-06-10T14:23:45Z
    * 
    * @example
    * 2024-01-01T00:00:00Z

package/src/models/ListCertificatesByRecordRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ListCertificatesByRecordRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to return certificate details. A value of `1` includes certificate details, whereas a value of `0` excludes them.
+   * Specifies whether to return certificate details.
    * 
    * @example
-   * 1
+   * true
    */
   detail?: boolean;
   /**
@@ -23,7 +23,7 @@ export class ListCertificatesByRecordRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The site ID. To obtain this ID, call the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to query the site ID.
    * 
    * This parameter is required.
    * 
@@ -33,10 +33,10 @@ export class ListCertificatesByRecordRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Specifies whether to return only valid certificates. A value of `1` returns only valid certificates, whereas `0` returns all matching certificates.
+   * Specifies whether to return only valid certificates.
    * 
    * @example
-   * 1
+   * true
    */
   validOnly?: boolean;
   static names(): { [key: string]: string } {