@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/CreateNetworkOptimizationRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkOptimizationRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable GRPC, disabled by default. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Specifies whether to enable gRPC. This feature is disabled by default. Valid values:
+   * - on: enabled
+   * - off: disabled.
    * 
    * @example
    * on
@@ -15,9 +15,9 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   grpc?: string;
   /**
    * @remarks
-   * Whether to enable HTTP2 origin, disabled by default. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Specifies whether to enable HTTP/2 back-to-origin. This feature is disabled by default. Valid values:
+   * - on: enabled
+   * - off: disabled.
    * 
    * @example
    * on
@@ -25,9 +25,9 @@ export class CreateNetworkOptimizationRequest 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 rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:
+   * - Match all incoming requests: set the value to true.
+   * - Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -35,9 +35,9 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * The rule switch. This parameter is not required when you add a global configuration. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -45,16 +45,23 @@ export class CreateNetworkOptimizationRequest 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 rule execution order. A smaller value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -64,7 +71,7 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the configuration, defaulting to version 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 on which the configuration takes effect. The default value is 0.
    * 
    * @example
    * 1
@@ -72,9 +79,9 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * Whether to enable smart routing service, disabled by default. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Specifies whether to enable smart routing. This feature is disabled by default. Valid values:
+   * - on: enabled
+   * - off: disabled.
    * 
    * @example
    * on
@@ -82,7 +89,7 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   smartRouting?: string;
   /**
    * @remarks
-   * Maximum upload file size in MB, range: 100～500.
+   * The maximum upload file size, in MB. Valid values: 100 to 500.
    * 
    * @example
    * 100
@@ -90,9 +97,9 @@ export class CreateNetworkOptimizationRequest extends $dara.Model {
   uploadMaxFilesize?: string;
   /**
    * @remarks
-   * Whether to enable Websocket, enabled by default. Possible values:
-   * - on: Enable
-   * - off: Disable
+   * Specifies whether to enable WebSocket. This feature is enabled by default. Valid values:
+   * - on: enabled
+   * - off: disabled.
    * 
    * @example
    * on

package/src/models/CreateNetworkOptimizationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkOptimizationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 352816096987136
@@ -13,7 +13,7 @@ export class CreateNetworkOptimizationResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/CreateOriginPoolRequest.ts

@@ -13,12 +13,15 @@ export class CreateOriginPoolRequestOriginsAuthConf 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`: Public read/write. Use this for public OSS or AWS S3 buckets.
+   * 
+   * - `private_same_account`: Private authentication for an OSS bucket in the same Alibaba Cloud account.
+   * 
+   * - `private_cross_account`: Private authentication for an OSS bucket in a different Alibaba Cloud account.
+   * 
+   * - `private`: Private authentication for an AWS S3 bucket.
    * 
    * @example
    * public
@@ -26,7 +29,7 @@ export class CreateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   authType?: string;
   /**
    * @remarks
-   * The region of the origin required when the origin is AWS S3.
+   * The region of the origin. Required for AWS S3 origins.
    * 
    * @example
    * us-east-1
@@ -42,7 +45,7 @@ export class CreateOriginPoolRequestOriginsAuthConf extends $dara.Model {
   secretKey?: string;
   /**
    * @remarks
-   * The signature version required when the origin is AWS S3.
+   * The signature version. Required for AWS S3 origins.
    * 
    * @example
    * v2
@@ -80,7 +83,7 @@ export class CreateOriginPoolRequestOriginsAuthConf extends $dara.Model {
 export class CreateOriginPoolRequestOrigins extends $dara.Model {
   /**
    * @remarks
-   * The address of the origin, e.g., www.example.com.
+   * The address of the origin. For example, www\\.example.com.
    * 
    * @example
    * www.example.com
@@ -88,15 +91,16 @@ export class CreateOriginPoolRequestOrigins extends $dara.Model {
   address?: string;
   /**
    * @remarks
-   * Authentication information, required when the origin is OSS or S3 and needs authentication, including related configuration details.
+   * The authentication configuration for the origin. Required if the origin is an OSS or AWS S3 bucket that requires authentication.
    */
   authConf?: CreateOriginPoolRequestOriginsAuthConf;
   /**
    * @remarks
-   * Whether the origin is enabled:
+   * Specifies whether the origin is enabled.
+   * 
+   * - `true`: enabled
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - `false`: disabled
    * 
    * @example
    * true
@@ -104,7 +108,7 @@ export class CreateOriginPoolRequestOrigins extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The request header to be included when fetching from the origin, only Host is supported.
+   * The request header to include in back-to-origin requests. Only the `Host` header is supported.
    * 
    * @example
    * {
@@ -114,10 +118,25 @@ export class CreateOriginPoolRequestOrigins extends $dara.Model {
    *       }
    */
   header?: any;
+  /**
+   * @remarks
+   * The IP protocol version 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 protocol version as the client\\"s request.
+   * 
+   * @example
+   * round_robin
+   */
   ipVersionPolicy?: string;
   /**
    * @remarks
-   * The name of the origin, which must be unique within an origin address.
+   * The name of the origin. The name must be unique within the origin pool.
    * 
    * @example
    * origin1
@@ -125,11 +144,13 @@ export class CreateOriginPoolRequestOrigins extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The type of the origin:
+   * The type of the origin. Valid values:
+   * 
+   * - `ip_domain`: An IP address or a domain name.
    * 
-   * - ip_domain: IP or domain name type origin;
-   * - OSS: OSS address origin;
-   * - S3: AWS S3 origin.
+   * - `OSS`: An Alibaba Cloud OSS bucket.
+   * 
+   * - `S3`: An AWS S3 bucket.
    * 
    * @example
    * ip_domain
@@ -137,7 +158,7 @@ export class CreateOriginPoolRequestOrigins 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 CreateOriginPoolRequestOrigins extends $dara.Model {
 export class CreateOriginPoolRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether the origin address pool is enabled:
+   * Specifies whether the origin pool is enabled.
+   * 
+   * - `true`: enabled
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - `false`: disabled
    * 
    * @example
    * true
@@ -195,7 +217,7 @@ export class CreateOriginPoolRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The name of the origin address pool, which must be unique within a site.
+   * The name of the origin pool. The name must be unique within a site.
    * 
    * This parameter is required.
    * 
@@ -205,12 +227,12 @@ export class CreateOriginPoolRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Information about the origins added to the origin address pool, with multiple origins passed as an array.
+   * The list of origins to add to the origin pool. Use an array to specify multiple origins.
    */
   origins?: CreateOriginPoolRequestOrigins[];
   /**
    * @remarks
-   * The 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) operation.
    * 
    * This parameter is required.
    * 

package/src/models/CreateOriginPoolResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOriginPoolResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the newly created origin address pool.
+   * The origin pool ID.
    * 
    * @example
    * 103852052519****

package/src/models/CreateOriginPoolShrinkRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOriginPoolShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether the origin address pool is enabled:
+   * Specifies whether the origin pool is enabled.
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - `true`: enabled
+   * 
+   * - `false`: disabled
    * 
    * @example
    * true
@@ -16,7 +17,7 @@ export class CreateOriginPoolShrinkRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The name of the origin address pool, which must be unique within a site.
+   * The name of the origin pool. The name must be unique within a site.
    * 
    * This parameter is required.
    * 
@@ -26,12 +27,12 @@ export class CreateOriginPoolShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Information about the origins added to the origin address pool, with multiple origins passed as an array.
+   * The list of origins to add to the origin pool. Use an array to specify multiple origins.
    */
   originsShrink?: string;
   /**
    * @remarks
-   * The 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) operation.
    * 
    * This parameter is required.
    * 

package/src/models/CreateOriginProtectionRequest.ts

@@ -4,13 +4,18 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateOriginProtectionRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to automatically enable the latest back-to-origin IP addresses list. Valid values:
+   * - off: Do not automatically enable.
+   * - on: Automatically enable.
+   * 
    * @example
    * off
    */
   autoConfirmIPList?: 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, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation. The plan associated with the site must support the origin protection feature.
    * 
    * This parameter is required.
    * 

package/src/models/CreateOriginRuleRequest.ts

@@ -5,20 +5,67 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOriginRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Rewrite the DNS resolution record for the origin request.
+   * Overrides the DNS Record for Origin requests.
    * 
    * @example
    * test.example.com
    */
   dnsRecord?: string;
+  /**
+   * @remarks
+   * Specifies whether to follow 302 redirects from the Origin. Valid values:
+   * 
+   * - `on`: Enables following redirects.
+   * 
+   * - `off`: Disables following redirects.
+   * 
+   * @example
+   * on
+   */
   follow302Enable?: string;
+  /**
+   * @remarks
+   * The maximum number of 302 redirects to follow. Valid range: 1 to 5.
+   * 
+   * @example
+   * 1
+   */
   follow302MaxTries?: string;
+  /**
+   * @remarks
+   * Specifies whether to retain the original request parameters when following a 302 redirect. Valid values:
+   * 
+   * - `on`: Retains the request parameters.
+   * 
+   * - `off`: Does not retain the request parameters.
+   * 
+   * @example
+   * on
+   */
   follow302RetainArgs?: string;
+  /**
+   * @remarks
+   * Specifies whether to retain the original request header when following a 302 redirect. Valid values:
+   * 
+   * - `on`: Retains the request header.
+   * 
+   * - `off`: Does not retain the request header.
+   * 
+   * @example
+   * on
+   */
   follow302RetainHeader?: string;
+  /**
+   * @remarks
+   * The Origin `Host` header to use after a 302 redirect.
+   * 
+   * @example
+   * test.com
+   */
   follow302TargetHost?: string;
   /**
    * @remarks
-   * The HOST carried in the origin request.
+   * The `Host` header to use in Origin requests.
    * 
    * @example
    * origin.example.com
@@ -26,7 +73,7 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originHost?: string;
   /**
    * @remarks
-   * Port of the origin server when using the HTTP protocol for origin requests.
+   * The Origin Port to use for HTTP Origin requests.
    * 
    * @example
    * 8080
@@ -34,7 +81,7 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originHttpPort?: string;
   /**
    * @remarks
-   * Port of the origin server when using the HTTPS protocol for origin requests.
+   * The Origin Port to use for HTTPS Origin requests.
    * 
    * @example
    * 4433
@@ -42,21 +89,33 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originHttpsPort?: string;
   /**
    * @remarks
-   * mTLS switch. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable mutual Transport Layer Security (mTLS) for Origin connections. Valid values:
+   * 
+   * - `on`: Enables mTLS.
+   * 
+   * - `off`: Disables mTLS.
    * 
    * @example
    * on
    */
   originMtls?: string;
+  /**
+   * @remarks
+   * The Origin read timeout in seconds.
+   * 
+   * @example
+   * 10
+   */
   originReadTimeout?: string;
   /**
    * @remarks
-   * Protocol used for the origin request. Possible values:
-   * - http: Use HTTP protocol for origin requests.
-   * - https: Use HTTPS protocol for origin requests.
-   * - follow: Follow the client\\"s protocol for origin requests.
+   * The protocol for Origin requests. Valid values:
+   * 
+   * - `http`: Uses the HTTP protocol.
+   * 
+   * - `https`: Uses the HTTPS protocol.
+   * 
+   * - `follow`: Uses the same protocol as the client request.
    * 
    * @example
    * http
@@ -64,7 +123,7 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originScheme?: string;
   /**
    * @remarks
-   * SNI carried in the origin request.
+   * The Server Name Indication (SNI) to use in Origin requests.
    * 
    * @example
    * origin.example.com
@@ -72,9 +131,11 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originSni?: string;
   /**
    * @remarks
-   * Origin certificate verification switch. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable Origin Certificate Verification. Valid values:
+   * 
+   * - `on`: Enables verification.
+   * 
+   * - `off`: Disables verification.
    * 
    * @example
    * on
@@ -82,21 +143,41 @@ export class CreateOriginRuleRequest extends $dara.Model {
   originVerify?: string;
   /**
    * @remarks
-   * Use range chunking for origin downloads. Possible values:
-   * - on: Enable
-   * - off: Disable
-   * - force: Force
+   * Specifies whether to use range requests to download files from the Origin. Valid values:
+   * 
+   * - `on`: Enables range requests.
+   * 
+   * - `off`: Disables range requests.
+   * 
+   * - `force`: Forces 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, using conditional expressions to match user requests. This parameter is not required when adding global configurations. 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 content of the rule, a Conditional Expression that matches user requests. Not required when creating a Global Configuration. There are two scenarios:
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, set the value to a custom expression. Example: `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -104,9 +185,11 @@ export class CreateOriginRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding global configurations. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the rule. Not required when creating a Global Configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -114,16 +197,23 @@ export class CreateOriginRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding global configurations.
+   * The rule name. Not required when creating a Global Configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The 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 ID of the site. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -133,7 +223,7 @@ export class CreateOriginRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site where the configuration takes effect. The default is version 0.
+   * For sites with version management enabled, this specifies the version to which the configuration applies. The default value is 0.
    * 
    * @example
    * 1

package/src/models/CreateOriginRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOriginRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The ID of the configuration.
    * 
    * @example
    * 352816096987136
@@ -13,7 +13,7 @@ export class CreateOriginRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Request ID.
+   * The ID of the request.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/CreatePageRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePageRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded page content. Example: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=", which indicates "hello page".
+   * The page content, which must be provided in BASE64 encoding. For example, the value PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4= decodes to \\<html>hello page\\</html>.
    * 
    * @example
    * PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
@@ -13,10 +13,11 @@ export class CreatePageRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The Content-Type field in the HTTP header. Valid values:
+   * The `Content-Type` HTTP header. Examples:
    * 
-   * *   text/html
-   * *   application/json
+   * - text/html
+   * 
+   * - application/json
    * 
    * This parameter is required.
    *