@alicloud/esa20240910 3.1.2 → 3.3.0

package/src/models/UpdateLoadBalancerShrinkRequest.ts

@@ -5,17 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration for fallback across pools.
+   * Configures origin-pull behavior across address pools.
    */
   adaptiveRoutingShrink?: string;
   /**
    * @remarks
-   * List of default pool IDs.
+   * A list of default address pool IDs.
    */
   defaultPoolsShrink?: string;
   /**
    * @remarks
-   * Detailed description of the load balancer, for easier management and identification.
+   * An optional description of the load balancer for easier identification and management.
    * 
    * @example
    * Load balancer description
@@ -23,10 +23,11 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Whether the load balancer is enabled.
+   * Specifies whether the load balancer is enabled.
    * 
-   * - true: Enabled.
-   * - false: Not enabled.
+   * - `true`: The load balancer is enabled.
+   * 
+   * - `false`: The load balancer is disabled.
    * 
    * @example
    * true
@@ -34,7 +35,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * Fallback pool ID, where traffic will be directed when all other pools are unavailable.
+   * The ID of the fallback address pool. Traffic is routed to this pool when all other address pools are unavailable.
    * 
    * @example
    * 96228666776****
@@ -42,7 +43,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   fallbackPool?: number;
   /**
    * @remarks
-   * Load balancer ID, which can be obtained by calling the [ListLoadBalancers](https://help.aliyun.com/document_detail/2868897.html) API.
+   * The ID of the load balancer. You can obtain this ID by calling the [ListLoadBalancers](https://help.aliyun.com/document_detail/2868897.html) API operation.
    * 
    * This parameter is required.
    * 
@@ -52,17 +53,17 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Monitor configuration for health checks.
+   * The health check monitor configuration.
    */
   monitorShrink?: string;
   /**
    * @remarks
-   * Weighted round-robin configuration, used to control the traffic distribution weights among different pools.
+   * The configuration for weighted round-robin. This setting controls the weight of traffic distributed to different address pools.
    */
   randomSteeringShrink?: string;
   /**
    * @remarks
-   * Address pool corresponding to the primary region.
+   * A map of primary regions to their corresponding address pools.
    * 
    * @example
    * {
@@ -78,7 +79,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   regionPools?: any;
   /**
    * @remarks
-   * Rule configuration list, used to define behavior overrides under specific conditions.
+   * A list of rules that define behavior overrides for specific conditions.
    * 
    * **if can be null:**
    * false
@@ -86,10 +87,13 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   rulesShrink?: string;
   /**
    * @remarks
-   * Session persistence, with possible values:
-   * - off: Not enabled.
-   * - ip: Session persistence by IP.
-   * - cookie: Session persistence by cookie.
+   * The method for session affinity, which ensures that requests from the same client are routed to the same origin server. Valid values:
+   * 
+   * - `off`: Disables session affinity.
+   * 
+   * - `ip`: Enables session affinity based on the client IP address.
+   * 
+   * - `cookie`: Enables session affinity based on a cookie.
    * 
    * @example
    * ip
@@ -97,7 +101,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   sessionAffinity?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The ID of the Site. You can obtain this ID by calling the [ListSites](~~ListSites~~) API operation.
    * 
    * This parameter is required.
    * 
@@ -107,7 +111,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Load balancing policy.
+   * The traffic steering policy, which determines how traffic is distributed among the address pools.
    * 
    * @example
    * order
@@ -115,7 +119,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   steeringPolicy?: string;
   /**
    * @remarks
-   * Address pool corresponding to the secondary region. When multiple secondary regions share the same address pool, the regions can be concatenated with commas as the key.
+   * A map of secondary regions to their corresponding address pools. To assign the same address pools to multiple secondary regions, combine their codes into a single, comma-separated key.
    * 
    * @example
    * {"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}
@@ -123,7 +127,7 @@ export class UpdateLoadBalancerShrinkRequest extends $dara.Model {
   subRegionPools?: any;
   /**
    * @remarks
-   * TTL value, the time-to-live for DNS records, with a default of 30 and a range of 10-600.
+   * The Time to Live (TTL) for the DNS record, in seconds. The default is 30. The value must be between 10 and 600, inclusive.
    * 
    * @example
    * 300

package/src/models/UpdateManagedTransformRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateManagedTransformRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to include the header that indicates the geographical location of a client in an origin request. Valid values:
+   * Specifies whether to add a header that contains visitor geolocation information. Valid values:
    * 
-   * *   on
-   * *   off
+   * - `on`: Add the header.
+   * 
+   * - `off`: Do not add the header.
    * 
    * @example
    * on
@@ -16,19 +17,27 @@ export class UpdateManagedTransformRequest extends $dara.Model {
   addClientGeolocationHeader?: string;
   /**
    * @remarks
-   * Specifies whether to include the "ali-real-client-ip" header that indicates the client\\"s real IP address in an origin request. Valid values:
+   * Specifies whether to add the `ali-real-client-ip` header, which contains the real client IP. Valid values:
+   * 
+   * - `on`: Add the header.
    * 
-   * *   on
-   * *   off
+   * - `off`: Do not add the header.
    * 
    * @example
    * on
    */
   addRealClientIpHeader?: string;
+  /**
+   * @remarks
+   * The name of the header that contains the real client IP. The name must start with a letter and can contain letters, digits (0-9), and hyphens (-).
+   * 
+   * @example
+   * test-header
+   */
   realClientIpHeaderName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The ID of the site. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 
@@ -38,7 +47,7 @@ export class UpdateManagedTransformRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The version of the site. For sites with version management enabled, this parameter specifies the version to which the configuration applies. Default value: 0.
    * 
    * @example
    * 0

package/src/models/UpdateManagedTransformResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateManagedTransformResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE

package/src/models/UpdateNetworkOptimizationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateNetworkOptimizationRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -15,9 +15,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Whether to enable GRPC, default is disabled. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Controls whether gRPC is enabled. This feature is disabled by default. Valid values:
+   * 
+   * - on: gRPC is enabled.
+   * 
+   * - off: gRPC is disabled.
    * 
    * @example
    * on
@@ -25,9 +27,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   grpc?: string;
   /**
    * @remarks
-   * Whether to enable HTTP2 origin, default is disabled. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Controls whether HTTP/2 to origin is enabled. This feature is disabled by default. Valid values:
+   * 
+   * - on: HTTP/2 to origin is enabled.
+   * 
+   * - off: HTTP/2 to origin is disabled.
    * 
    * @example
    * on
@@ -35,9 +39,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   http2Origin?: string;
   /**
    * @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 conditional expression used to match requests. This parameter is optional for global configurations.
+   * 
+   * - To match all incoming requests, set the value to true.
+   * 
+   * - To match specific requests, set the value to a custom expression, for example, (http.host eq "video.example.com").
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -45,9 +51,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether the rule is enabled. This parameter is optional for global configurations. Valid values:
+   * 
+   * - on: The rule is enabled.
+   * 
+   * - off: The rule is disabled.
    * 
    * @example
    * on
@@ -55,16 +63,23 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is optional for global configurations.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The rule execution order. Smaller values have higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.
+   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 
@@ -74,9 +89,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Whether to enable the smart routing service, default is disabled. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Controls whether smart routing is enabled. This feature is disabled by default. Valid values:
+   * 
+   * - on: Smart routing is enabled.
+   * 
+   * - off: Smart routing is disabled.
    * 
    * @example
    * on
@@ -84,7 +101,7 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   smartRouting?: string;
   /**
    * @remarks
-   * Maximum upload file size, in MB, with a range of 100 to 500.
+   * The maximum upload file size, in MB. The value must be an integer from 100 to 500.
    * 
    * @example
    * 100
@@ -92,9 +109,11 @@ export class UpdateNetworkOptimizationRequest extends $dara.Model {
   uploadMaxFilesize?: string;
   /**
    * @remarks
-   * Whether to enable Websocket, default is enabled. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Controls whether WebSocket is enabled. This feature is enabled by default. Valid values:
+   * 
+   * - on: WebSocket is enabled.
+   * 
+   * - off: WebSocket is disabled.
    * 
    * @example
    * on

package/src/models/UpdateNetworkOptimizationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateNetworkOptimizationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE

package/src/models/UpdateOriginPoolRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   /**
    * @remarks
-   * The AccessKey required for private authentication.
+   * The access key for private authentication. Required for private origins.
    * 
    * @example
    * yourAccessKeyID
@@ -13,12 +13,15 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   accessKey?: string;
   /**
    * @remarks
-   * The type of authentication.
+   * The authentication type. Valid values:
    * 
-   * - public: Public read/write, used when the origin is OSS or S3 and is set to public read/write;
-   * - private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;
-   * - private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts;
-   * - private: Used when the origin is S3 and the authentication type is private.
+   * - 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.
    * 
    * @example
    * public
@@ -26,7 +29,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   authType?: string;
   /**
    * @remarks
-   * The region of the origin required when the origin is AWS S3.
+   * The region of the origin. This parameter is required if the origin type is S3.
    * 
    * @example
    * us-east-1
@@ -34,7 +37,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The SecretKey required for private authentication.
+   * The secret key for private authentication. Required for private origins.
    * 
    * @example
    * yourAccessKeySecret
@@ -42,7 +45,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   secretKey?: string;
   /**
    * @remarks
-   * The signature version required when the origin is AWS S3.
+   * The signature version. This parameter is required if the origin type is S3.
    * 
    * @example
    * v2
@@ -80,7 +83,7 @@ export class UpdateOriginPoolRequestOriginsAuthConf extends $dara.Model {
 export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   /**
    * @remarks
-   * The address of the origin, e.g., www.example.com.
+   * The origin\\"s domain name or IP address.
    * 
    * @example
    * www.example.com
@@ -88,15 +91,16 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   address?: string;
   /**
    * @remarks
-   * Authentication information. When the origin is OSS or S3 and requires authentication, you need to pass the related configuration information for authentication.
+   * The authentication configuration. Required for private OSS or S3 origins.
    */
   authConf?: UpdateOriginPoolRequestOriginsAuthConf;
   /**
    * @remarks
-   * Whether the origin is enabled:
+   * Specifies whether to enable the origin:
+   * 
+   * - true: Enables the origin.
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - false: Disables the origin.
    * 
    * @example
    * true
@@ -104,7 +108,7 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The request header to be included when fetching from the origin, supporting only Host.
+   * The request header to add to back-to-origin requests. Only the Host header is supported.
    * 
    * @example
    * {
@@ -114,10 +118,25 @@ 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.
+   * 
+   * @example
+   * round_robin
+   */
   ipVersionPolicy?: string;
   /**
    * @remarks
-   * The name of the origin, which must be unique under one origin pool.
+   * The name of the origin. The name must be unique within the origin pool.
    * 
    * @example
    * origin1
@@ -125,11 +144,13 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The type of the origin:
+   * The origin type. Valid values:
+   * 
+   * - ip_domain: An IP address or a domain name.
    * 
-   * - ip_domain: IP or domain type origin;
-   * - OSS: OSS address origin;
-   * - S3: AWS S3 origin.
+   * - OSS: An OSS origin.
+   * 
+   * - S3: An AWS S3 origin.
    * 
    * @example
    * OSS
@@ -137,7 +158,7 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The weight, an integer between 0 and 100.
+   * The weight of the origin. The value must be an integer from 0 to 100.
    * 
    * @example
    * 50
@@ -184,10 +205,11 @@ export class UpdateOriginPoolRequestOrigins extends $dara.Model {
 export class UpdateOriginPoolRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether the origin pool is enabled:
+   * Specifies whether to enable the origin pool:
+   * 
+   * - true: Enables the origin pool.
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - false: Disables the origin pool.
    * 
    * @example
    * true
@@ -195,7 +217,7 @@ export class UpdateOriginPoolRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The ID of the origin pool, which can be obtained by calling the [ListOriginPools](https://help.aliyun.com/document_detail/2863947.html) interface.
+   * The origin pool ID. Get this ID by calling the [ListOriginPools](~~ListOriginPools~~) operation.
    * 
    * This parameter is required.
    * 
@@ -205,12 +227,12 @@ export class UpdateOriginPoolRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Information about the origins added to the origin pool. Multiple origins are passed as an array.
+   * An array of origin configurations.
    */
   origins?: UpdateOriginPoolRequestOrigins[];
   /**
    * @remarks
-   * The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. Get this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * 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
-   * Source address pool ID.
+   * The origin pool ID.
    * 
    * @example
    * 1038520525196928

package/src/models/UpdateOriginPoolShrinkRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether the origin pool is enabled:
+   * Specifies whether to enable the origin pool:
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - true: Enables the origin pool.
+   * 
+   * - false: Disables the origin pool.
    * 
    * @example
    * true
@@ -16,7 +17,7 @@ export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The ID of the origin pool, which can be obtained by calling the [ListOriginPools](https://help.aliyun.com/document_detail/2863947.html) interface.
+   * The origin pool ID. Get this ID by calling the [ListOriginPools](~~ListOriginPools~~) operation.
    * 
    * This parameter is required.
    * 
@@ -26,12 +27,12 @@ export class UpdateOriginPoolShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Information about the origins added to the origin pool. Multiple origins are passed as an array.
+   * An array of origin configurations.
    */
   originsShrink?: string;
   /**
    * @remarks
-   * The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. Get this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateOriginProtectionIpWhiteListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginProtectionIpWhiteListRequest extends $dara.Model {
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * Site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to get this value.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateOriginProtectionIpWhiteListResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginProtectionIpWhiteListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE

package/src/models/UpdateOriginProtectionRequest.ts

@@ -10,10 +10,11 @@ export class UpdateOriginProtectionRequest extends $dara.Model {
   autoConfirmIPList?: string;
   /**
    * @remarks
-   * The IP convergence status.
+   * The origin fetch convergence switch.
    * 
-   * *   on
-   * *   off
+   * - on: Enable origin fetch convergence.
+   * 
+   * - off: Disable origin fetch convergence.
    * 
    * This parameter is required.
    * 
@@ -23,7 +24,7 @@ export class UpdateOriginProtectionRequest extends $dara.Model {
   originConverge?: 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. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API to get it.
    * 
    * This parameter is required.
    *