@alicloud/esa20240910 3.2.0 → 3.4.0

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

package/src/models/UpdateTransportLayerApplicationShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateTransportLayerApplicationShrinkRequest 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.
    * 
@@ -15,11 +15,10 @@ export class UpdateTransportLayerApplicationShrinkRequest 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:
+   * Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:
    * 
-   * - on: Enables the feature.
-   * 
-   * - off: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -27,11 +26,10 @@ export class UpdateTransportLayerApplicationShrinkRequest 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:
-   * 
-   * - on: Enables the feature.
+   * The IP access rule switch. When enabled, WAF IP access rules take effect for the Layer 4 application. Valid values:
    * 
-   * - off: Disables the feature.
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -39,21 +37,34 @@ export class UpdateTransportLayerApplicationShrinkRequest 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.
    */
   rulesShrink?: string;
   /**
    * @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.
    * 
@@ -61,6 +72,16 @@ export class UpdateTransportLayerApplicationShrinkRequest 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/UpdateVideoProcessingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateVideoProcessingRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.
+   * The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The custom end parameter for FLV files.
+   * The custom FLV end parameter.
    * 
    * @example
    * end
@@ -23,7 +23,7 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   flvSeekEnd?: string;
   /**
    * @remarks
-   * The custom start parameter for FLV files.
+   * The custom FLV start parameter.
    * 
    * @example
    * start
@@ -31,10 +31,9 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   flvSeekStart?: string;
   /**
    * @remarks
-   * FLV Seeking Valid values:
-   * 
-   * *   by_byte: Seek by byte.
-   * *   by_time: Seek by time.
+   * The FLV seeking mode. Valid values:
+   * - by_byte: seek by byte.
+   * - by_time: seek by time.
    * 
    * @example
    * by_byte
@@ -42,7 +41,7 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   flvVideoSeekMode?: string;
   /**
    * @remarks
-   * Customize the mp4 end parameter.
+   * The custom MP4 end parameter.
    * 
    * @example
    * end
@@ -50,7 +49,7 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   mp4SeekEnd?: string;
   /**
    * @remarks
-   * Customize the mp4 start parameter.
+   * The custom MP4 start parameter.
    * 
    * @example
    * start
@@ -58,10 +57,9 @@ export class UpdateVideoProcessingRequest 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. Two scenarios:
-   * 
-   * *   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 a conditional expression to match user requests. You do not need to set this parameter when adding 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, such as (http.host eq \\"video.example.com\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -69,10 +67,9 @@ export class UpdateVideoProcessingRequest 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. 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
@@ -80,7 +77,7 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. 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
@@ -88,7 +85,7 @@ export class UpdateVideoProcessingRequest 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
@@ -96,7 +93,7 @@ export class UpdateVideoProcessingRequest 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.
    * 
@@ -106,10 +103,9 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Video seeking. Valid values:
-   * 
-   * *   on
-   * *   off
+   * Specifies whether to enable the video seeking feature. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on

package/src/models/UpdateWaitingRoomEventRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWaitingRoomEventRequest extends $dara.Model {
   /**
    * @remarks
-   * The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.
+   * The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must use Base64 encoding.
    * 
    * @example
    * SGVsbG8gd29ybGQ=
@@ -23,9 +23,8 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
    * @remarks
    * Specifies whether to disable session renewal. Valid values:
    * 
-   * - on
-   * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * off
@@ -33,11 +32,11 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   disableSessionRenewalEnable?: string;
   /**
    * @remarks
-   * Specifies whether to enable the waiting room event. Valid values:
+   * The enabling status. Valid values:
    * 
-   * - `on`
+   *  - **on**: Enables the waiting room event.
    * 
-   * - `off`
+   *  - **off**: Disables the waiting room event.
    * 
    * @example
    * on
@@ -45,7 +44,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The end time of the event. This value is a UNIX timestamp.
+   * The timestamp of the event end time.
    * 
    * @example
    * 1719849600
@@ -55,9 +54,8 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable JSON response. Valid values:
    * 
-   * - on
-   * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * off
@@ -65,13 +63,11 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   jsonResponseEnable?: string;
   /**
    * @remarks
-   * The default language. Valid values:
-   * 
-   * - `enus`: English.
+   * The default language setting. Valid values:
    * 
-   * - `zhcn`: Simplified Chinese.
-   * 
-   * - `zhhk`: Traditional Chinese.
+   *  - **enus**: English.
+   * - **zhcn**: Simplified Chinese.
+   * - **zhhk**: Traditional Chinese.
    * 
    * @example
    * enus
@@ -82,12 +78,12 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
    * The name of the waiting room event.
    * 
    * @example
-   * Test event 2
+   * 测试事件2
    */
   name?: string;
   /**
    * @remarks
-   * The maximum number of new users per minute.
+   * The number of new users per minute.
    * 
    * @example
    * 300
@@ -95,11 +91,10 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   newUsersPerMinute?: string;
   /**
    * @remarks
-   * Specifies whether to enable pre-queuing.
-   * 
-   * - on
+   * Specifies whether to enable pre-queuing. Valid values:
    * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -107,7 +102,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   preQueueEnable?: string;
   /**
    * @remarks
-   * The start time for pre-queuing.
+   * The timestamp of the pre-queuing start time.
    * 
    * @example
    * 1719763200
@@ -117,13 +112,10 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
    * @remarks
    * The queuing method. Valid values:
    * 
-   * - random: Users gain access to the origin randomly, regardless of the arrival time.
-   * 
-   * - fifo: Users gain access to the origin in order of arrival.
-   * 
-   * - passthrough: Users pass through the waiting room and go straight to the origin.
-   * 
-   * - reject-all: All requests are blocked from accessing the origin.
+   * - **random**: random.
+   * - **fifo**: first-in, first-out.
+   * - **passthrough**: passthrough.
+   * - **reject-all**: reject all.
    * 
    * @example
    * fifo
@@ -131,13 +123,11 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   queuingMethod?: string;
   /**
    * @remarks
-   * The HTTP status code to return while a user is in the queue. Valid values:
-   * 
-   * - 200
+   * The waiting room status code. Valid values:
    * 
-   * - 202
-   * 
-   * - 429
+   * - **200**
+   * - **202**
+   * - **429**
    * 
    * @example
    * 200
@@ -145,11 +135,10 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   queuingStatusCode?: string;
   /**
    * @remarks
-   * Specifies whether to enable random queuing.
-   * 
-   * - on
+   * Specifies whether to enable random pre-queuing. Valid values:
    * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -157,7 +146,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   randomPreQueueEnable?: string;
   /**
    * @remarks
-   * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
+   * The user session duration, in minutes.
    * 
    * @example
    * 5
@@ -165,7 +154,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   sessionDuration?: 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, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -175,7 +164,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The start time of the event. This value is a UNIX timestamp.
+   * The timestamp of the event start time.
    * 
    * @example
    * 1719763200
@@ -183,7 +172,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The maximum number of active users.
+   * The total number of active users.
    * 
    * @example
    * 200
@@ -191,7 +180,7 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
   totalActiveUsers?: string;
   /**
    * @remarks
-   * The ID of the waiting room event, which can be obtained by calling the [ListWaitingRoomEvents](https://help.aliyun.com/document_detail/2850279.html) operation.
+   * The waiting room event ID, which can be obtained by calling the [ListWaitingRoomEvents](https://help.aliyun.com/document_detail/2850279.html) operation.
    * 
    * This parameter is required.
    * 
@@ -203,9 +192,8 @@ export class UpdateWaitingRoomEventRequest extends $dara.Model {
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * - default
-   * 
-   * - custom
+   * - **default**: default type.
+   * - **custom**: custom type.
    * 
    * @example
    * custom