@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/UpdateRewriteUrlRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID. You can get this ID by calling the [ListRewriteUrlRules](https://help.aliyun.com/document_detail/2867480.html) API.
+   * The configuration ID. You can call the [ListRewriteUrlRules](https://help.aliyun.com/document_detail/2867480.html) operation to obtain the configuration ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The query string after the rewrite.
+   * The query string after rewriting.
    * 
    * @example
    * example=123
@@ -23,11 +23,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   queryString?: string;
   /**
    * @remarks
-   * The query string rewrite type. Valid values:
-   * 
-   * - static: Static Mode.
-   * 
-   * - dynamic: Dynamic Mode.
+   * The query character string rewrite type. Valid values:
+   * - static: static pattern.
+   * - dynamic: dynamic pattern.
    * 
    * @example
    * static
@@ -35,11 +33,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rewriteQueryStringType?: string;
   /**
    * @remarks
-   * The URI rewrite type. Valid values:
-   * 
-   * - static: Static Mode.
-   * 
-   * - dynamic: Dynamic Mode.
+   * The path rewrite type. Valid values:
+   * - static: static pattern.
+   * - dynamic: dynamic pattern.
    * 
    * @example
    * static
@@ -50,11 +46,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rewriteUriType?: string;
   /**
    * @remarks
-   * The content of the rule, a conditional expression that matches user requests. This parameter is not required for a Global Configuration. Two use cases are supported:
-   * 
-   * - To match all incoming requests, set the value to true.
-   * 
-   * - To match specific requests, set the value to a custom expression, for example, (http.host eq "video.example.com").
+   * The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two 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")
@@ -62,11 +56,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether the rule is enabled. This parameter is not required for a Global Configuration. Valid values:
-   * 
-   * - on: The rule is enabled.
-   * 
-   * - off: The rule is disabled.
+   * The rule switch. This parameter is not required when you add a global configuration. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -74,7 +66,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. This parameter is not required for a Global Configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    * 
    * @example
    * example=123
@@ -82,7 +74,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -90,7 +82,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
+   * 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.
    * 
@@ -100,7 +92,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The destination URI after the rewrite.
+   * The target URI after rewriting.
    * 
    * @example
    * /image/example.jpg

package/src/models/UpdateRoutineRouteRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable bypass mode. Valid values:
-   * 
-   * - on: Enabled
-   * 
-   * - off: Disabled
+   * The bypass mode. Valid values:
+   * - on: enabled
+   * - off: disabled
    * 
    * @example
    * on
@@ -27,11 +25,9 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Specifies whether to enable fallback. If enabled, requests fall back to the origin server if the function encounters an exception, such as exceeding the CPU usage limit. Valid values:
-   * 
-   * - on: Enabled
-   * 
-   * - off: Disabled
+   * The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request is forwarded to the origin server. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -39,11 +35,9 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   fallback?: string;
   /**
    * @remarks
-   * Specifies whether to enable the route. Valid values:
-   * 
-   * - on: Enabled
-   * 
-   * - off: Disabled
+   * The route switch. Valid values:
+   * - on: enabled
+   * - off: disabled
    * 
    * @example
    * on
@@ -59,7 +53,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The name of the Routine.
+   * The Edge Routine name.
    * 
    * @example
    * test-routine1
@@ -67,7 +61,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   routineName?: string;
   /**
    * @remarks
-   * The content of the rule.
+   * The rule content.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -75,7 +69,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The execution sequence of the rule.
+   * The rule execution order.
    * 
    * @example
    * 1
@@ -83,7 +77,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The ID of the site. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -92,6 +86,9 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
    */
   siteId?: number;
   /**
+   * @remarks
+   * The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.
+   * 
    * @example
    * 5
    */

package/src/models/UpdateSeoBypassRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSeoBypassRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable the feature. Valid values:
+   * The switch. Valid values:
    * 
-   * *   **on:**
-   * *   **off**
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * This parameter is required.
    * 
@@ -18,7 +18,7 @@ export class UpdateSeoBypassRequest extends $dara.Model {
   enable?: string;
   /**
    * @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.
    * 

package/src/models/UpdateSeoBypassResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSeoBypassResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/UpdateSiteCoverageRequest.ts

@@ -5,23 +5,22 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSiteCoverageRequest extends $dara.Model {
   /**
    * @remarks
-   * The target acceleration area to modify. Valid values:
+   * The target acceleration region to change to. Valid values:
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
-   * - **domestic**: Only the Chinese mainland.
-   * 
-   * - **global**: Global.
-   * 
-   * - **overseas**: Global (excluding the Chinese mainland).
+   * <props="china">If the value is set to domestic or global, the site corresponding to SiteId must have a valid ICP filing..
    * 
    * This parameter is required.
    * 
    * @example
-   * global
+   * overseas
    */
   coverage?: string;
   /**
    * @remarks
-   * The site ID. Get this by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to query the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateSiteNameExclusiveRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSiteNameExclusiveRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable site hold. Valid values:
+   * The feature switch. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on: enabled.
+   * - off: disabled.
    * 
    * This parameter is required.
    * 
@@ -18,7 +18,7 @@ export class UpdateSiteNameExclusiveRequest extends $dara.Model {
   enable?: string;
   /**
    * @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.
    * 

package/src/models/UpdateSitePauseRequest.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSitePauseRequest extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether to pause proxy acceleration for the site. If set to `true`, DNS queries for the site return the record values directly to the client. Valid values:
+   * Specifies whether to temporarily pause the proxy acceleration feature for the entire site. After the feature is paused, all DNS records directly return record values to the client. Valid values:
+   * - true: Pauses site acceleration.
+   * - false: Resumes normal site acceleration.
    * 
-   * - true: Pauses proxy acceleration for the site.
-   * 
-   * - false: Resumes proxy acceleration for the site.
+   * When site acceleration is paused, only activated sites with NS access mode are supported.
    * 
    * This parameter is required.
    * 
@@ -19,7 +19,7 @@ export class UpdateSitePauseRequest extends $dara.Model {
   paused?: boolean;
   /**
    * @remarks
-   * The site ID. To obtain this ID, call 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. Check the Status field to confirm the site status and the AccessType field to confirm the access mode of the site.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateSitePauseResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSitePauseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The unique ID for the request.
+   * The request ID.
    * 
    * @example
    * 6abd807e-ed2a-44de-ac54-ac38a62472e6

package/src/models/UpdateSiteVanityNsrequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSiteVanityNSRequest extends $dara.Model {
   /**
    * @remarks
-   * The website ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the ID.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to query the site ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateSiteVanityNSRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The custom nameserver names. You can specify two to five custom nameserver names. Separate multiple names with commas (,).
+   * The list of custom NS names. You can specify 2 to 5 custom NS names, separated by commas (,).
    * 
    * @example
    * ns1.example.com,ns2.example.com

package/src/models/UpdateTieredCacheRequest.ts

@@ -5,15 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateTieredCacheRequest extends $dara.Model {
   /**
    * @remarks
-   * The tiered cache architecture mode. Valid values:
-   * 
-   * - edge: The edge cache layer.
-   * 
-   * - edge_smart: The edge cache layer and the intelligent cache layer.
-   * 
-   * - edge_regional: The edge cache layer and the regional cache layer.
-   * 
-   * - edge_regional_smart: The edge cache layer, the regional cache layer, and the intelligent cache layer.
+   * The multi-level cache architecture mode. Valid values:
+   * - edge: edge cache layer.
+   * - edge_smart: edge cache layer + smart cache layer.
+   * - edge_regional: edge cache layer + regional cache layer.
+   * - edge_regional_smart: edge cache layer + regional cache layer + smart cache layer.
    * 
    * This parameter is required.
    * 
@@ -23,7 +19,7 @@ export class UpdateTieredCacheRequest extends $dara.Model {
   cacheArchitectureMode?: string;
   /**
    * @remarks
-   * The site ID. You can get this ID by calling [ListSites](https://help.aliyun.com/document_detail/2850189.html).
+   * The site ID. You can call [ListSites](https://help.aliyun.com/document_detail/2850189.html) to obtain the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateTransportLayerApplicationRequest.ts

@@ -5,15 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   /**
    * @remarks
-   * Specifies the protocol for client IP pass-through. Valid values:
-   * 
-   * - **off**: Disables client IP pass-through.
-   * 
-   * - **PPv1**: PROXY Protocol v1. Supports client IP pass-through for the TCP protocol.
-   * 
-   * - **PPv2**: PROXY Protocol v2. Supports client IP pass-through for both TCP and UDP protocols.
-   * 
-   * - **SPP**: Simple Proxy Protocol. Supports client IP pass-through for the UDP protocol.
+   * The client IP pass-through protocol. Valid values:
+   * - **off**: disabled.
+   * - **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP.
+   * - **PPv2**: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP.
+   * - **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP.
    * 
    * @example
    * SPP
@@ -21,7 +17,7 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * An optional comment for the forwarding rule.
+   * The comment for the rule.
    * 
    * @example
    * 123
@@ -29,15 +25,12 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The edge port. The following formats are supported:
-   * 
-   * - A single port, for example, `80`.
-   * 
-   * - A port range, for example, `81-85`. This range includes ports 81, 82, 83, 84, and 85.
-   * 
-   * - A combination of ports and port ranges separated by commas, for example, `80,81-85,90`. This includes ports 80, 81, 82, 83, 84, 85, and 90.
+   * The edge port. Valid values:
    * 
-   * - Edge ports cannot overlap within a single rule or across multiple rules.
+   * - 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.
+   * - Edge ports within a single rule and across multiple rules cannot overlap.
    * 
    * @example
    * 80
@@ -45,11 +38,10 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   edgePort?: string;
   /**
    * @remarks
-   * The forwarding protocol. Valid values:
+   * The forwarding rule protocol. Valid values:
    * 
-   * - TCP: Transmission Control Protocol.
-   * 
-   * - UDP: User Datagram Protocol.
+   * - TCP: TCP protocol.
+   * - UDP: UDP protocol.
    * 
    * @example
    * TCP
@@ -57,7 +49,7 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The source, which must correspond to the specified `SourceType`. For example, if `SourceType` is `ip`, this parameter must be an IP address.
+   * The specific value of the origin.
    * 
    * @example
    * 1.1.1.1
@@ -65,11 +57,10 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The source port. The following formats are supported:
-   * 
-   * - A single port. When a single source port is used, any valid format can be used for the edge port.
+   * Origin Server Port. Valid values:
    * 
-   * - A port range. You can specify a port range for the source port only if the edge port is also a port range, and their sizes must match. For example, if `EdgePort` is `90-93`, you cannot set `SourcePort` to `81-85` because their sizes (4 and 5 ports, respectively) do not match.
+   * - 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 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 is 5 while the edge port range is 4, which are inconsistent.
    * 
    * @example
    * 80
@@ -77,15 +68,11 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
   sourcePort?: string;
   /**
    * @remarks
-   * The type of the source. Valid values:
-   * 
-   * - **ip**: An IP address.
-   * 
-   * - **domain**: A domain name.
-   * 
-   * - **OP**: An origin pool.
-   * 
-   * - **LB**: A load balancer.
+   * The origin type. Valid values:
+   * - **ip**: IP address.
+   * - **domain**: domain name.
+   * - **OP**: origin IPAM pool.
+   * - **LB**: load balancing.
    * 
    * @example
    * ip
@@ -127,7 +114,7 @@ export class UpdateTransportLayerApplicationRequestRules extends $dara.Model {
 export class UpdateTransportLayerApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * The transport layer application ID. You can obtain this ID by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) operation.
+   * The Layer 4 application ID. You can call the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) operation to obtain the application ID.
    * 
    * This parameter is required.
    * 
@@ -137,11 +124,10 @@ export class UpdateTransportLayerApplicationRequest extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * Specifies whether to enable cross-border optimization for network access from the Chinese mainland. This feature is disabled by default. Valid values:
-   * 
-   * - on: Enables the feature.
+   * Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:
    * 
-   * - off: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -149,11 +135,10 @@ export class UpdateTransportLayerApplicationRequest extends $dara.Model {
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * Specifies whether to enable IP access rules. If enabled, the IP access rules in WAF apply to the transport layer application. Valid values:
+   * The IP access rule switch. When enabled, WAF IP access rules take effect for the Layer 4 application. Valid values:
    * 
-   * - on: Enables the feature.
-   * 
-   * - off: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -161,21 +146,34 @@ export class UpdateTransportLayerApplicationRequest extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * Specifies whether to enable IPv6. Valid values: `on` and `off`.
+   * The IPv6 switch. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
    */
   ipv6?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:
+   * 
+   * - on: enabled.
+   * - off: disabled.
+   * 
+   * @example
+   * off
+   */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * A list of forwarding rules. For each rule, all parameters are required except for `Comment`.
+   * The list of forwarding rules. For each rule, all parameters except the comment are required.
    */
   rules?: UpdateTransportLayerApplicationRequestRules[];
   /**
    * @remarks
-   * The site ID. You can obtain this ID 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.
    * 
@@ -183,6 +181,16 @@ export class UpdateTransportLayerApplicationRequest 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/UpdateTransportLayerApplicationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateTransportLayerApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * 9e5448c7-edaf-49aa-9887-0fcd0832306c