@alicloud/esa20240910 3.4.0 → 3.5.0

package/src/models/ListWafRulesetsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafRulesetsRequestQueryArgs extends $dara.Model {
   /**
    * @remarks
-   * A keyword for a fuzzy search on the ID or name of a ruleset or rule.
+   * The fuzzy match string for the ruleset ID, ruleset name, rule ID, or rule name.
    * 
    * @example
    * example
@@ -13,12 +13,12 @@ export class ListWafRulesetsRequestQueryArgs extends $dara.Model {
   anyLike?: string;
   /**
    * @remarks
-   * Specifies whether to sort in descending order.
+   * Specifies whether to sort the results in descending order.
    */
   desc?: boolean;
   /**
    * @remarks
-   * A keyword for a fuzzy search on ruleset names.
+   * The fuzzy match string for the ruleset name.
    * 
    * @example
    * example
@@ -26,7 +26,7 @@ export class ListWafRulesetsRequestQueryArgs extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * Specifies the field for sorting the results.
+   * The column by which to sort the results.
    * 
    * @example
    * id
@@ -62,7 +62,7 @@ export class ListWafRulesetsRequestQueryArgs extends $dara.Model {
 export class ListWafRulesetsRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number for pagination.
+   * The page number. Specifies the current page number for paging queries.
    * 
    * @example
    * 1
@@ -70,7 +70,7 @@ export class ListWafRulesetsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The page size. Specifies the number of records per page for paging queries.
    * 
    * @example
    * 20
@@ -78,23 +78,15 @@ export class ListWafRulesetsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The execution phase for WAF rules.
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
-   * 
-   * - `http_ratelimit`: rate-limiting rule
-   * 
-   * - `ip_access_rule`: IP access rule
-   * 
-   * - `http_bot`: bot rule
-   * 
-   * - `http_security_level_rule`: security rule
+   * The WAF rule execution phase. Valid values:
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: frequency control rules
+   * - ip_access_rule: IP access rules
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rules
    * 
    * @example
    * http_bot
@@ -102,7 +94,7 @@ export class ListWafRulesetsRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A JSON object containing query parameters for filtering.
+   * The query parameters, passed in JSON format, including various filter conditions.
    * 
    * @example
    * http_bot
@@ -110,7 +102,7 @@ export class ListWafRulesetsRequest extends $dara.Model {
   queryArgs?: ListWafRulesetsRequestQueryArgs;
   /**
    * @remarks
-   * The ID of the site. 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.
    * 
    * @example
    * 1
@@ -118,7 +110,7 @@ export class ListWafRulesetsRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The site\\"s configuration version. For sites with configuration version management enabled, use this parameter to specify the version. The default is 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0

package/src/models/ListWafRulesetsResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafRulesetsResponseBodyRulesets extends $dara.Model {
   /**
    * @remarks
-   * A list of match fields.
+   * The list of match objects.
    */
   fields?: string[];
   /**
    * @remarks
-   * The ID of the WAF ruleset. This value is returned by the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    * 
    * @example
    * 10000001
@@ -26,23 +26,15 @@ export class ListWafRulesetsResponseBodyRulesets extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The execution phase of the ruleset. Valid values are:
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
-   * 
-   * - `http_ratelimit`: rate limiting rule
-   * 
-   * - `ip_access_rule`: IP access rule
-   * 
-   * - `http_bot`: advanced bot protection
-   * 
-   * - `http_security_level_rule`: security rule
+   * The WAF rule execution phase. Valid values:
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: frequency control rules
+   * - ip_access_rule: IP access rules
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rules
    * 
    * @example
    * http_bot
@@ -58,7 +50,7 @@ export class ListWafRulesetsResponseBodyRulesets extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The protection target for the \\"http_bot\\" phase.
+   * The protection target type in http_bot.
    * 
    * @example
    * web
@@ -66,12 +58,16 @@ export class ListWafRulesetsResponseBodyRulesets extends $dara.Model {
   target?: string;
   /**
    * @remarks
-   * A list of rule types.
+   * The list of rule types.
    */
   types?: string[];
   /**
    * @remarks
-   * The time the ruleset was last modified.
+   * The last modification time of the ruleset.
+   * 
+   * Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).
+   * 
+   * Example: 2026-06-10T14:23:45Z
    * 
    * @example
    * 2024-01-01T00:00:00Z
@@ -121,7 +117,7 @@ export class ListWafRulesetsResponseBodyRulesets extends $dara.Model {
 export class ListWafRulesetsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of WAF rulesets used by the instance in this WAF phase.
+   * The number of WAF rulesets used by the instance in this WAF execution phase.
    * 
    * @example
    * 10
@@ -153,12 +149,12 @@ export class ListWafRulesetsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * A list of rulesets.
+   * The list of rulesets, including detailed information about each ruleset.
    */
   rulesets?: ListWafRulesetsResponseBodyRulesets[];
   /**
    * @remarks
-   * The number of WAF rulesets used by the site in this WAF phase.
+   * The number of WAF rulesets used by the site in this WAF execution phase.
    * 
    * @example
    * 5
@@ -166,7 +162,7 @@ export class ListWafRulesetsResponseBody extends $dara.Model {
   siteUsage?: number;
   /**
    * @remarks
-   * The total number of entries returned after filtering.
+   * The total number of records after filtering.
    * 
    * @example
    * 5

package/src/models/ListWafRulesetsShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWafRulesetsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number for pagination.
+   * The page number. Specifies the current page number for paging queries.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListWafRulesetsShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The page size. Specifies the number of records per page for paging queries.
    * 
    * @example
    * 20
@@ -21,23 +21,15 @@ export class ListWafRulesetsShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The execution phase for WAF rules.
-   * 
-   * - `http_whitelist`: whitelist rule
-   * 
-   * - `http_custom`: custom rule
-   * 
-   * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: scan protection rule
-   * 
-   * - `http_ratelimit`: rate-limiting rule
-   * 
-   * - `ip_access_rule`: IP access rule
-   * 
-   * - `http_bot`: bot rule
-   * 
-   * - `http_security_level_rule`: security rule
+   * The WAF rule execution phase. Valid values:
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: frequency control rules
+   * - ip_access_rule: IP access rules
+   * - http_bot: advanced mode bots
+   * - http_security_level_rule: security rules
    * 
    * @example
    * http_bot
@@ -45,7 +37,7 @@ export class ListWafRulesetsShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A JSON object containing query parameters for filtering.
+   * The query parameters, passed in JSON format, including various filter conditions.
    * 
    * @example
    * http_bot
@@ -53,7 +45,7 @@ export class ListWafRulesetsShrinkRequest extends $dara.Model {
   queryArgsShrink?: string;
   /**
    * @remarks
-   * The ID of the site. 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.
    * 
    * @example
    * 1
@@ -61,7 +53,7 @@ export class ListWafRulesetsShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The site\\"s configuration version. For sites with configuration version management enabled, use this parameter to specify the version. The default is 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0

package/src/models/PurchaseBotInstanceRequest.ts

@@ -0,0 +1,48 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class PurchaseBotInstanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The bot instance specifications.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * enterprise_bot
+   */
+  botInstanceLevel?: string;
+  /**
+   * @remarks
+   * The site instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * esa-site-23kde*****
+   */
+  siteInstanceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      botInstanceLevel: 'BotInstanceLevel',
+      siteInstanceId: 'SiteInstanceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      botInstanceLevel: 'string',
+      siteInstanceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PurchaseBotInstanceResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PurchaseBotInstanceResponseBody } from "./PurchaseBotInstanceResponseBody";
+
+
+export class PurchaseBotInstanceResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: PurchaseBotInstanceResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: PurchaseBotInstanceResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PurchaseBotInstanceResponseBody.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class PurchaseBotInstanceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * @example
+   * esa-bot-9v9x3o2***
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The order ID.
+   * 
+   * @example
+   * 31223****11
+   */
+  orderId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 04F0F334-1335-436C-A1D7-6C044FE73368
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceId: 'InstanceId',
+      orderId: 'OrderId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceId: 'string',
+      orderId: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PurchaseCacheReserveRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class PurchaseCacheReserveRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether to automatically pay. The default value is false.
-   * - true: Automatically pay.
-   * - false: Do not automatically pay.
+   * Specifies whether to enable automatic payment. Default value: false. Valid values:
+   * - true: Enables automatic payment.
+   * - false: Disables automatic payment.
    * 
    * @example
    * true
@@ -15,9 +15,9 @@ export class PurchaseCacheReserveRequest extends $dara.Model {
   autoPay?: boolean;
   /**
    * @remarks
-   * Whether to auto-renew:
-   * - true: Auto-renew.
-   * - false: Do not auto-renew.
+   * Specifies whether to enable auto-renewal. Valid values:
+   * - true: Enables auto-renewal.
+   * - false: Disables auto-renewal.
    * 
    * @example
    * true
@@ -25,9 +25,8 @@ export class PurchaseCacheReserveRequest extends $dara.Model {
   autoRenew?: boolean;
   /**
    * @remarks
-   * Billing type
-   * - PREPAY: Prepaid.
-   * - POSTPAY: Postpaid.
+   * The billing type. Valid values:
+   * - PREPAY: upfront.
    * 
    * @example
    * PREPAY
@@ -35,9 +34,9 @@ export class PurchaseCacheReserveRequest extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * Cache retention region
-   * - HK: Hong Kong, China
-   * - CN-beijing: Mainland China - Beijing
+   * The cache reserve region.
+   * - HK: Hong Kong (China)
+   * - CN-beijing: Chinese mainland - Beijing
    * 
    * @example
    * HK
@@ -45,7 +44,7 @@ export class PurchaseCacheReserveRequest extends $dara.Model {
   crRegion?: string;
   /**
    * @remarks
-   * Purchase period (unit: month).
+   * The purchase period. Unit: months.
    * 
    * @example
    * 3
@@ -53,7 +52,7 @@ export class PurchaseCacheReserveRequest extends $dara.Model {
   period?: number;
   /**
    * @remarks
-   * Cache retention specification (unit: GB).
+   * The cache reserve specification. Unit: GB.
    * 
    * @example
    * 512000

package/src/models/PurchaseCacheReserveResponseBody.ts

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

package/src/models/QuotaListItemsValue.ts

@@ -6,12 +6,12 @@ import { WafQuotaString } from "./WafQuotaString";
 export class QuotaListItemsValue extends $dara.Model {
   /**
    * @remarks
-   * Whether the item type is enabled.
+   * Indicates whether the corresponding custom list item type is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The format constraints for the item type.
+   * The format restriction for the corresponding item type in custom lists.
    */
   value?: WafQuotaString;
   static names(): { [key: string]: string } {

package/src/models/QuotaPageContentTypesValue.ts

@@ -6,12 +6,12 @@ import { WafQuotaInteger } from "./WafQuotaInteger";
 export class QuotaPageContentTypesValue extends $dara.Model {
   /**
    * @remarks
-   * Whether the Content-Type is enabled.
+   * Indicates whether the corresponding Content-Type for custom response pages is enabled.
    */
   enable?: boolean;
   /**
    * @remarks
-   * The maximum content length for this Content-Type.
+   * The content length quota for the corresponding Content-Type in custom response pages.
    */
   contentLength?: WafQuotaInteger;
   static names(): { [key: string]: string } {

package/src/models/SetClientCertificateHostnamesRequest.ts

@@ -5,14 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class SetClientCertificateHostnamesRequest extends $dara.Model {
   /**
    * @remarks
-   * The hostnames to bind.
+   * The list of domain names to associate.
    * 
    * This parameter is required.
    */
   hostnames?: string[];
   /**
    * @remarks
-   * The ID of the client CA certificate.
+   * The client CA certificate ID.
    * 
    * @example
    * babab9db65ee5efcca9f3d41d4b50d**
@@ -20,7 +20,7 @@ export class SetClientCertificateHostnamesRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * This parameter is required.
    * 

package/src/models/SetClientCertificateHostnamesResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class SetClientCertificateHostnamesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of bound hostnames.
+   * The list of domain names to associate.
    */
   hostnames?: string[];
   /**
    * @remarks
-   * The ID of the client CA certificate.
+   * The client CA certificate ID.
    * 
    * @example
    * babab9db65ee5efcca9f3d41d4b50d**
@@ -26,7 +26,7 @@ export class SetClientCertificateHostnamesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * @example
    * 123456789****

package/src/models/SetClientCertificateHostnamesShrinkRequest.ts

@@ -5,14 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class SetClientCertificateHostnamesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The hostnames to bind.
+   * The list of domain names to associate.
    * 
    * This parameter is required.
    */
   hostnamesShrink?: string;
   /**
    * @remarks
-   * The ID of the client CA certificate.
+   * The client CA certificate ID.
    * 
    * @example
    * babab9db65ee5efcca9f3d41d4b50d**
@@ -20,7 +20,7 @@ export class SetClientCertificateHostnamesShrinkRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateListRequest.ts

@@ -15,7 +15,7 @@ export class UpdateListRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom list, which can be obtained by calling the [ListLists](https://help.aliyun.com/document_detail/2850217.html) operation.
+   * The ID of the custom list. You can obtain the ID by calling the [ListLists](https://help.aliyun.com/document_detail/2850217.html) operation.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,15 @@ export class UpdateListRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The items in the updated list. The value is a JSON array.
+   * The new list content. The value is a JSON array string, for example, `["1.1.1.1","2.2.2.2"]`.
+   * 
+   * **Full overwrite semantics**: The specified `Items` value completely overwrites the existing list content instead of appending to it.
+   * 
+   * > ⚠️ **If this parameter is not specified or is set to an empty value, the existing list content is cleared**. To retain existing items and append new ones, call `GetList` to retrieve the current `Items`, merge them, and then submit the combined list.
+   * 
+   * **Element format**: The format depends on the `Kind` value specified when the list was created. UpdateList does not support modifying Kind.
+   * - Kind = `ip`: Each element must be a valid IP address or CIDR block. If an element is invalid, `WrongValueMatched` is returned.
+   * - Other Kind values: The element format is subject to the relevant specifications. The number of elements is limited by the tenant quota `NumberItemsPerList`. This limit does not apply to the `ip` Kind.
    * 
    * This parameter is required.
    * 
@@ -35,7 +43,9 @@ export class UpdateListRequest extends $dara.Model {
   items?: string[];
   /**
    * @remarks
-   * The new name of the list.
+   * The new name of the custom list. If this parameter is not specified, the original name is retained.
+   * 
+   * **Naming rules**: Only letters, digits, and underscores are supported (`^\\w{1,64}$`). The name must be 1 to 64 characters in length.
    * 
    * This parameter is required.
    *