@alicloud/esa20240910 3.3.0 → 3.4.0

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

package/src/models/UpdateWaitingRoomRequest.ts

@@ -13,7 +13,7 @@ export class UpdateWaitingRoomRequestHostNameAndPath extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The probe path.
+   * The path.
    * 
    * @example
    * /test
@@ -55,7 +55,7 @@ export class UpdateWaitingRoomRequestHostNameAndPath extends $dara.Model {
 export class UpdateWaitingRoomRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the custom cookie.
+   * The custom cookie name.
    * 
    * @example
    * __aliwaitingroom_example
@@ -63,7 +63,7 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   cookieName?: string;
   /**
    * @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 be in Base64 encoding.
    * 
    * @example
    * SGVsbG8gd29ybGQ=
@@ -74,16 +74,15 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
    * The description of the waiting room.
    * 
    * @example
-   * Special event waiting room page
+   * 特别活动排队页面
    */
   description?: string;
   /**
    * @remarks
    * Specifies whether to disable session renewal. Valid values:
    * 
-   * - on
-   * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -91,11 +90,10 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   disableSessionRenewalEnable?: string;
   /**
    * @remarks
-   * Specifies whether to enable the waiting room. Valid values:
-   * 
-   * - on
+   * The status of the waiting room. Valid values:
    * 
-   * - off
+   *  - **on**: Enabled.
+   *  - **off**: Disabled.
    * 
    * @example
    * on
@@ -103,16 +101,15 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The hostname and path.
+   * The hostname and path configurations.
    */
   hostNameAndPath?: UpdateWaitingRoomRequestHostNameAndPath[];
   /**
    * @remarks
-   * Specifies whether to enable JSON response. If JSON response is enabled, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
-   * 
-   * - on
+   * Specifies whether to enable JSON response. If enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:
    * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -120,13 +117,11 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   jsonResponseEnable?: string;
   /**
    * @remarks
-   * The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:
+   * The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:
    * 
-   * - enus: English.
-   * 
-   * - zhcn: Simplified Chinese.
-   * 
-   * - zhhk: Traditional Chinese.
+   * - **enus**: English.
+   * - **zhcn**: Simplified Chinese.
+   * - **zhhk**: Traditional Chinese.
    * 
    * @example
    * zhcn
@@ -137,12 +132,12 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
    * The name of the waiting room.
    * 
    * @example
-   * Holiday promotion waiting room
+   * 节假日促销等候室
    */
   name?: string;
   /**
    * @remarks
-   * The maximum number of new users per minute.
+   * The number of new users per minute.
    * 
    * @example
    * 200
@@ -150,11 +145,10 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   newUsersPerMinute?: string;
   /**
    * @remarks
-   * Specifies whether to queue all requests. Valid values:
-   * 
-   * - on
+   * Specifies whether to queue all visitors. Valid values:
    * 
-   * - off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -164,13 +158,10 @@ export class UpdateWaitingRoomRequest 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: Users are blocked from reaching the origin.
+   * - **random**: random.
+   * - **fifo**: first-in, first-out.
+   * - **passthrough**: passthrough.
+   * - **reject-all**: reject all.
    * 
    * @example
    * random
@@ -178,13 +169,11 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   queuingMethod?: string;
   /**
    * @remarks
-   * The HTTP status code to return while a user is in the queue. Valid values:
+   * The HTTP status code returned by the waiting room. Valid values:
    * 
-   * - 200
-   * 
-   * - 202
-   * 
-   * - 429
+   * - **200**
+   * - **202**
+   * - **429**
    * 
    * @example
    * 200
@@ -192,7 +181,7 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   queuingStatusCode?: string;
   /**
    * @remarks
-   * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
+   * The session duration in minutes.
    * 
    * @example
    * 5
@@ -200,7 +189,7 @@ export class UpdateWaitingRoomRequest 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.
    * 
@@ -210,7 +199,7 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The maximum number of active users.
+   * The total number of active users.
    * 
    * @example
    * 300
@@ -218,7 +207,7 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
   totalActiveUsers?: string;
   /**
    * @remarks
-   * The ID of the waiting room, which can be obtained by calling the [ListWaitingRooms](https://help.aliyun.com/document_detail/2850279.html) operation.
+   * The waiting room ID, which can be obtained by calling the [ListWaitingRooms](https://help.aliyun.com/document_detail/2850279.html) operation.
    * 
    * This parameter is required.
    * 
@@ -230,9 +219,8 @@ export class UpdateWaitingRoomRequest extends $dara.Model {
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * - default
-   * 
-   * - custom
+   * - **default**: default type.
+   * - **custom**: custom type.
    * 
    * @example
    * default

package/src/models/UpdateWaitingRoomRuleRequest.ts

@@ -5,9 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWaitingRoomRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter is not required when adding global configuration. There are two usage scenarios:
-   * - Match all incoming requests: Set the value to true
-   * - 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\\").
+   * 
+   * For the complete syntax of rule expressions, refer to
+   * <props="china">https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/work-with-rules-engine/
+   * <props="intl">https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/
    * 
    * This parameter is required.
    * 
@@ -17,9 +21,9 @@ export class UpdateWaitingRoomRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * This parameter is required.
    * 
@@ -29,7 +33,7 @@ export class UpdateWaitingRoomRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding global configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    * 
    * This parameter is required.
    * 
@@ -39,7 +43,7 @@ export class UpdateWaitingRoomRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained 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 obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -49,7 +53,7 @@ export class UpdateWaitingRoomRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The ID of the waiting room bypass rule to be updated, which can be obtained by calling the [ListWaitingRoomRules](https://help.aliyun.com/document_detail/2850279.html) interface.
+   * The ID of the waiting room bypass rule to update. You can obtain this ID after creating a rule by calling CreateWaitingRoomRule, or by calling the [ListWaitingRoomRules](https://help.aliyun.com/document_detail/2850279.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateWaitingRoomRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWaitingRoomRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID, used for tracking the progress of request processing.
+   * The request ID.
    * 
    * @example
    * 9bfe9d95-7bf6-469d-a628-ed7bc9f25073