@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/CreateWaitingRoomEventRequest.ts

@@ -5,23 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWaitingRoomEventRequest 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 custom. The content must use Base64 encoding.
    * 
    * @example
-   * Hello%20world!
+   * SGVsbG8gd29ybGQ=
    */
   customPageHtml?: string;
   /**
    * @remarks
    * The description of the waiting room.
+   * 
+   * @example
+   * 测试等候室
    */
   description?: string;
   /**
    * @remarks
    * Specifies whether to disable session renewal. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -29,10 +32,10 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   disableSessionRenewalEnable?: string;
   /**
    * @remarks
-   * Specifies whether to enable the waiting room. Valid values:
+   * The waiting room switch. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * This parameter is required.
    * 
@@ -42,7 +45,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The end time of the event. This value is a UNIX timestamp.
+   * The event end timestamp, such as 1705044735.
    * 
    * This parameter is required.
    * 
@@ -52,10 +55,10 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
+   * Specifies whether to enable JSON response. When enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -63,11 +66,11 @@ export class CreateWaitingRoomEventRequest 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 default. Valid values:
    * 
-   * *   enus: English.
-   * *   zhcn: Simplified Chinese.
-   * *   zhhk: Traditional Chinese.
+   * - **enus**: English.
+   * - **zhcn**: Simplified Chinese.
+   * - **zhhk**: Traditional Chinese.
    * 
    * @example
    * zhcn
@@ -85,7 +88,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The maximum number of new users per minute.
+   * The number of new users per minute.
    * 
    * This parameter is required.
    * 
@@ -95,10 +98,10 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   newUsersPerMinute?: string;
   /**
    * @remarks
-   * Specifies whether to enable pre-queuing.
+   * Specifies whether to enable pre-queuing. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -106,7 +109,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   preQueueEnable?: string;
   /**
    * @remarks
-   * The start time for pre-queuing.
+   * The pre-queuing start timestamp, which must be at least 5 minutes earlier than the event start timestamp, such as 1705044735.
    * 
    * @example
    * 1719763200
@@ -116,10 +119,10 @@ export class CreateWaitingRoomEventRequest 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.
    * 
    * This parameter is required.
    * 
@@ -129,11 +132,11 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   queuingMethod?: string;
   /**
    * @remarks
-   * The HTTP status code to return while a user is in the queue. Valid values:
+   * The waiting room status code. Valid values:
    * 
-   * *   200
-   * *   202
-   * *   429
+   * - **200**
+   * - **202**
+   * - **429**.
    * 
    * This parameter is required.
    * 
@@ -143,10 +146,10 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   queuingStatusCode?: string;
   /**
    * @remarks
-   * Specifies whether to enable random queuing.
+   * Specifies whether to enable random pre-queuing. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: Enabled.
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -154,7 +157,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   randomPreQueueEnable?: string;
   /**
    * @remarks
-   * The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.
+   * The session duration, in minutes.
    * 
    * This parameter is required.
    * 
@@ -164,7 +167,7 @@ export class CreateWaitingRoomEventRequest 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. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -174,7 +177,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The start time of the event. This value is a UNIX timestamp.
+   * The event start timestamp, such as 1705044735.
    * 
    * This parameter is required.
    * 
@@ -184,7 +187,7 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The maximum number of active users.
+   * The total number of active users.
    * 
    * This parameter is required.
    * 
@@ -194,7 +197,7 @@ export class CreateWaitingRoomEventRequest 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. You can call the [ListWaitingRooms](https://help.aliyun.com/document_detail/2850279.html) operation to obtain the waiting room ID. The waiting room must belong to the site specified by SiteId.
    * 
    * @example
    * 6a51d5bc6460887abd1291dc7d4db28b
@@ -202,10 +205,10 @@ export class CreateWaitingRoomEventRequest extends $dara.Model {
   waitingRoomId?: string;
   /**
    * @remarks
-   * The type of the waiting room. Valid values:
+   * The waiting room type. Valid values:
    * 
-   * *   default
-   * *   custom
+   * - **default**: default type.
+   * - **custom**: custom type.
    * 
    * This parameter is required.
    * 

package/src/models/CreateWaitingRoomEventResponseBody.ts

@@ -11,6 +11,13 @@ export class CreateWaitingRoomEventResponseBody extends $dara.Model {
    * 15C66C7B-671A-4297-9187-2C4477247A123425345
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The waiting room event ID. You can call the [ListWaitingRoomEvents](https://help.aliyun.com/document_detail/2850279.html) operation to obtain the ID.
+   * 
+   * @example
+   * 433277746085888
+   */
   waitingRoomEventId?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateWaitingRoomRequest.ts

@@ -61,7 +61,7 @@ export class CreateWaitingRoomRequestHostNameAndPath extends $dara.Model {
 export class CreateWaitingRoomRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the custom cookie.
+   * The custom cookie name.
    * 
    * This parameter is required.
    * 
@@ -71,23 +71,26 @@ export class CreateWaitingRoomRequest 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 custom. The content must be Base64-encoded.
    * 
    * @example
-   * Hello%20world!
+   * SGVsbG8gd29ybGQ=
    */
   customPageHtml?: string;
   /**
    * @remarks
    * The description of the waiting room.
+   * 
+   * @example
+   * 测试
    */
   description?: string;
   /**
    * @remarks
-   * Specifies whether to disable session renewal. Valid values:
+   * Disable session renewal. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -95,10 +98,10 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   disableSessionRenewalEnable?: string;
   /**
    * @remarks
-   * Specifies whether to enable the waiting room. Valid values:
+   * The waiting room switch. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * This parameter is required.
    * 
@@ -108,17 +111,17 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The hostname and path.
+   * The hostnames and paths.
    * 
    * This parameter is required.
    */
   hostNameAndPath?: CreateWaitingRoomRequestHostNameAndPath[];
   /**
    * @remarks
-   * Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
+   * JSON response. After this feature is enabled, a JSON response is returned if the Accept request header contains "application/json". Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -126,11 +129,10 @@ export class CreateWaitingRoomRequest 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:
-   * 
-   * *   enus: English.
-   * *   zhcn: Simplified Chinese.
-   * *   zhhk: Traditional Chinese.
+   * The language of the waiting room page. This parameter is required when the waiting room type is default. Valid values:
+   * - **enus**: English.
+   * - **zhcn**: Simplified Chinese.
+   * - **zhhk**: Traditional Chinese.
    * 
    * @example
    * enus
@@ -148,7 +150,7 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The maximum number of new users per minute.
+   * The number of new users per minute.
    * 
    * This parameter is required.
    * 
@@ -158,10 +160,10 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   newUsersPerMinute?: string;
   /**
    * @remarks
-   * Specifies whether to queue all requests. Valid values:
+   * Queue all. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -171,10 +173,10 @@ export class CreateWaitingRoomRequest 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.
    * 
    * This parameter is required.
    * 
@@ -184,11 +186,11 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   queuingMethod?: string;
   /**
    * @remarks
-   * The HTTP status code to return while a user is in the queue. Valid values:
+   * The waiting room status code. Valid values:
    * 
-   * *   200
-   * *   202
-   * *   429
+   * - **200**
+   * - **202**
+   * - **429**
    * 
    * This parameter is required.
    * 
@@ -198,7 +200,7 @@ export class CreateWaitingRoomRequest 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.
    * 
    * This parameter is required.
    * 
@@ -208,7 +210,7 @@ export class CreateWaitingRoomRequest 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. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -218,7 +220,7 @@ export class CreateWaitingRoomRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The maximum number of active users.
+   * The total number of active users.
    * 
    * This parameter is required.
    * 
@@ -230,8 +232,8 @@ export class CreateWaitingRoomRequest extends $dara.Model {
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * *   default
-   * *   custom
+   * - **default**: default type.
+   * - **custom**: custom type.
    * 
    * This parameter is required.
    * 

package/src/models/CreateWaitingRoomResponseBody.ts

@@ -11,6 +11,13 @@ export class CreateWaitingRoomResponseBody extends $dara.Model {
    * 85H66C7B-671A-4297-9187-2C4477247A74
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The waiting room ID.
+   * 
+   * @example
+   * 8527e8405ac25bfb7fb7ca0d12b0ed83
+   */
   waitingRoomId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateWaitingRoomRuleRequest.ts

@@ -5,9 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWaitingRoomRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter is not required when adding a 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, which uses a conditional expression 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, see <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 +19,9 @@ export class CreateWaitingRoomRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a 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 +31,7 @@ export class CreateWaitingRoomRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    * 
    * This parameter is required.
    * 
@@ -39,7 +41,7 @@ export class CreateWaitingRoomRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/CreateWaitingRoomRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWaitingRoomRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
@@ -13,7 +13,7 @@ export class CreateWaitingRoomRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Waiting room bypass rule ID.
+   * The waiting room bypass rule ID.
    * 
    * @example
    * 420072638347264

package/src/models/CreateWaitingRoomShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the custom cookie.
+   * The custom cookie name.
    * 
    * This parameter is required.
    * 
@@ -15,23 +15,26 @@ export class CreateWaitingRoomShrinkRequest 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 custom. The content must be Base64-encoded.
    * 
    * @example
-   * Hello%20world!
+   * SGVsbG8gd29ybGQ=
    */
   customPageHtml?: string;
   /**
    * @remarks
    * The description of the waiting room.
+   * 
+   * @example
+   * 测试
    */
   description?: string;
   /**
    * @remarks
-   * Specifies whether to disable session renewal. Valid values:
+   * Disable session renewal. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -39,10 +42,10 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   disableSessionRenewalEnable?: string;
   /**
    * @remarks
-   * Specifies whether to enable the waiting room. Valid values:
+   * The waiting room switch. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * This parameter is required.
    * 
@@ -52,17 +55,17 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The hostname and path.
+   * The hostnames and paths.
    * 
    * This parameter is required.
    */
   hostNameAndPathShrink?: string;
   /**
    * @remarks
-   * Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:
+   * JSON response. After this feature is enabled, a JSON response is returned if the Accept request header contains "application/json". Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -70,11 +73,10 @@ export class CreateWaitingRoomShrinkRequest 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:
-   * 
-   * *   enus: English.
-   * *   zhcn: Simplified Chinese.
-   * *   zhhk: Traditional Chinese.
+   * The language of the waiting room page. This parameter is required when the waiting room type is default. Valid values:
+   * - **enus**: English.
+   * - **zhcn**: Simplified Chinese.
+   * - **zhhk**: Traditional Chinese.
    * 
    * @example
    * enus
@@ -92,7 +94,7 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The maximum number of new users per minute.
+   * The number of new users per minute.
    * 
    * This parameter is required.
    * 
@@ -102,10 +104,10 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   newUsersPerMinute?: string;
   /**
    * @remarks
-   * Specifies whether to queue all requests. Valid values:
+   * Queue all. Valid values:
    * 
-   * *   on
-   * *   off
+   * - **on**: enabled.
+   * - **off**: disabled.
    * 
    * @example
    * on
@@ -115,10 +117,10 @@ export class CreateWaitingRoomShrinkRequest 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.
    * 
    * This parameter is required.
    * 
@@ -128,11 +130,11 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   queuingMethod?: string;
   /**
    * @remarks
-   * The HTTP status code to return while a user is in the queue. Valid values:
+   * The waiting room status code. Valid values:
    * 
-   * *   200
-   * *   202
-   * *   429
+   * - **200**
+   * - **202**
+   * - **429**
    * 
    * This parameter is required.
    * 
@@ -142,7 +144,7 @@ export class CreateWaitingRoomShrinkRequest 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.
    * 
    * This parameter is required.
    * 
@@ -152,7 +154,7 @@ export class CreateWaitingRoomShrinkRequest 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. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -162,7 +164,7 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The maximum number of active users.
+   * The total number of active users.
    * 
    * This parameter is required.
    * 
@@ -174,8 +176,8 @@ export class CreateWaitingRoomShrinkRequest extends $dara.Model {
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * *   default
-   * *   custom
+   * - **default**: default type.
+   * - **custom**: custom type.
    * 
    * This parameter is required.
    *