@alicloud/esa20240910 3.3.0 → 3.5.0

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.
    * 

package/src/models/UpdateListShrinkRequest.ts

@@ -15,7 +15,7 @@ export class UpdateListShrinkRequest 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 UpdateListShrinkRequest 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 UpdateListShrinkRequest extends $dara.Model {
   itemsShrink?: 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.
    * 

package/src/models/UpdateOriginPoolRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   /**
    * @remarks
-   * The access key for private authentication. Required for private origins.
+   * The AccessKey required for private authentication.
    * 
    * @example
    * yourAccessKeyID
@@ -15,13 +15,10 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
    * @remarks
    * The authentication type. Valid values:
    * 
-   * - public: For public OSS or S3 origins.
-   * 
-   * - private_same_account: For private OSS origins in the same account.
-   * 
-   * - private_cross_account: For private OSS origins that use cross-account authentication.
-   * 
-   * - private: For private S3 origins.
+   * - public: public read/write. Use this value when the origin server is OSS or S3 with public read/write access.
+   * - private_same_account: private same-account. Use this value when the origin server is OSS with same-account private authentication.
+   * - private_cross_account: private cross-account. Use this value when the origin server is OSS with cross-account private authentication.
+   * - private: Use this value when the origin server is S3 with private authentication.
    * 
    * @example
    * public
@@ -29,7 +26,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   authType?: string;
   /**
    * @remarks
-   * The region of the origin. This parameter is required if the origin type is S3.
+   * The region of the origin server required when the origin server is AWS S3.
    * 
    * @example
    * us-east-1
@@ -37,7 +34,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The secret key for private authentication. Required for private origins.
+   * The SecretKey required for private authentication.
    * 
    * @example
    * yourAccessKeySecret
@@ -45,7 +42,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   secretKey?: string;
   /**
    * @remarks
-   * The signature version. This parameter is required if the origin type is S3.
+   * The signature version required when the origin server is AWS S3.
    * 
    * @example
    * v2
@@ -83,7 +80,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
 export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   /**
    * @remarks
-   * The origin\\"s domain name or IP address.
+   * The addresses of the origin server, such as www.example.com.
    * 
    * @example
    * www.example.com
@@ -91,16 +88,15 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   address?: string;
   /**
    * @remarks
-   * The authentication configuration. Required for private OSS or S3 origins.
+   * The authentication information. This parameter is required when the origin server is OSS, S3, or another origin server that requires authentication.
    */
   authConf?: UpdateOriginPoolRequestOriginsAuthConf;
   /**
    * @remarks
-   * Specifies whether to enable the origin:
+   * Specifies whether the origin server is enabled. Valid values:
    * 
-   * - true: Enables the origin.
-   * 
-   * - false: Disables the origin.
+   * - true: Enabled.
+   * - false: Not enabled.
    * 
    * @example
    * true
@@ -108,7 +104,7 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The request header to add to back-to-origin requests. Only the Host header is supported.
+   * The request header included in back-to-origin requests. Only Host is supported.
    * 
    * @example
    * {
@@ -120,15 +116,11 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   header?: any;
   /**
    * @remarks
-   * The IP version policy for back-to-origin requests. Valid values:
-   * 
-   * - round_robin: (Default) Randomly selects an IPv4 or IPv6 origin.
-   * 
-   * - ipv4_first: Prioritizes IPv4 origins.
-   * 
-   * - ipv6_first: Prioritizes IPv6 origins.
-   * 
-   * - follow: Uses the same IP version as the client request.
+   * The IP protocol version used for back-to-origin requests. Valid values:
+   * - round_robin: default policy. Randomly polls IPv4 or IPv6 origin servers.
+   * - ipv4_first: preferentially uses IPv4 origin servers.
+   * - ipv6_first: preferentially uses IPv6 origin servers.
+   * - follow: preferentially follows the IP version used by the client.
    * 
    * @example
    * round_robin
@@ -136,7 +128,7 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   ipVersionPolicy?: string;
   /**
    * @remarks
-   * The name of the origin. The name must be unique within the origin pool.
+   * The origin server name. The name must be unique within an origin address pool.
    * 
    * @example
    * origin1
@@ -144,13 +136,11 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The origin type. Valid values:
-   * 
-   * - ip_domain: An IP address or a domain name.
+   * The origin server type. Valid values:
    * 
-   * - OSS: An OSS origin.
-   * 
-   * - S3: An AWS S3 origin.
+   * - ip_domain: an IP address or domain name-based origin server.
+   * - OSS: an OSS address-based origin server.
+   * - S3: an AWS S3 origin server.
    * 
    * @example
    * OSS
@@ -158,7 +148,7 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The weight of the origin. The value must be an integer from 0 to 100.
+   * The weight. The value is an integer from 0 to 100.
    * 
    * @example
    * 50
@@ -205,11 +195,10 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
 export class UpdateOriginPoolRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable the origin pool:
-   * 
-   * - true: Enables the origin pool.
+   * Specifies whether the origin address pool is enabled. Valid values:
    * 
-   * - false: Disables the origin pool.
+   * - true: Enabled.
+   * - false: Not enabled.
    * 
    * @example
    * true
@@ -217,7 +206,7 @@ export class UpdateOriginPoolRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The origin pool ID. Get this ID by calling the [ListOriginPools](~~ListOriginPools~~) operation.
+   * The origin address pool ID. You can call the [ListOriginPools](~~ListOriginPools~~) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -227,12 +216,12 @@ export class UpdateOriginPoolRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * An array of origin configurations.
+   * The origin server information added to the origin address pool. Use an array to pass multiple origin servers.
    */
   origins?: UpdateOriginPoolRequestOrigins[];
   /**
    * @remarks
-   * The site ID. Get this ID by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the ID.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateOriginPoolResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginPoolResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The origin pool ID.
+   * The origin address pool ID.
    * 
    * @example
    * 1038520525196928

package/src/models/UpdateOriginPoolShrinkRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable the origin pool:
+   * Specifies whether the origin address pool is enabled. Valid values:
    * 
-   * - true: Enables the origin pool.
-   * 
-   * - false: Disables the origin pool.
+   * - true: Enabled.
+   * - false: Not enabled.
    * 
    * @example
    * true
@@ -17,7 +16,7 @@ export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The origin pool ID. Get this ID by calling the [ListOriginPools](~~ListOriginPools~~) operation.
+   * The origin address pool ID. You can call the [ListOriginPools](~~ListOriginPools~~) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -27,12 +26,12 @@ export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * An array of origin configurations.
+   * The origin server information added to the origin address pool. Use an array to pass multiple origin servers.
    */
   originsShrink?: string;
   /**
    * @remarks
-   * The site ID. Get this ID by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the ID.
    * 
    * This parameter is required.
    * 

package/src/models/UpdatePageRequest.ts

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
+   * The BASE64-encoded page content, which must be consistent with `ContentType`.
+   * 
+   * **Encoding method**:
+   * 1. Convert the original page content to a UTF-8 byte string.
+   * 2. Encode the byte string using standard BASE64 encoding.
+   * 
+   * **Example**: `<html>hello page</html>` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   * 
+   * > The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.
    * 
    * This parameter is required.
    * 
@@ -15,11 +23,13 @@ export class UpdatePageRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The value for the Content-Type HTTP header. Examples:
+   * The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched.
    * 
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page
+   * - `application/json`: JSON response
    * 
-   * - application/json
+   * > The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.
    * 
    * This parameter is required.
    * 
@@ -29,7 +39,7 @@ export class UpdatePageRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom response page.
+   * The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.
    * 
    * This parameter is required.
    * 
@@ -39,7 +49,7 @@ export class UpdatePageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom response page. Retrieve this ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) API.
+   * The ID of the custom response page. You can obtain this value by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
    * 
    * This parameter is required.
    * 
@@ -49,7 +59,9 @@ export class UpdatePageRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom response page.
+   * The name of the custom response page after the update.
+   * 
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.
    * 
    * This parameter is required.
    * 
@@ -57,6 +69,14 @@ export class UpdatePageRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics.
+   * 
+   * - You can obtain site IDs by calling the `ListSites` operation.
+   * - Passing an empty list dissociates all sites from the page.
+   * - Including a site ID that does not belong to your account returns an `InvalidParameter` error.
+   */
   siteIds?: number[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdatePageResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225

package/src/models/UpdatePageShrinkRequest.ts

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
+   * The BASE64-encoded page content, which must be consistent with `ContentType`.
+   * 
+   * **Encoding method**:
+   * 1. Convert the original page content to a UTF-8 byte string.
+   * 2. Encode the byte string using standard BASE64 encoding.
+   * 
+   * **Example**: `<html>hello page</html>` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   * 
+   * > The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.
    * 
    * This parameter is required.
    * 
@@ -15,11 +23,13 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The value for the Content-Type HTTP header. Examples:
+   * The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched.
    * 
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page
+   * - `application/json`: JSON response
    * 
-   * - application/json
+   * > The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.
    * 
    * This parameter is required.
    * 
@@ -29,7 +39,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom response page.
+   * The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.
    * 
    * This parameter is required.
    * 
@@ -39,7 +49,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom response page. Retrieve this ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) API.
+   * The ID of the custom response page. You can obtain this value by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
    * 
    * This parameter is required.
    * 
@@ -49,7 +59,9 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom response page.
+   * The name of the custom response page after the update.
+   * 
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.
    * 
    * This parameter is required.
    * 
@@ -57,6 +69,14 @@ export class UpdatePageShrinkRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics.
+   * 
+   * - You can obtain site IDs by calling the `ListSites` operation.
+   * - Passing an empty list dissociates all sites from the page.
+   * - Including a site ID that does not belong to your account returns an `InvalidParameter` error.
+   */
   siteIdsShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdatePerformanceDataCollectionRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePerformanceDataCollectionRequest extends $dara.Model {
   /**
    * @remarks
-   * Enables or disables Performance Data Collection. Valid values:
-   * 
-   * - `on`: Enables the Feature.
-   * 
-   * - `off`: Disables the Feature.
+   * Specifies whether to enable quality data collection. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * This parameter is required.
    * 
@@ -19,7 +17,7 @@ export class UpdatePerformanceDataCollectionRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * The ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) API.
+   * The site ID. You can obtain the ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    *