@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListWafTemplateRulesShrinkRequest.ts

@@ -3,10 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListWafTemplateRulesShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * @example
+   * esa-site-aud6ftk57ym8
+   */
   instanceId?: string;
   /**
    * @remarks
-   * WAF operation phase, used to filter template rules for a specific phase.
+   * The WAF running phase for filtering template rules.
    * 
    * @example
    * http_anti_scan
@@ -14,7 +21,7 @@ export class ListWafTemplateRulesShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * Query parameters, used to filter template rules based on conditions such as rule type.
+   * The query parameters for filtering template rules by criteria such as the rule type.
    * 
    * @example
    * http_anti_scan
@@ -22,7 +29,7 @@ export class ListWafTemplateRulesShrinkRequest extends $dara.Model {
   queryArgsShrink?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
+   * The site ID. To obtain this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * @example
    * 1

package/src/models/ListWafUsageOfRulesRequest.ts

@@ -6,7 +6,7 @@ export class ListWafUsageOfRulesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Name of the WAF operation phase.
+   * The name of the WAF execution phase.
    * 
    * @example
    * http_custom
@@ -14,7 +14,7 @@ export class ListWafUsageOfRulesRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. To get this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * @example
    * 1

package/src/models/ListWafUsageOfRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafUsageOfRulesResponseBodySites extends $dara.Model {
   /**
    * @remarks
-   * Site ID.
+   * The site ID.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListWafUsageOfRulesResponseBodySites extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Site name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -21,7 +21,7 @@ export class ListWafUsageOfRulesResponseBodySites extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Usage of WAF rules/WAF rule sets.
+   * The number of WAF rules or rule sets used by the site.
    * 
    * @example
    * 1
@@ -57,7 +57,7 @@ export class ListWafUsageOfRulesResponseBody extends $dara.Model {
   instanceUsage?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
@@ -65,7 +65,7 @@ export class ListWafUsageOfRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * List of site usage.
+   * A list of sites and their respective WAF rule usage.
    */
   sites?: ListWafUsageOfRulesResponseBodySites[];
   static names(): { [key: string]: string } {

package/src/models/ListWaitingRoomEventsResponseBody.ts

@@ -23,8 +23,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * Indicates whether session renewal is disabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * off
@@ -34,8 +35,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * The event status. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -53,8 +55,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * Indicates whether JOSN response is enabled. 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
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * off
@@ -64,9 +67,11 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * The language of the waiting room page. This parameter is returned 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
@@ -75,6 +80,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
   /**
    * @remarks
    * The custom event name.
+   * 
+   * @example
+   * Test event
    */
   name?: string;
   /**
@@ -89,8 +97,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * Indicates whether pre-queuing is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -108,10 +117,13 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @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: 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.
    * 
    * @example
    * fifo
@@ -121,9 +133,11 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * The HTTP status code to return while a user is in the queue. Valid values:
    * 
-   * *   200
-   * *   202
-   * *   429
+   * - 200
+   * 
+   * - 202
+   * 
+   * - 429
    * 
    * @example
    * 200
@@ -133,8 +147,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * Indicates whether random queuing is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -184,8 +199,9 @@ export class ListWaitingRoomEventsResponseBodyWaitingRoomEvents extends $dara.Mo
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * *   default
-   * *   custom
+   * - default
+   * 
+   * - custom
    * 
    * @example
    * custom

package/src/models/ListWaitingRoomsResponseBody.ts

@@ -64,19 +64,26 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
   /**
    * @remarks
    * The HTML content or identifier of the custom queuing page. This parameter is valid only when `WaitingRoomType` is set to `custom`. The content must be URL-encoded.
+   * 
+   * @example
+   * Custom HTML content
    */
   customPageHtml?: string;
   /**
    * @remarks
    * The description of the waiting room.
+   * 
+   * @example
+   * Test waiting room
    */
   description?: string;
   /**
    * @remarks
    * Indicates whether session renewal is disabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -86,8 +93,9 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * Indicates whether the waiting room is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -102,8 +110,9 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * Indicates whether JSON response is enabled. 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:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -113,9 +122,11 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * The language of the waiting room page. This parameter is returned 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
@@ -124,6 +135,9 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
   /**
    * @remarks
    * The name of the waiting room.
+   * 
+   * @example
+   * Test waiting room
    */
   name?: string;
   /**
@@ -138,8 +152,9 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * Indicates whether all requests must be queued. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on
@@ -149,10 +164,13 @@ export class ListWaitingRoomsResponseBodyWaitingRooms 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: 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.
    * 
    * @example
    * random
@@ -162,9 +180,11 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * The HTTP status code to return while a user is in the queue. Valid values:
    * 
-   * *   200
-   * *   202
-   * *   429
+   * - 200
+   * 
+   * - 202
+   * 
+   * - 429
    * 
    * @example
    * 200
@@ -198,8 +218,9 @@ export class ListWaitingRoomsResponseBodyWaitingRooms extends $dara.Model {
    * @remarks
    * The type of the waiting room. Valid values:
    * 
-   * *   default
-   * *   custom
+   * - default
+   * 
+   * - custom
    * 
    * @example
    * default

package/src/models/PublishEdgeContainerAppVersionRequest.ts

@@ -33,8 +33,9 @@ export class PublishEdgeContainerAppVersionRequest extends $dara.Model {
    * @remarks
    * The environment to which you want to release the version. Valid values:
    * 
-   * *   prod: the production environment.
-   * *   staging: the staging environment.
+   * - prod: the production environment.
+   * 
+   * - staging: the staging environment.
    * 
    * This parameter is required.
    * 
@@ -46,8 +47,9 @@ export class PublishEdgeContainerAppVersionRequest extends $dara.Model {
    * @remarks
    * Specifies how the version is released. Valid values:
    * 
-   * *   percentage: releases the version by percentage.
-   * *   region: releases the version by region.
+   * - percentage: releases the version by percentage.
+   * 
+   * - region: releases the version by region.
    * 
    * If you do not specify this parameter, the version is released by percentage by default.
    * 

package/src/models/PublishEdgeContainerAppVersionShrinkRequest.ts

@@ -33,8 +33,9 @@ export class PublishEdgeContainerAppVersionShrinkRequest extends $dara.Model {
    * @remarks
    * The environment to which you want to release the version. Valid values:
    * 
-   * *   prod: the production environment.
-   * *   staging: the staging environment.
+   * - prod: the production environment.
+   * 
+   * - staging: the staging environment.
    * 
    * This parameter is required.
    * 
@@ -46,8 +47,9 @@ export class PublishEdgeContainerAppVersionShrinkRequest extends $dara.Model {
    * @remarks
    * Specifies how the version is released. Valid values:
    * 
-   * *   percentage: releases the version by percentage.
-   * *   region: releases the version by region.
+   * - percentage: releases the version by percentage.
+   * 
+   * - region: releases the version by region.
    * 
    * If you do not specify this parameter, the version is released by percentage by default.
    * 

package/src/models/PublishRoutineCodeVersionRequest.ts

@@ -3,32 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PublishRoutineCodeVersionRequest extends $dara.Model {
-  /**
-   * @remarks
-   * The code version to be released.
-   * 
-   * @example
-   * 1710120201067203242
-   */
   codeVersion?: string;
   /**
    * @remarks
-   * The environment name.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * production
    */
   env?: string;
   /**
    * @remarks
-   * The routine name.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * PublishRoutineCodeVersion
    */
   name?: string;
   static names(): { [key: string]: string } {

package/src/models/PublishRoutineCodeVersionResponseBody.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PublishRoutineCodeVersionResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The code version.
-   * 
-   * @example
-   * 1710120201067203242
-   */
   codeVersion?: string;
-  /**
-   * @remarks
-   * The request ID.
-   * 
-   * @example
-   * EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
-   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/PurchaseRatePlanRequest.ts

@@ -3,10 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PurchaseRatePlanRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The number of plans to purchase.
+   * 
+   * @example
+   * 1
+   */
   amount?: number;
   /**
    * @remarks
-   * Specifies whether to enable auto payment.
+   * Specifies whether to enable automatic payment.
+   * Set this parameter to true when you directly call this operation.
    * 
    * @example
    * true
@@ -14,21 +22,28 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   autoPay?: boolean;
   /**
    * @remarks
-   * Auto-renewal:
-   * - true: Enable auto-renewal.
-   * - false: Disable auto-renewal.
+   * Specifies whether to enable auto-renewal. Valid values:
+   * - true: Auto-renewal is enabled.
+   * - false: Auto-renewal is disabled.
    * 
    * @example
    * true
    */
   autoRenew?: boolean;
+  /**
+   * @remarks
+   * The channel field.
+   * 
+   * @example
+   * xxxWodkxxx
+   */
   channel?: string;
   /**
    * @remarks
    * The billing method. Valid values:
-   * 
-   * *   PREPAY: subscription.
-   * *   POSTPAY: pay-as-you-go.
+   * - PREPAY: subscription.
+   * - POSTPAY: pay-as-you-go.
+   * Set this parameter to PREPAY when you directly call this operation.
    * 
    * @example
    * PREPAY
@@ -36,11 +51,10 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * The service location. Valid values:
-   * 
-   * *   domestic: the Chinese mainland.
-   * *   global: global.
-   * *   overseas: outside the Chinese mainland.
+   * The acceleration region. Valid values:
+   * - domestic: the Chinese mainland only.
+   * - global: global.
+   * - overseas: global (excluding the Chinese mainland).
    * 
    * @example
    * domestic
@@ -48,7 +62,8 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Subscription period (in months).
+   * The purchase period, in months.
+   * This parameter is required when you directly call this operation.
    * 
    * @example
    * 1
@@ -56,15 +71,43 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   period?: number;
   /**
    * @remarks
-   * Package code.
+   * The plan code.
+   * 
+   * China site
+   * 
+   * - Free Edition: entranceplan
+   * - Basic: basicplan
+   * - Standard: standardplan
+   * - Premium: advancedplan
+   * 
+   * International site
+   * 
+   * - Entrance: entranceplan
+   * - Pro: standardplan
+   * - Premium: advancedpla.
    * 
    * @example
-   * entranceplan
+   * basicplan
    */
   planCode?: string;
   /**
    * @remarks
-   * Package name.
+   * The plan name.
+   * 
+   * China site
+   * 
+   * - Free Edition: entranceplan
+   * - Basic: basic
+   * - Standard: medium
+   * - Premium: high
+   * 
+   * International site
+   * 
+   * - Entrance: entranceplan_intl
+   * - Pro: basicplan_intl
+   * - Premium: vipplan_intl
+   * 
+   * > Note: For Enterprise Edition plans, the plan name is provided after backend configuration.
    * 
    * @example
    * basic
@@ -72,7 +115,7 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   planName?: string;
   /**
    * @remarks
-   * Site name.
+   * The site name.
    * 
    * @example
    * test.com
@@ -80,10 +123,9 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The DNS setup option for the website. Valid values:
-   * 
-   * *   NS
-   * *   CNAME
+   * The site access type. Valid values:
+   * - NS: NS access.
+   * - CNAME: CNAME access.
    * 
    * @example
    * CNAME

package/src/models/PurchaseRatePlanResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PurchaseRatePlanResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * esa-site-ads11w
@@ -13,7 +13,7 @@ export class PurchaseRatePlanResponseBody extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Order ID.
+   * The order ID.
    * 
    * @example
    * 123123
@@ -21,7 +21,7 @@ export class PurchaseRatePlanResponseBody extends $dara.Model {
   orderId?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 30423A7F-A83D-1E24-B80E-86DD25790758