@alicloud/esa20240910 3.4.0 → 3.5.0

package/src/models/ListSiteRoutesResponseBody.ts

@@ -5,10 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * Whether bypass mode is enabled. Valid values:
-   * 
+   * The bypass mode. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -25,11 +23,10 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Valid values:
-   * 
-   * - global: Global configuration.
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
    * 
-   * - rule: Rule-based configuration.
+   * - global: Queries global configurations.
+   * - rule: Queries rule configurations.
    * 
    * @example
    * global
@@ -37,10 +34,8 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Whether CDN fallback is enabled. Valid values:
-   * 
+   * The CDN fallback. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -50,9 +45,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
    * The configuration mode. Valid values:
-   * 
    * - simple: Simple mode.
-   * 
    * - custom: Custom mode.
    * 
    * @example
@@ -61,10 +54,8 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * Whether the route is enabled. Valid values:
-   * 
+   * The route switch. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -81,7 +72,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The routine name.
+   * The Edge Routine name.
    * 
    * @example
    * test-routine1
@@ -97,7 +88,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The rule execution sequence.
+   * The execution order of the rule.
    * 
    * @example
    * 1
@@ -105,7 +96,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site version.
+   * The version number of the site.
    * 
    * @example
    * 1
@@ -113,7 +104,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The ER timeout.
+   * The Edge Routine timeout period, in seconds.
    * 
    * @example
    * 60
@@ -165,12 +156,12 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
 export class ListSiteRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of returned configs.
+   * The configuration list in the response.
    */
   configs?: ListSiteRoutesResponseBodyConfigs[];
   /**
    * @remarks
-   * The current page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -178,7 +169,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -194,7 +185,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of records.
    * 
    * @example
    * 16

package/src/models/ListUrlObservationsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUrlObservationsRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID,
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,7 +13,7 @@ export class ListUrlObservationsRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The page number. Page starts from page 1. Default value: 1
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListUrlObservationsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **500**. Valid values: **1 to 500**.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -29,7 +29,7 @@ export class ListUrlObservationsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can obtain this value by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/ListUrlObservationsResponseBody.ts

@@ -13,10 +13,10 @@ export class ListUrlObservationsResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * SDK integration. Valid values:
+   * The SDK integration method. Valid values:
    * 
-   * *   **automatic**
-   * *   **manual**
+   * - **automatic**: Automatic integration.
+   * - **manual**: Manual integration.
    * 
    * @example
    * manual
@@ -58,12 +58,12 @@ export class ListUrlObservationsResponseBodyConfigs extends $dara.Model {
 export class ListUrlObservationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configurations of the feature.
+   * The configuration data.
    */
   configs?: ListUrlObservationsResponseBodyConfigs[];
   /**
    * @remarks
-   * The number of the returned page.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -79,7 +79,7 @@ export class ListUrlObservationsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
@@ -87,7 +87,7 @@ export class ListUrlObservationsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 1
@@ -95,7 +95,7 @@ export class ListUrlObservationsResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 1

package/src/models/ListWafRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafRulesRequestQueryArgs extends $dara.Model {
   /**
    * @remarks
-   * Performs a partial-match search for a value in an IP access control rule.
+   * The value in IP access control for fuzzy match.
    * 
    * @example
    * 10.0.0.1
@@ -13,7 +13,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   configValueLike?: string;
   /**
    * @remarks
-   * Specifies whether to sort the results in descending order.
+   * Specifies whether to reverse the sort order.
    * 
    * @example
    * true
@@ -21,7 +21,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   desc?: boolean;
   /**
    * @remarks
-   * Filters results by the exact WAF rule ID.
+   * The WAF rule ID for exact match.
    * 
    * @example
    * 20000001
@@ -29,7 +29,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Performs a partial-match search on the WAF rule ID or name.
+   * The WAF rule ID or name for fuzzy match.
    * 
    * @example
    * example
@@ -37,7 +37,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   idNameLike?: string;
   /**
    * @remarks
-   * Performs a partial-match search on the WAF rule name.
+   * The WAF rule name for fuzzy match.
    * 
    * @example
    * example
@@ -45,7 +45,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * Sorts the results by the specified field.
+   * Sorts the returned list by a specified column.
    * 
    * @example
    * position
@@ -53,7 +53,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * Filters results by the exact WAF rule status.
+   * The WAF rule status for exact match.
    * 
    * @example
    * on
@@ -95,7 +95,7 @@ export class ListWafRulesRequestQueryArgs extends $dara.Model {
 export class ListWafRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The number of the page to return.
+   * The page number for pagination.
    * 
    * @example
    * 1
@@ -103,7 +103,7 @@ export class ListWafRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of items to return per page.
+   * The page size for pagination.
    * 
    * @example
    * 20
@@ -111,23 +111,15 @@ export class ListWafRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The WAF rule execution phase. Valid values are:
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
-   * 
-   * - `http_ratelimit`: rate limiting rule
-   * 
-   * - `ip_access_rule`: IP access rule
-   * 
-   * - `http_bot`: Advanced bots
-   * 
-   * - `http_security_level_rule`: security rule
+   * The WAF rule execution phase. 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.
    * 
@@ -137,7 +129,7 @@ export class ListWafRulesRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * Query filters.
+   * The query filter conditions.
    * 
    * @example
    * http_custom
@@ -145,7 +137,7 @@ export class ListWafRulesRequest extends $dara.Model {
   queryArgs?: ListWafRulesRequestQueryArgs;
   /**
    * @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 ruleset ID.
    * 
    * @example
    * 10000001
@@ -153,7 +145,7 @@ export class ListWafRulesRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @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 site ID.
    * 
    * This parameter is required.
    * 
@@ -163,7 +155,7 @@ export class ListWafRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The site configuration version. For sites with configuration version management enabled, this parameter specifies the version to use. Defaults to 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is 0.
    * 
    * @example
    * 0

package/src/models/ListWafRulesResponseBody.ts

@@ -7,15 +7,11 @@ import { WafTimer } from "./WafTimer";
 export class ListWafRulesResponseBodyRules extends $dara.Model {
   /**
    * @remarks
-   * The action to take when a rule matches.
-   * 
-   * - `deny`: Block the request.
-   * 
-   * - `monitor`: Log the request without blocking it.
-   * 
-   * - `js`: Issue a JS challenge.
-   * 
-   * - `captcha`: Issue a CAPTCHA challenge.
+   * The action associated with the rule. Valid values:
+   * - deny: Block.
+   * - monitor: Monitor.
+   * - js: JavaScript Challenge.
+   * - captcha: Slider challenge.
    * 
    * @example
    * deny
@@ -23,22 +19,22 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   action?: string;
   /**
    * @remarks
-   * A list of tracking characteristics for rate limit rules.
+   * The list of statistical objects for frequency control rules.
    */
   characteristicsFields?: string[];
   /**
    * @remarks
-   * The rule configuration object.
+   * The rule configuration.
    */
   config?: WafRuleConfig;
   /**
    * @remarks
-   * An array of match fields for the rule.
+   * The list of matching fields for the rule.
    */
   fields?: string[];
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * 20000001
@@ -46,7 +42,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the rule.
+   * The rule name.
    * 
    * @example
    * example
@@ -54,23 +50,15 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The WAF rule\\"s execution phase.
-   * 
-   * - `http_whitelist`: Whitelist rule.
-   * 
-   * - `http_custom`: Custom rule.
-   * 
-   * - `http_managed`: Managed rule.
-   * 
-   * - `http_anti_scan`: Scan protection rule.
-   * 
-   * - `http_ratelimit`: Rate limit rule.
-   * 
-   * - `ip_access_rule`: IP access rule.
-   * 
-   * - `http_bot`: Advanced bot management rule.
-   * 
-   * - `http_security_level_rule`: Security level rule.
+   * The WAF rule execution phase. 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
    * 
    * @example
    * http_custom
@@ -78,7 +66,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The position of the rule within the ruleset.
+   * The position of the rule in the corresponding ruleset.
    * 
    * @example
    * 1
@@ -86,7 +74,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   position?: number;
   /**
    * @remarks
-   * The ID of the ruleset.
+   * The ruleset ID.
    * 
    * @example
    * 10000001
@@ -94,7 +82,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The skip behavior for whitelist rules.
+   * The skip property for whitelist rules.
    * 
    * @example
    * part
@@ -102,7 +90,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   skip?: string;
   /**
    * @remarks
-   * The status of the rule.
+   * The rule status.
    * 
    * @example
    * on
@@ -110,17 +98,17 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * An array of WAF phases to skip when the whitelist rule matches.
+   * The list of WAF phases to skip for whitelist rules.
    */
   tags?: string[];
   /**
    * @remarks
-   * The effective time configuration for the rule.
+   * The effective period configuration of the rule.
    */
   timer?: WafTimer;
   /**
    * @remarks
-   * The type of the rule.
+   * The rule type.
    * 
    * @example
    * http_custom
@@ -128,7 +116,11 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * When the rule was last updated.
+   * The last modification time of the rule.
+   * 
+   * Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).
+   * 
+   * Example: 2026-06-10T14:23:45Z
    * 
    * @example
    * 2024-01-01T00:00:00Z
@@ -201,7 +193,7 @@ export class ListWafRulesResponseBodyRules extends $dara.Model {
 export class ListWafRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of rules used in this WAF phase for the site\\"s instance.
+   * The number of rules used in the WAF phase for the instance associated with the site.
    * 
    * @example
    * 10
@@ -217,7 +209,7 @@ export class ListWafRulesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of items per page.
+   * The page size.
    * 
    * @example
    * 20
@@ -233,12 +225,12 @@ export class ListWafRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * An array of rule objects.
+   * The list of rules returned.
    */
   rules?: ListWafRulesResponseBodyRules[];
   /**
    * @remarks
-   * The number of rules used by the site.
+   * The site usage.
    * 
    * @example
    * 5
@@ -246,7 +238,7 @@ export class ListWafRulesResponseBody extends $dara.Model {
   siteUsage?: number;
   /**
    * @remarks
-   * The total number of filtered rules.
+   * The total number of rules after filtering.
    * 
    * @example
    * 20

package/src/models/ListWafRulesShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafRulesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The number of the page to return.
+   * The page number for pagination.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of items to return per page.
+   * The page size for pagination.
    * 
    * @example
    * 20
@@ -21,23 +21,15 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The WAF rule execution phase. Valid values are:
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
-   * 
-   * - `http_ratelimit`: rate limiting rule
-   * 
-   * - `ip_access_rule`: IP access rule
-   * 
-   * - `http_bot`: Advanced bots
-   * 
-   * - `http_security_level_rule`: security rule
+   * The WAF rule execution phase. 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.
    * 
@@ -47,7 +39,7 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * Query filters.
+   * The query filter conditions.
    * 
    * @example
    * http_custom
@@ -55,7 +47,7 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   queryArgsShrink?: string;
   /**
    * @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 ruleset ID.
    * 
    * @example
    * 10000001
@@ -63,7 +55,7 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @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 site ID.
    * 
    * This parameter is required.
    * 
@@ -73,7 +65,7 @@ export class ListWafRulesShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The site configuration version. For sites with configuration version management enabled, this parameter specifies the version to use. Defaults to 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is 0.
    * 
    * @example
    * 0