@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/CreateTransportLayerApplicationRequest.ts

@@ -5,15 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   /**
    * @remarks
-   * The client IP passthrough protocol. Valid values:
-   * 
-   * - **off**: Disables client IP passthrough.
-   * 
-   * - **PPv1**: PROXY Protocol v1. Preserves the client IP address for TCP connections.
-   * 
-   * - **PPv2**: PROXY Protocol v2. Preserves the client IP address for TCP and UDP connections.
-   * 
-   * - **SPP**: Simple Proxy Protocol. Preserves the client IP address for UDP connections.
+   * The client IP pass-through protocol. Valid values:
+   * - **off**: disabled.
+   * - **PPv1**: PROXY Protocol v1. Supports client IP pass-through for TCP.
+   * - **PPv2**: PROXY Protocol v2. Supports client IP pass-through for TCP and UDP.
+   * - **SPP**: Simple Proxy Protocol. Supports client IP pass-through for UDP.
    * 
    * This parameter is required.
    * 
@@ -23,7 +19,7 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * An optional comment for the rule.
+   * The comment for the rule (optional).
    * 
    * @example
    * Test
@@ -31,15 +27,13 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The edge port. Supported formats:
+   * The edge port. The following formats are supported:
    * 
-   * - A single port, for example, `80`.
+   * - A single port, such as 80.
+   * - A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.
+   * - A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.
    * 
-   * - A port range, for example, `81-85`, which includes ports 81, 82, 83, 84, and 85.
-   * 
-   * - A combination of ports and port ranges separated by commas, for example, `80,81-85,90`, which includes ports 80, 81, 82, 83, 84, 85, and 90.
-   * 
-   * Edge ports cannot overlap within a single rule or across multiple rules.
+   * Edge ports within a single rule and across multiple rules must not overlap.
    * 
    * This parameter is required.
    * 
@@ -49,11 +43,10 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   edgePort?: string;
   /**
    * @remarks
-   * The forwarding protocol. Valid values:
-   * 
-   * - `TCP`: The TCP protocol.
+   * The forwarding rule protocol. Valid values:
    * 
-   * - `UDP`: The UDP protocol.
+   * - TCP: TCP protocol.
+   * - UDP: UDP protocol.
    * 
    * This parameter is required.
    * 
@@ -63,7 +56,7 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The origin address. The value must match the specified `SourceType`.
+   * The specific value of the origin, which must match the origin type.
    * 
    * This parameter is required.
    * 
@@ -73,11 +66,10 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The origin port. Supported formats:
+   * Origin Server Port. The following formats are supported:
    * 
-   * - A single port, which supports any valid combination of edge ports.
-   * 
-   * - A port range. You can specify a port range only if the edge port is also a port range. The origin and edge port ranges must be the same size. For example, if the edge port range is `90-93` (4 ports), the origin port range cannot be `81-85` (5 ports).
+   * - A single port. When Origin Server Port is a single port, any valid edge port combination is supported.
+   * - A port range. Origin Server Port can be set to a port range only when the edge port is also a port range, and the range size must match the edge port range. For example, if the edge port is 90-93, you cannot set Origin Server Port to 81-85 because Origin Server Port range size is 5 while the edge port range size is 4, which is inconsistent.
    * 
    * This parameter is required.
    * 
@@ -88,14 +80,10 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   /**
    * @remarks
    * The origin type. Valid values:
-   * 
-   * - **ip**: An IP address.
-   * 
-   * - **domain**: A domain name.
-   * 
-   * - **OP**: An origin pool.
-   * 
-   * - **LB**: A load balancer.
+   * - **ip**: IP address.
+   * - **domain**: domain name.
+   * - **OP**: origin IPAM pool.
+   * - **LB**: load balancing.
    * 
    * This parameter is required.
    * 
@@ -139,11 +127,9 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
 export class CreateTransportLayerApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * Enables or disables network optimization for access from the Chinese mainland. This feature is disabled by default. Valid values:
-   * 
-   * - `on`: Enables the optimization.
-   * 
-   * - `off`: Disables the optimization.
+   * Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -151,11 +137,10 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * Applies IP access rules from Web Application Firewall (WAF) to this Transport Layer Application. Valid values:
-   * 
-   * - `on`: Enables the feature.
+   * The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values:
    * 
-   * - `off`: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -163,7 +148,9 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * Enables or disables IPv6 support.
+   * Specifies whether to enable IPv6. This feature is disabled by default. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * off
@@ -171,12 +158,18 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   ipv6?: string;
   /**
    * @remarks
-   * Enables or disables keep-alive protection.
+   * Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
+   * 
+   * @example
+   * off
    */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * The domain name of the Transport Layer Application.
+   * The domain name of the Layer 4 application.
    * 
    * This parameter is required.
    * 
@@ -193,7 +186,7 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   rules?: CreateTransportLayerApplicationRequestRules[];
   /**
    * @remarks
-   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID. The site must be activated.
    * 
    * This parameter is required.
    * 
@@ -201,6 +194,16 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
    * 123456****
    */
   siteId?: number;
+  /**
+   * @remarks
+   * Specifies whether to enable static IP. This feature is disabled by default. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
+   * 
+   * @example
+   * off
+   */
   staticIp?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateTransportLayerApplicationShrinkRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Enables or disables network optimization for access from the Chinese mainland. This feature is disabled by default. Valid values:
-   * 
-   * - `on`: Enables the optimization.
-   * 
-   * - `off`: Disables the optimization.
+   * Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -17,11 +15,10 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * Applies IP access rules from Web Application Firewall (WAF) to this Transport Layer Application. Valid values:
+   * The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values:
    * 
-   * - `on`: Enables the feature.
-   * 
-   * - `off`: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -29,7 +26,9 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * Enables or disables IPv6 support.
+   * Specifies whether to enable IPv6. This feature is disabled by default. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * off
@@ -37,12 +36,18 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   ipv6?: string;
   /**
    * @remarks
-   * Enables or disables keep-alive protection.
+   * Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
+   * 
+   * @example
+   * off
    */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * The domain name of the Transport Layer Application.
+   * The domain name of the Layer 4 application.
    * 
    * This parameter is required.
    * 
@@ -59,7 +64,7 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   rulesShrink?: string;
   /**
    * @remarks
-   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID. The site must be activated.
    * 
    * This parameter is required.
    * 
@@ -67,6 +72,16 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
    * 123456****
    */
   siteId?: number;
+  /**
+   * @remarks
+   * Specifies whether to enable static IP. This feature is disabled by default. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
+   * 
+   * @example
+   * off
+   */
   staticIp?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateUrlObservationRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUrlObservationRequest extends $dara.Model {
   /**
    * @remarks
-   * SDK integration. Supported
+   * The SDK integration method. Valid values:
    * 
-   * *   **automatic**
-   * *   **manual**
+   * - **automatic**: automatic integration.
+   * - **manual**: manual integration.
    * 
    * This parameter is required.
    * 
@@ -18,7 +18,7 @@ export class CreateUrlObservationRequest extends $dara.Model {
   sdkType?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -28,7 +28,7 @@ export class CreateUrlObservationRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The URL of the web page to monitor.
+   * The URL of the web page to monitor. If the site name is example.com, set Url to example.com/test or site DNS record name/path.
    * 
    * This parameter is required.
    * 

package/src/models/CreateUrlObservationResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateUrlObservationResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * EEEBE525-F576-1196-8DAF-2D70CA3F4D2F

package/src/models/CreateUserWafRulesetRequest.ts

@@ -15,7 +15,13 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The expression for the WAF ruleset.
+   * The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression.
+   * 
+   * Examples:
+   * - `http.host eq "example.com"` — Only requests with the host example.com enter this ruleset.
+   * - `starts_with(http.uri.path, "/api/")` — Only requests with the /api/ prefix enter this ruleset.
+   * 
+   * > The complete expression syntax and available field set are subject to the server-side wirefilter dialect.
    * 
    * This parameter is required.
    * 
@@ -37,6 +43,8 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
    * @remarks
    * The name of the WAF ruleset.
    * 
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores for easy reference. The specific character set, maximum length, and uniqueness constraints are subject to the WAF ruleset service naming conventions.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -45,23 +53,15 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The execution phase of the WAF ruleset.
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
+   * The phase to which the WAF ruleset belongs. Valid values:
    * 
-   * - `http_ratelimit`: rate limiting rule
+   * - 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 rule
-   * 
-   * - `http_bot`: advanced bot
-   * 
-   * - `http_security_level_rule`: security rule
+   * > Note: The supported fields (Expression match fields, Action values, and others) vary by phase. For more information, refer to the rule configuration documentation for the corresponding phase.
    * 
    * This parameter is required.
    * 
@@ -71,17 +71,26 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A list of rule configurations within the WAF ruleset.
+   * The list of rule configurations in the WAF ruleset. Each element corresponds to a rule.
+   * 
+   * - The field structure of each rule is subject to the `WafRuleConfig` data structure, which includes Expression, Action, Name, and other fields.
    */
   rules?: WafRuleConfig[];
   /**
    * @remarks
-   * The shared configuration for WAF batch rules.
+   * The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix.
+   * 
+   * > The field structure is subject to the `WafBatchRuleShared` data structure. If you do not need to share properties, you can leave this parameter empty.
    */
   shared?: WafBatchRuleShared;
   /**
    * @remarks
-   * The status of the WAF ruleset.
+   * The status of the WAF ruleset. Valid values:
+   * 
+   * - on: Enabled. The rules in the ruleset participate in matching and blocking.
+   * - off: Disabled. The ruleset is retained but does not participate in matching.
+   * 
+   * > The complete set of valid values is subject to the server-side enum.
    * 
    * This parameter is required.
    * 

package/src/models/CreateUserWafRulesetResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUserWafRulesetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The WAF ruleset ID.
+   * The ID of the WAF ruleset.
    * 
    * @example
    * 665d3af3621bccf3fe29e1a4
@@ -21,7 +21,7 @@ export class CreateUserWafRulesetResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * A list of rule IDs within the WAF ruleset.
+   * The list of rule IDs in the WAF ruleset.
    */
   ruleIds?: number[];
   static names(): { [key: string]: string } {

package/src/models/CreateUserWafRulesetShrinkRequest.ts

@@ -13,7 +13,13 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The expression for the WAF ruleset.
+   * The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression.
+   * 
+   * Examples:
+   * - `http.host eq "example.com"` — Only requests with the host example.com enter this ruleset.
+   * - `starts_with(http.uri.path, "/api/")` — Only requests with the /api/ prefix enter this ruleset.
+   * 
+   * > The complete expression syntax and available field set are subject to the server-side wirefilter dialect.
    * 
    * This parameter is required.
    * 
@@ -35,6 +41,8 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
    * @remarks
    * The name of the WAF ruleset.
    * 
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores for easy reference. The specific character set, maximum length, and uniqueness constraints are subject to the WAF ruleset service naming conventions.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,23 +51,15 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The execution phase of the WAF ruleset.
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
+   * The phase to which the WAF ruleset belongs. Valid values:
    * 
-   * - `http_ratelimit`: rate limiting rule
+   * - 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 rule
-   * 
-   * - `http_bot`: advanced bot
-   * 
-   * - `http_security_level_rule`: security rule
+   * > Note: The supported fields (Expression match fields, Action values, and others) vary by phase. For more information, refer to the rule configuration documentation for the corresponding phase.
    * 
    * This parameter is required.
    * 
@@ -69,17 +69,26 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A list of rule configurations within the WAF ruleset.
+   * The list of rule configurations in the WAF ruleset. Each element corresponds to a rule.
+   * 
+   * - The field structure of each rule is subject to the `WafRuleConfig` data structure, which includes Expression, Action, Name, and other fields.
    */
   rulesShrink?: string;
   /**
    * @remarks
-   * The shared configuration for WAF batch rules.
+   * The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix.
+   * 
+   * > The field structure is subject to the `WafBatchRuleShared` data structure. If you do not need to share properties, you can leave this parameter empty.
    */
   sharedShrink?: string;
   /**
    * @remarks
-   * The status of the WAF ruleset.
+   * The status of the WAF ruleset. Valid values:
+   * 
+   * - on: Enabled. The rules in the ruleset participate in matching and blocking.
+   * - off: Disabled. The ruleset is retained but does not participate in matching.
+   * 
+   * > The complete set of valid values is subject to the server-side enum.
    * 
    * This parameter is required.
    * 

package/src/models/CreateVideoProcessingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateVideoProcessingRequest extends $dara.Model {
   /**
    * @remarks
-   * Set custom end parameters for FLV files.
+   * The custom FLV end parameter.
    * 
    * @example
    * end
@@ -13,7 +13,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   flvSeekEnd?: string;
   /**
    * @remarks
-   * The custom start parameter for FLV files.
+   * The custom FLV start parameter.
    * 
    * @example
    * start
@@ -21,10 +21,9 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   flvSeekStart?: string;
   /**
    * @remarks
-   * FLV seeking. Valid values:
-   * 
-   * *   by_byte: seek by byte
-   * *   by_time: seek by time.
+   * The FLV seek mode. Valid values:
+   * - by_byte: seek by byte.
+   * - by_time: seek by time.
    * 
    * @example
    * by_byte
@@ -32,7 +31,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   flvVideoSeekMode?: string;
   /**
    * @remarks
-   * Customize the mp4 end parameter.
+   * The custom MP4 end parameter.
    * 
    * @example
    * end
@@ -40,7 +39,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   mp4SeekEnd?: string;
   /**
    * @remarks
-   * Customize the mp4 start parameter.
+   * The custom MP4 start parameter.
    * 
    * @example
    * start
@@ -48,10 +47,9 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   mp4SeekStart?: string;
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
-   * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example:(http.host eq "video.example.com"): Match the specified request.
+   * The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two usage scenarios are supported:
+   * - Match all incoming requests: set the value to true.
+   * - Match specified requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -59,10 +57,9 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:
-   * 
-   * *   on
-   * *   off
+   * The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -70,7 +67,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The name of the scheduling rule. You do not need to set this parameter when you add global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -78,7 +75,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -86,7 +83,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   sequence?: 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 call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -96,7 +93,7 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.
    * 
    * @example
    * 1
@@ -104,10 +101,9 @@ export class CreateVideoProcessingRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * Video seeking. Valid values:
-   * 
-   * *   on
-   * *   off
+   * The video seek (drag-and-play) switch. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on