@alicloud/esa20240910 3.1.2 → 3.2.0

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

package/src/models/UpdateOriginRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -15,20 +15,67 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Rewrite the DNS resolution record of the origin request.
+   * Overrides the DNS record for the origin request.
    * 
    * @example
    * test.example.com
    */
   dnsRecord?: string;
+  /**
+   * @remarks
+   * Indicates whether to follow 302 redirects for origin requests. Valid values:
+   * 
+   * - `on`: Follows 302 redirects.
+   * 
+   * - `off`: Does not follow 302 redirects.
+   * 
+   * @example
+   * on
+   */
   follow302Enable?: string;
+  /**
+   * @remarks
+   * The maximum number of 302 redirects to follow. The value must be an integer from 1 to 5.
+   * 
+   * @example
+   * 1
+   */
   follow302MaxTries?: string;
+  /**
+   * @remarks
+   * Indicates whether to retain the original request parameters when following a 302 redirect. Valid values:
+   * 
+   * - `on`: Retains the parameters.
+   * 
+   * - `off`: Does not retain the parameters.
+   * 
+   * @example
+   * on
+   */
   follow302RetainArgs?: string;
+  /**
+   * @remarks
+   * Indicates whether to retain the original request headers when following a 302 redirect. Valid values:
+   * 
+   * - `on`: Retains the headers.
+   * 
+   * - `off`: Does not retain the headers.
+   * 
+   * @example
+   * on
+   */
   follow302RetainHeader?: string;
+  /**
+   * @remarks
+   * The `Host` header for the redirected origin request.
+   * 
+   * @example
+   * test.com
+   */
   follow302TargetHost?: string;
   /**
    * @remarks
-   * The HOST carried in the origin request.
+   * The `Host` header for the origin request.
    * 
    * @example
    * origin.example.com
@@ -36,7 +83,7 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originHost?: string;
   /**
    * @remarks
-   * Port of the origin server when using HTTP protocol for origin pull.
+   * The origin server port for HTTP requests.
    * 
    * @example
    * 8080
@@ -44,7 +91,7 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originHttpPort?: string;
   /**
    * @remarks
-   * Port of the origin server when using HTTPS protocol for origin pull.
+   * The origin server port for HTTPS requests.
    * 
    * @example
    * 4433
@@ -52,21 +99,33 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originHttpsPort?: string;
   /**
    * @remarks
-   * mTLS switch. Valid values:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether to enable mutual TLS (mTLS) for origin requests. Valid values:
+   * 
+   * - `on`: Enables mTLS.
+   * 
+   * - `off`: Disables mTLS.
    * 
    * @example
    * on
    */
   originMtls?: string;
+  /**
+   * @remarks
+   * The read timeout period for the origin server, in seconds.
+   * 
+   * @example
+   * 10
+   */
   originReadTimeout?: string;
   /**
    * @remarks
-   * Protocol used for the origin request. Valid values:
-   * - http: Use HTTP protocol for origin pull.
-   * - https: Use HTTPS protocol for origin pull.
-   * - follow: Follow the client\\"s protocol for origin pull.
+   * The protocol for origin requests. Valid values:
+   * 
+   * - `http`: The origin request uses HTTP.
+   * 
+   * - `https`: The origin request uses HTTPS.
+   * 
+   * - `follow`: The origin request uses the same protocol as the client request.
    * 
    * @example
    * http
@@ -74,7 +133,7 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originScheme?: string;
   /**
    * @remarks
-   * SNI carried in the origin request.
+   * The Server Name Indication (SNI) for the origin request.
    * 
    * @example
    * origin.example.com
@@ -82,9 +141,11 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originSni?: string;
   /**
    * @remarks
-   * Origin certificate verification switch. Valid values:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether to enable origin certificate verification. Valid values:
+   * 
+   * - `on`: Enables verification.
+   * 
+   * - `off`: Disables verification.
    * 
    * @example
    * on
@@ -92,21 +153,41 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   originVerify?: string;
   /**
    * @remarks
-   * Use range chunking for origin pull file download. Valid values:
-   * - on: Enable.
-   * - off: Disable.
-   * - force: Force.
+   * Indicates whether to use range requests when fetching files from the origin server. Valid values:
+   * 
+   * - `on`: Enables range requests.
+   * 
+   * - `off`: Disables range requests.
+   * 
+   * - `force`: Enforces range requests.
    * 
    * @example
    * on
    */
   range?: string;
+  /**
+   * @remarks
+   * The size of each chunk for range requests. Valid values:
+   * 
+   * - 512KB
+   * 
+   * - 1MB
+   * 
+   * - 2MB
+   * 
+   * - 4MB
+   * 
+   * @example
+   * 1MB
+   */
   rangeChunkSize?: string;
   /**
    * @remarks
-   * Rule content, used to match user requests with conditional expressions. 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 is a conditional expression that matches user requests. This parameter is not required when you add a global configuration.
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -114,9 +195,11 @@ export class UpdateOriginRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Valid values:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether the rule is enabled. This parameter is not required when you add a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -124,16 +207,23 @@ export class UpdateOriginRuleRequest 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.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can get this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateOriginRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateOriginRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9